Re: PHP documentation solutions? (PHPDoc, Doxygen, ???)

On Mon, 2006-02-20 at 13:51, tg-php@gryffyndevelopment.com wrote: > Ok, so we're starting to get a little more serious about this product we're working > on and may in the near future try to standardize and flesh out our coding and product documentation > (always a nice thing). I'm semi-familiar with PHPDoc (http://www.phpdoc.org) but my boss just > pointed me toward Doxygen (http://www.stack.nl/~dimitri/doxygen/) as a possible solution. Just > wondering if anyone has had any practical experience with either/both or have an alternative that > they enjoy using? > > I like the idea of being able to specify internal (developers) documentation as well as end > user product documentation but maybe there's other features people have found useful as well > that we havn't thought of yet. In the spirit of re-inventing the wheel... I rolled my own JinnDoc. I now use it to maintain my PHP and JavaScript source code documentation. Example output can be found from here: http://www.interjinn.com/jinnDoc/index.phtml Example markup can be found here (view the source): http://www.interjinn.com/javaScript/interJinn/Core/httpRequest.js Cheers, Rob. -- .------------------------------------------------------------. | InterJinn Application Framework - http://www.interjinn.com | :------------------------------------------------------------: | An application and templating framework for PHP. Boasting | | a powerful, scalable system for accessing system services | | such as forms, properties, sessions, and caches. InterJinn | | also provides an extremely flexible architecture for | | creating re-usable components quickly and easily. | `------------------------------------------------------------'