[Darwin2k-devel] Re: Documentation w/ doc++

[Christopher L. <ch...@MI...>]

On 29 Jan 2001 10:35:24 -0800, Chris Leger wrote:
> 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/

This looks like it will be very useful!  I find this kind of
automatically-generated online documentation very helpful when I code
using Gtk and Glib libraries, and I wish some other projects did their
development documentation similarly (e.g., OpenGL libraries).

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

I'll 'apt-get install ' it myself :).

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

Sure -- I'll look into it.  It should be simple.

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

It looked like this might happen based on your recent cvs commit
messages.  I'm trying to get to my stuff, but am currently writing
proposals in work-time and house-chores in nonwork-time.  I'll get some
coding done before too long because proposal-writing by itself will make
me insane.

-Chris

-- 

Christopher Lee <ch...@mi...>
(617) 253-5095 <http://web.mit.edu/chlee/www>
Postdoctoral Associate of Mechanical Engineering
Field and Space Robotics Laboratory
Massachusetts Institute of Technology
77 Massachusetts Ave, Room 3-472m
Cambridge, MA 02139