AutoDOC - A system to generate man pages and html documentation for C++ classes automatically.

Version 2.0


Copyright
~~~~~~~~~

Copyright (C) 1997
The MAM/VRS Project
Joerg Reiberg, Juergen Doellner
Insitut fuer Informatik, Universitaet Muenster, Germany


License
~~~~~~~

AutoDOC may be distributed without any fee for private or educational
purposes. For commercial use a specific prior written permission of
the University of Muenster has to be received.


WEB-Site
~~~~~~~~

AutoDOC Homepage http://www.uni-muenster.de/informatik/u/reiberg/autodoc


FTP-Site
~~~~~~~~

Download AutoDOC from ftp.neosoft.com/pub/tcl/sorted/apps/AutoDOC-2.0


Introduction
~~~~~~~~~~~~

AutoDOC searches for class declarations in C++ 
headfiles. It extracts comments with special tags
for the class documentation which can be written
in HTML format or in UNIX(tm) troff format, which
is used by man-page viewers.

For details see the example in the "demo" direc-
tory and feel free to browse the AutoDOC homepage.


Installation
~~~~~~~~~~~~

Change to the directory you wish to install the
package (like /usr/local) and gunzip and untar it.

AutoDOC needs a [incr Tcl/Tk] V2.2 installation.
The "iwish" command must be provided on command line.

You have to tell AutoDOC where it's home directory
is located, because you might call it via a link.
You can do it in one of the following three ways:

  - Set the environment variable AUTODOC_HOME
  - Call AutoDOC with the -h <home> option
  - Call AutoDOC from the home directory

AutoDOC has been tested on following System:

  - SUN Solaris 2.5.1
  - SGI IRIX 6.3
  - Linux X11R6


Comments
~~~~~~~~

Bug reports, comments and suggestions are welcome
and may be sent via e-mail to following address:

reiberg@uni-muenster.de