Web Based Documentation Generator / Editor

views:

216

answers:

Web Based Documentation Generator / Editor

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 see fit, rather easily. Add examples... add a Description etc.

I thought about using a Wiki as I read a number of other things here regarding people having luck with mediawiki extensions... but this is far too broad and general for what I need.

Any ideas?

+1 A:

Doxygen does PHP and other stuff.

John at CashCommons 2009-09-15 17:44:07

Which outputs the HTML, but then I have to go in and modify it manually. I'm looking for something with more of a management interface on the back end with predefined areas for adding data types, descriptions, examples, etc, all related to programming documentation.

Gent 2009-09-15 17:49:34

You can add examples right in your code. Or there are ways to "abuse" Doxygen for standalone docs. One thing I'd make sure of is that you're not maintaining knowledge in more than one place ... if everything about your documentation is generated from a well-defined set of files and from comments in the source, then you stand a better chance of keeping everything consistent.

John at CashCommons 2009-09-15 17:54:54

John, I'd actually like to get rid of the existing comments in the code with the exception of procedural comments. Although I understand a number of large projects use Doxygen and do exentensive templating and what not, I'd like to see this documentation be more dynamic from a user perspective. That is, if the API changes or new methods get modified, I'd like not to simply rerun it and get static pages, but to rerun it and have old methods / classes "hidden" and perhaps have it delineate version changes to the API, etc, comments made before the change, vs. comments / examples made after, etc.

Gent 2009-09-15 18:31:59

Take a look at this for a PHP specific tool. Doxygen also has some php support

Jared 2009-09-15 17:46:10

I'm aware of this tool, or at least PHPDoc -- but it suffers from the same problem as I mentioned in the comment above where I cannot easily modify it without working with the HTML for firing up a WYSIWYG.

Gent 2009-09-15 17:52:21

I've been looking for something like this myself forever it seems like.. the only solution I've come close to finding, but havent' tried is phpdoc->docBook->mediawiki

David 2010-02-06 00:31:05

ansaurus

tags:

views:

answers:

Web Based Documentation Generator / Editor

related questions