I have this: /** * @file * API for loading and interacting with modules. * More explaination here. * * @author Reveller <me@localhost> * @version 19:05 28-12-2008 */ I'm looking for a regex to strip all but the @token data, so the result would be: @file API for loading and interacting with modules. More explaination here. @au...
Hi. I heared Eclipse doesn't support parameterization of variables like this: /** @var DBProxy */ $proxy; or /** @var Uri */ $uri = Registry::get('uri'); $uri->... But no completions available Is there any other solution? ...
Hi! I wonder how I can make PHPDoc-comments visible in Eclipse on a project-wide basis. For the moment, it only works in the current, open file. It would be super to be able to check out all the @params and descriptions that I have put in before each function, outside the function's own file. Thanks a lot! ...
Given a function which behaves as either a mutator or accessor depending on the arguments passed to it, like this: // in PHP, you can pass any number of arguments to a function... function cache($cacheName) { $arguments = func_get_args(); if (count($arguments) >= 2) { // two arguments passed. MUTATOR. $value = $argum...
All, Is there a way to generate PHPDoc documentation for a PHP project in Netbeans 6.8? Thanks ...
For a few days now I'm using NetBeans 6.8 for doing PHP work. But even if a class-file is included and the methods are public and there's phpDoc used, NetBeans everytime shows "No Suggestions" in the window. E.g. I type $user-> and press CTRL+Space, I do expect all the methods and variables but there aren't shown any. ideas? ...
i have a problem to get suggestions for classes which are included in included files. E.g. content of file 'Header.php' is: //File 'Header.php': include('User.php'); //Class file When I now include the Header.php in my file 'Example.php', i do not get any suggestions: //File 'Example.php': include('Header.php'); User:: After typin...
Hi folks, I'm looking for some method of converting a PHP Docblock (as used for generating documentation by tools like Doxygen) into a structure I can inspect in PHP. For example, I want to parse the following lines: /** * Multiply two values * @CHECKME * * @author someone * @created eons ago * ...
I'd like to include some phpdoc-generated documentation into my already existing docbook documentation. My idea was to let phpdoc generate the documentation in the docbook-format and then import parts (based on packages and subpackages) of it using XInclude. I'm using Docbook 5 for my documentation. Is there any way to achieve this? ...
It might be a bit difficult to explain, so I'll give some example code. Note that I'm using NetBeans IDE (latest). class Dummy { public function say(){ } } /** * Builds dummy class and returns it. * @return Dummy The dummy class. */ function say_something(){ return new Dummy(); } $s=say_something(); While developing in netbea...
I am trying to begin using some sort of standard for documenting my PHP code. Most of my code is in the form of WordPress plugins, some are getting quite complex, and I need to document it. So my question is simple, what system does WordPress use to document their code? ...
Hi, I am using PHPDoc and JSDoc for my source code. I know that there are tools to build an API out of those docs. However, what I am wondering is that how is one supposed to explain complex code? Do I just use multiline comments inside functions rather than explaining in the PHPDoc/JSDoc? For example, consider this code: /** * Lorem...
Suppose I have a comment block like this: /** * comment * comment * comment */ And when I open a new line inside this block I want vim to start it with /** * comment * _ * comment * comment */ but autoindent in standard (ubuntu) vim scripts starts an empty line, like this: /** * comment _ * comment * comment */ Is ...
I have a base class (lets call it A) and I have inheriting Class (lets call it AA). In a different abstract class I have: abstract class DifferentClass{ /** *@var A */ protected MyA; } In a more different class: class MoreDifferent extends DifferentClass{ public function __construct(){ $this->MyA = new AA; } } My prob...
I'm looking to convert PHPDocumentor output to a format I can traverse through in PHP (Ideally, I want an array of all the functions with their comments). Is there any way to do this? ...
I heard you can use phpDoc to help IDE with autocomplete. Can someone show how to use it with Doctrine? For example, I have a JobTable class that extends Doctrine_Table with a bunch of methods and would like to have autocompletion when i type: Doctrine::getTable('Job')-> ... Is it possible? Is there a way to do it without phpDoc? ...
Hi, i developed a project in Codeigniter following the MVC pattern. That means that , for example, i have a controller called Items , which call a model called Items_model ,which get files from database and finally those those file are passed to a view called Item_view. Now i need to document it, and im trying to use phpdoc. My main...
I use NetBeans as my php ide and I have seen @version tags in the docblock that look like this: @version $Id someinfo and timestamp Does NetBeans have a way to automatically update this with each commit? Or am I missing the point entirely of this tag? ...
Hi, I was wondering, if someone had a nice template (like the documentation on php.net) for PHPDoc... I don't like the standard templates and can't find new ones on google... I like php.net documentation, and was wondering if it was available for PHPDoc, or something similar (not the standard HTML:Smarty:PHP theme, I don't like that......
Hi, How do I doc a variable number of parameters? I am writing an application in PHP and JavaScript. Currently I have (in JavaScript): /** * Description * @param {String} description */ function fn() { // arguments holds all strings. } So, how do I doc n-number of string params? ...