Reference Manual

Usage

Manual Entries

Structure

File Inclusion

Text Formatting

DOC++ follows the approach of maintaining one source code that contains both, the C++ or Java program itself along with the documentation in order to avoid incompatibilities between the programm and its documentation. Unlike other approaches such as WEB, sources documented with DOC++ are ready to be compiled without need of any preprocessing (like tangle). We feel, that this is of great advantage for intensive programming and debugging activities.

This documentation is organized as follows. Section Usage describes how to generate your documentation for readily docified sources, hence explains the comand line options of DOC++. Section Manual Entries discusses, how the manual entries generated for DOC++ comments are built up and section Structure how to structure your documentation hierarchically. Finally section Text Formatting describes all the features provided by DOC++ to format the documentation text (such as bold face typesetting etc.).

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de