How can you solve the following error messages given by PHPdoc? I run madedoc.sh by the following command Command sudo ./makedoc.sh I get Error messages PHP Version 5.2.6-3ubuntu4.2 phpDocumentor version 1.4.2 Parsing configuration file phpDocumentor.ini... (found in /usr/share/php/data/PhpDocumentor/)... done Maximum memory ...
Which is the correct doxygen format for PHP comments? #1 /** Create HTML for tags * @param string @tags */ #2 /** * Create HTML for tags * @param string @tags */ #3 /**! Create HTML for tags * @param string @tags */ ...
Hi, is there a possibility to include images into a docbook manual compiled by phpDocumentor? I tried both: <mediaobject> <imageobject> <imagedata fileref="payment_flowchart.png" format="png"/> </imageobject> </mediaobject> and: <figure><title>foo</title> <graphic fileref="payment_flowchart.png"/> </figure> Then again the i...
Example: /** * This function will determine whether or not one string starts with another string. * @param string $haystack <p>The string that needs to be checked.</p> * @param string $needle <p>The string that is being checked for.</p> * @param boolean $case[optional] <p>Set to false to ignore case(capital or normal characters)</p>...
Hello all. I'm looking for a good documentation generator that supports various programming languages, but PHP is a must. The thing is, I'm looking for it to do a very specific thing, which is essentially build the standard automatic documentation such as function definitions, class structures, etc, but then allow me to edit them as I ...
What is the current status of using namespaces in phpdocs datatypes. eg: * @param string|Vendor\SomeClass $parameter ...
The one thing I really miss in vim is a tiered intellisense support, just like we have one in PHP Eclipse. For example: /** * Get the config object * * @return Config */ public function getConfig() { return $this->_config; } I find this explicit return type setting very useful and time saving feature. Do we have something si...
I have objects with many variables that I declare and explain in the comments. I am commenting very thoroughly for later processing using phpDoc, however I have no experience with actually compiling the documentation yet. I find it very annoying that with phpDoc notation, each variable eats up four to six lines of code even if the only ...
In frameworks like Zend Framework (or extensions of it), it is sometimes possible to pass information like type hints to the framework code by using PHPDoc style comments. I cannot imagine that the framework parses the files using PHP, but I do not see any other way to achieve this, except for some built-in language feature of PHP, whic...
In general, the PHPDOC properties are self-explanatory, but I'm having hard time understanding these: @category - what is this exactly? @package - could some one provide me examples about the usage of this property? ...
I've been playing with phpDocumentor recently and found it quite suitable for my needs. I'm largely working with PHP/HTML/JS/CSS codebases and would like phpDocumentor to parse my Javascript (and perhaps CSS) in order to keep it all together. I've managed to get phpdoc to parse javascript files contained throughout the codebase - howeve...
Just curious if there's a way in netbeans to give type hints for regular variables, so that intellisense picks it up. I know you can do it for class properties, function parameters, return types, etc. but I can't figure out how to do it for regular variables. It's something that would really help in situations where you have a method tha...
Hello Stackers... I want to start using phpDocumentor but I'm finding it hard going - the web interface is not playing nicely and I can't get it to parse the example files I probably haven't set it up right and I would like a nice step-by-step tutorial (i.e. NOT THIS ONE) to check where I've gone wrong and hopefully get it parsing som...
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate t...
I'm having some issues getting phpdoc to run correctly. The docs are being generated for the most part successfully, but I get the following warning many times: Warning: date(): It is not safe to rely on the system's timezone settings. You are required to use the date.timezone setting or the date_default_timezone_set() funct...
I need a documentation system for a PHP project and I wanted it to be able to integrate external documentation (use cases, project scope etc.) with the documentation generated from code comments. It seems that phpDocumentor has exactly the right feature set, but external documentation must be written in DocBook which is too complex for o...
I've got this constructor that takes an optional argument. The main problem with this is usability. The developer using my framework will catch a headache instantly because he doesn't know if he can provide an argument, what kind of argument, or if he can't at all. Conclusion: It just sucks. But PHPDoc may help a little bit if someone ha...
I wasn't able to find an overview of the types which can be hinted with PHPDoc. I know array or string, but is there also bool? Like: /** * @param bool loadLazy * @return array Array with objects */ public function getObjects($loadLazy=false) { ...
Is there a syntax for documenting functions which take a single configuration array, rather than individual parameters? I'm thinking specifically of CodeIgniter-style libraries, which use a mechanism similar to this: <?php // // Library definition // class MyLibrary { var $foo; var $bar; var $baz; // ... and many more vars......
In Aptana, I have somehow broken the functionality to auto-generate phpdoc comments for functions within classes. It appears to only affect my current project. Normally I can type /** on the line before a function and press enter, and Aptana will create a phpdoc comment with the correct @param values, etc. For some reason when I do this...