[Darwin2k-devel] Documentation w/ doc++

[Chris L. <cl...@te...>]

I was pleasantly surprised to find out about doc++, a tool for
automatically generating documentation from C, C++ & Java source code. 
It's very easy to use: you just format your comments a certain way, and
then run doc++ to produce html or LaTex documentation.  Here is a sample
directory with some of the generated documentation:

http://darwin2k.sourceforge.net/documentation/html/

I haven't finished converting the comments in that file, and there are a
few bugs, but it gives you an idea of what doc++ can easily do.  I'll be
gradually doc++-ifying the code, which should make things less painful
for everyone.

The URL for doc++ is 

http://www.zib.de/Visual/software/doc++/index.html

I installed it from an RPM off of rpmfind.net.

Chris, can you modify the automake scripts to include rules for
generating documentation?  Don't worry about modifying all the
Makefile.am's; I can do that, but I don't have a clue how to go about
specifying rules for automake.  

Also FYI, I'm working on getting the dyno code back into Darwin2K; I
probably won't commit anything until I can at least get the entire
system to compile.  

Chris

-- 
[ Chris Leger               cl...@ro... ]
[ Phone: (818) 393-4462     Fax: (818) 393-3254          ]