[Darwin2k-devel] Re: Darwin2K reference manual

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

Chris --

I've made a first draft at a small patch for automating doc++ file
generation through the makefiles.  Note that it doesn't use any special
trick of automake -- it just adds an extra make rule or two.  I can add
configuration smarts later.  My documentation looks less nice than
yours, so I am assuming you have a better way of invoking doc++ than I
do (I just downloaded it and tried it for the first time myself).  I'm
including a diff, and will commit the changes if you give the OK.  I
have no problem re-doing it if you'd prefer things done differently.

How it works:
* Only *.h files are checked for doc++ information so far -- I don't
  know if documentation might be found in *.cxx files too, but this is
  easily changed.
* Put a comment starting with '/*MAKEDOC++'  in a *.h file to have it
  included in the set of files which are processed by doc++.
* Running 'make doc++' in the top-level directory will 

    *  scan all *.h files for the trigger comment and make a list of
      these files in "$(top_builddir)/doc++.files"
    * run doc++ on the files in $(top_builddir)/doc++.files" placing the
      generated html files in directory "$(top_builddir)/html" (I assume
      the doc++ command is what needs to be made more like what you use
      yourself)

* I haven't yet added the hooks which will install the generated
  documentation in a global documentation directory such as
  ${prefix}/share/doc/darwin2k/html/, and pre-build the documentation to
  automatically include it in the distribution, but this is easy when
  everything else is to your liking.

I think our work on the NASDA project will really get serious now that
our visiting scientist has arrived from Japan, and the turborover
project is getting to the point where serious simulation is needed, so I
expect to be teaching the lab all about D2K very soon and providing the
world with a few D2K users.  Your schedule for getting the new dynamics
engine in working order is amost perfect for us.  World domination by
killer robots will inevitably follow, I'm sure.

 -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