Quickstart

If you want to jump straight into using DOC++, add a line like

/// ...

before each function, variable, class, define, etc. you wish to document. For ``...'' you may choose to add a short documentation string for the entry. You will typically want to do so for your header files only. If you intend to write more than one line of documentation, you might prefer using a C-Style comment like

/**
...
*/

and put the long documentation text in place of ``...''. A source file containing such comments is said to be docified. You may call

> docify <original> <docfile>

from your shell to create a docified copy <docfile> form your <original> file. The > indicates the shell prompt and must not to be typed.

Now start DOC++ by typing:

> doc++ -d html <files>

for HTML output or

> doc++ -t -o doc.tex <files>

for LaTeX output in you shell, where <files> is the list of docified files.

Each /// -comment yields one manual entry. If you need to group manual entries, you may do so with the construction

/**@name <name for the group>
* <documentation for the group>
*/
//@{
<other manual entries>
//@}

This will create an entry with the specified name, that contains all <other manual entries> as subentries. Note however, that class members are automatically set as subentries of the class's manual entry. You also may include other files using the comment

//@Include: <file(s)>

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