Anything better than PHPDoc out there?
Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output? ...
phpdoc
Can i run a script when i commit to subversion?
I'd like to run a script that builds the documentation for my php project. It is basically just using wget to run phpdoc. ...
multiple subpackages for phpdoc
Is it possible to have a file belong to multiple subpackages? For example: /** * Name * * Desc * * @package Core * @subpackage Sub1 * @subpackage Sub2 */ Thanks! ...
How to escape phpdoc comment in phpdoc comment?
I would like to know how to escape phpdoc comments within a phpdoc comment. For example, how would I have to write this: /** * Some documentation... * * <code> * /** * * Example example phpdoc. * */ * </code> */ Obviously above example won't work. I tried replacing the asterisk's with *, but it will just nicely print ...
DocBook to DokuWiki
Is there a straightforward way to take docbook content and convert it into DokuWiki content? So far I've only found the DokuWiki plugin that will interpret docbook content and output it in XHTML, but this happens on every page load. I would like to find a way to convert docbook content directly to DokuWiki's native formatting syntax so ...
PHPDoc type hinting for array of objects?
So, in PHPDoc one can specify @var above the member variable declaration to hint at its type. Then an IDE, for ex. PHPEd, will know what type of object it's working with and will be able to provide a code insight for that variable. <?php class Test { /** @var SomeObj */ private $someObjInstance; } ?> This works great unt...
Is PHPDoc verbosity more trouble than it's worth?
I tried using PHPDoc for the first time today and quickly ran into a problem. For every 1 line of variable declarations, I had at least 5 lines of comments. Example: /** * Holds path the remote server * @name ... * @global ... */ $myvar = ... Of course, the payoffs are nice - but this turns a 10-line config file into a 60-line ...
From a PHP Code Diff, can you tell which Classes and Functions have changed?
Background: PHPDoc ( http://www.phpdoc.org/ ) is a brilliant tool for extracting html documentation of your classes or methods from comments in your files. Adding PHPDoc comments also has other advantages - if you use an IDE like Zend or Netbeans, it will use the PHPDocs to show you autocompletion tips. Most Issue trackers have a featu...
Automated way of finding where in the codebase a function is used in PHP
I'm trying to find automated way of finding where in the code a function is used. Some form of autogenerated documentation where I have Class->method is used in this files: a.php , b.php etc. I am tryng to find something out there to prevent rolling my own. We currently have no automated documentation system so anything goes. ...
Documenting a PHP extension with PHPdoc
I've written a PHP extension in C, and I want to create PHPdoc documentation so that my users will get inline docs in their PHP IDE (in this case, Netbeans) when calling my extension. Ideally I'd like to do this by embedding the PHPdocs in the C code, to keep implementation and documentation together. Assuming it's possible to embed PH...
How can I indicate that a parameter in a php function has a type of determined class using the phpDoc?
In this example: /** * * @param <type> $foo * @return <type> */ function do_something($foo) { return $foo->really_do_something(); } How to indicate that $foo must be of the class Foo? ...
PHPDoc documentation generator in or out of Eclipse?
I am developing with Eclipse + PDT. I've been adding phpdoc comments into my code, but actually never generated a resulting documentation in Eclipse. How should I do it - is there some functionality in Eclipse, or doc generation should be done externally? ...
When running phpdoc on a CodeIgniter project, which folders should be included?
On my first try, I've only included system/application/models, system/application/controllers, system/application/helpers, and system/application/libraries. I chose those folders because I think those folders contain the code that you want to be properly documented for future reference. What other folders do you think should be included...
Netbeans-esque retrospective auto-comment/phpDocumentor tool (for Eclipse or standalone)
Is there anything similar to netbean's Javadoc auto comment tool for PHP/phpDocumentor/Eclipse? In the netbeans implementation: A dialog pops up and allows you to run through all the members of your class and enter comments, which are added to the source file. It even verifies that there are no parameters you have not accou...
how to create phpdoc Tutorial / Extended pages to supplement commented code
I'm trying everything I can to get phpdocumentor to allow me to use the DocBook tutorial format to supplement the documentation it creates: I am using Eclipse I've installed phpDocumentor via PEAR on an OSX machine I can run and auto generate code from my php classes It won't format Tutorials - I can't find a solution I've tried movi...
Request params and phpdoc
Trying to figure out the best way to document request parameters via phpdoc in a manner that makes sense. Specifically, I've got some Zend Framework controller actions that receive parameters via GET/POST, but aren't functional params. Does this make sense? /** * Display a pagination/grid list of rows. * * @param string $_GET['order'...
How do I maintain high-level documentation along with phpdoc generated documentation?
For my first open source project (shameless plug: mtChart) I currently have two different types of documentations: HTML files generated by Doxygen from the phpdoc-comments within the code The wiki pages on Google Code (Or simply put: Additional text files) The Doxygen files are really great, but I miss the possiblity to add 'high-lev...
PHP Function Comments
Just a quick question: I've seen that some PHP functions are commented at the top, using a format that is unknown to me: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ My IDE gives me a dropdown selection for the things such as @param and @return, so it must b...
How to use phpDoc with overloaded methods?
Let's say I have a PHP class called Color, it's constructor accepts various params. // hex color $myColor = new Color('#FF008C'); // rgb channels $myColor = new Color(253,15,82); // array of rgb channels $myColor = new Color(array(253,15,82)); // X11 color name $myColor = new Color('lightGreen'); My question is: How should I use p...
Running SH script with sudo for PHPdoc
How can you run the following script in generating docs by PHPdoc? #1 sudo -code sudo source makedoc.sh I get no command source #2 without sudo The problem is that sudo does not have the command source. I tried to fix the problem unsuccessfully by changing the persmissions of ~/phpdoc/phpdoc to 777 and then running source makedo...