Generating documentation

[John Shalf]

Hi,
It seems the program vtkHTML in the wrap subdirectory of VTK is designed
to do this (Kitware folks can correct me on this if I'm wrong). 

Also, if you use C++, you might take a look at the Konrad Zuse
Institut's Doc++ tool which can parse methods & class hierarchy directly
from the C++ even in absence of fullfledged documentation/keywords in
the comments.
	http://www.zib.de/Visual/software/doc++/index.html

And for C/Fortran code, there is Paul Walker's GRDoc at
	http://jean-luc.ncsa.uiuc.edu/Codes/grdoc/
Which does really pretty formatting of the documented code and includes
an emacs minor mode to help automate the documentation process. 
Examples of documented code are at
	http://bach.ncsa.uiuc.edu/IO/sdsdoc/

-john
	

Jan Stifter wrote:
> 
> as long as i know, the tool to extract the docu is not available. take a
> look at doxygen for a nice tool to generate a html and latex docu of your
> c++ code:
> http://www.stack.nl/~dimitri/doxygen/
> 
> ------------------------------------------------------------
> Jan Stifter
> ICQ: 5321722             Email: j.stifter@[no-spam]medres.ch
> Freechess.org: nunc      Registered Linux User No. 130314
> ------------------------------------------------------------
> -----Original Message-----
> From: Patrick de Koning <patrick at lkeb.azl.nl>
> To: vtkusers at gsao.med.ge.com <vtkusers at gsao.med.ge.com>
> Date: Wednesday, September 01, 1999 10:06 AM
> Subject: Generating documentation
> 
> >
> >I was wondering what program is used to generate the HTML documentation
> >from the header files. I am impressed by this ability and want to use it
> >for my own programs.
> >
> 
> -----------------------------------------------------------------------------
> This is the private VTK discussion list.  Please keep messages on-topic.
> Check the FAQ at: <http://www.automatrix.com/cgi-bin/vtkfaq>
> To UNSUBSCRIBE, send message body containing "unsubscribe vtkusers" to
> <majordomo at gsao.med.ge.com>.  For help, send message body containing
> "info vtkusers" to the same address.     Live long and prosper.
> -----------------------------------------------------------------------------


-----------------------------------------------------------------------------
This is the private VTK discussion list.  Please keep messages on-topic.
Check the FAQ at: <http://www.automatrix.com/cgi-bin/vtkfaq>
To UNSUBSCRIBE, send message body containing "unsubscribe vtkusers" to
<majordomo at gsao.med.ge.com>.  For help, send message body containing
"info vtkusers" to the same address.     Live long and prosper.
-----------------------------------------------------------------------------