Page 1 of 1

Documentation Software

Posted: Tue Oct 31, 2006 11:06 am
by MrPotatoes
do you people know of some decent Documentation software? i don't want to use PHP Documentor (maybe down the line but not as the main source) and i need something easy enough to use.

i already have alot of the stuff on paper but i want to put it into chapters of sorts. something easy and has a TOC.

anyone know of anything decent?

Posted: Tue Oct 31, 2006 11:46 am
by Chris Corbyn
You can always just use a wiki to document your code. Seems common-place these days. I would recommend using PHPDocumentor or any of the similar tools using comments in the code itself though. It makes your code easier for somebody else to read over at a glance too.

Posted: Tue Oct 31, 2006 11:53 am
by MrPotatoes
i was using a wiki but i wanted something uber easy to use. a wiki you got to understand how to use it and i just don't have the time to invest in that.

code documentation is documentation as you code. i've already designed the app. i want to actually put it into a neater nicer looking format than .rtf

Posted: Tue Oct 31, 2006 11:58 am
by Jenk
phpDocumentor or dOxyGen

Posted: Tue Oct 31, 2006 3:57 pm
by Maugrim_The_Reaper
API's should be documented by phpDocumentor using formatted inline comments. It's really the best way of documenting actual code.

General documentation works great on a wiki. It's not that hard to setup and use something like MediaWiki with a custom style and PHP syntax support from Geshi...

Posted: Tue Oct 31, 2006 4:15 pm
by Chris Corbyn
Maugrim_The_Reaper wrote:API's should be documented by phpDocumentor using formatted inline comments. It's really the best way of documenting actual code.

General documentation works great on a wiki. It's not that hard to setup and use something like MediaWiki with a custom style and PHP syntax support from Geshi...
I seem to be using Trac for everything lately. I use it for its Ticket system, I use it for reviewing changes in SVN (aside from svn log) and I use the wiki to document code (with Enscript highlighting). If Trac made a PHP port it would be perfect; I have to run it over CGI with apache.

Posted: Wed Nov 01, 2006 12:37 pm
by alex.barylski
Doxygen is a good choice...as you liekly dislike phpDoucmentor because of it's difficulty in getting everything setup...

Posted: Wed Nov 01, 2006 4:30 pm
by Ollie Saunders
I've spent a long time playing with phpDoc and its good....but not that good. Also its future seems pretty limited as the founding developers haven't ever had any additional help from the community and are now only fixing bugs. My advice, use phpDoc for inline documentation and parsing of phpDoc blocks. Use something else for tutorials.

Posted: Thu Nov 02, 2006 12:35 am
by pedrotuga
you wont find anything easyer then a wiki. Despite being easy is not the most apropriate IMO.
Those auto-documentation solutions are cool, here is another one
http://phpxref.sourceforge.net/

To the end user aplication i recomend latex.