Documentation Software

Ye' old general discussion board. Basically, for everything that isn't covered elsewhere. Come here to shoot the breeze, shoot your mouth off, or whatever suits your fancy.
This forum is not for asking programming related questions.

Moderator: General Moderators

Post Reply
User avatar
MrPotatoes
Forum Regular
Posts: 617
Joined: Wed May 24, 2006 6:42 am

Documentation Software

Post 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?
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Post 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.
User avatar
MrPotatoes
Forum Regular
Posts: 617
Joined: Wed May 24, 2006 6:42 am

Post 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
User avatar
Jenk
DevNet Master
Posts: 3587
Joined: Mon Sep 19, 2005 6:24 am
Location: London

Post by Jenk »

phpDocumentor or dOxyGen
User avatar
Maugrim_The_Reaper
DevNet Master
Posts: 2704
Joined: Tue Nov 02, 2004 5:43 am
Location: Ireland

Post 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...
User avatar
Chris Corbyn
Breakbeat Nuttzer
Posts: 13098
Joined: Wed Mar 24, 2004 7:57 am
Location: Melbourne, Australia

Post 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.
alex.barylski
DevNet Evangelist
Posts: 6267
Joined: Tue Dec 21, 2004 5:00 pm
Location: Winnipeg

Post by alex.barylski »

Doxygen is a good choice...as you liekly dislike phpDoucmentor because of it's difficulty in getting everything setup...
User avatar
Ollie Saunders
DevNet Master
Posts: 3179
Joined: Tue May 24, 2005 6:01 pm
Location: UK

Post 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.
User avatar
pedrotuga
Forum Contributor
Posts: 249
Joined: Tue Dec 13, 2005 11:08 pm

Post 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.
Post Reply