The AutoDOC Homepage

A system for generating man pages and html pages from C++ classes.

Copyright ©1997 - The MAM/VRS Project
Authors: Jörg Reiberg , Jürgen Döllner
Insitut für Informatik , Universität Münster , Germany

Introduction

searches for class declarations in C++ headerfiles. It extracts comments with special tags for the class documentation which can be written in HTML format or in UNIX® troff format, which is used by manual page viewers. For details on how to use special comment tags in your include files and how to use AutoDOC

see the example in the demo directory or read the manual page.

Installation

Change to the directory you wish to install the AutoDOC

package.
(Like /usr/local on Un*x systems)

You have to tell AutoDOC where its home directory is located. You can do it in one of the following three ways:

Set the environment variable AUTODOC_HOME properly.
(Try something like: export AUTODOC_HOME=/usr/local/AutoDOC-2.0)

Call with the -h <home> option.
(Try something like: /usr/local/AutoDOC-2.0/bin/autodoc -h /usr/local/AutoDOC-2.0)

Call from the home directory.
(Try something like: cd /usr/local/AutoDOC-2.0; autodoc &)

up to version 2.0.2 needs a itcl2.2 installation, versions 2.0.3 or higher need a Tcl8.0 installation.
The iwish command (or the tclsh8.0 command for version 2.0.3 or higher) must be executable in your shell.

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

reiberg@uni-muenster.de

Download AutoDOC 2.0.4 Now !
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.

BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.