[thelist] Document generator recommendations?

Eduardo Kienetz eduardok at gmail.com
Sat Dec 9 12:19:22 CST 2006

On 12/9/06, Brooking, John <John.Brooking at sappi.com> wrote:
> Thanks to whoever pointed out a couple of documentation generators on the recent code standards thread. A little research quickly led to this comparison of document generators:
> http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
> So, how to choose (between those that fit your basic needs)? Is anyone who uses any of them game to contribute their observations about them? What do you most like about the one you use? If you've used more than one, how do they compare in a real-world situation?
> The ones listed are DB Manual, BI Documenter, classdoc, CppDoc, Ddoc, Doc-O-Matic, Doxygen, Epydoc, HeaderDoc, Help Generator, Javadoc, KDOC, Natural, NDoc, PHPDocumentor, ROBODoc, TwinText, VBdocman, and VBDOX.
> - John
> --
> This message may contain information which is private, privileged or confidential and is intended solely for the use of the individual or entity named in the message. If you are not the intended recipient of this message, please notify the sender thereof and destroy / delete the message. Neither the sender nor Sappi Limited (including its subsidiaries and associated companies) shall incur any liability resulting directly or indirectly from accessing any of the attached files which may contain a virus or the like.

What I usually do is:

1) Check license (you will hardly need to use a proprietary software);
2) Check version (this might indicate how stable it is. e.g.: version
4.5.8 is better than version 0.4.7);
3) Check the date of their latest release (it might indicate whether
it is still being maintained or not);
4) Search google to check which one is more popular (or at
sourceforge.net, for example, you might check number of downloads and
that info in previous points).

Nowadays I use Javadoc, but plan to start using Doxygen.

Eduardo  Bacchi Kienetz
LPI Certified - Level 2

More information about the thelist mailing list