Usage

Calling DOC++ with `-h' or `--help' option will give you a long screen with one-line descriptions of the command line options provided by DOC++. However, we'll now attempt to provide a more detailed description suitable for you to understand how to call DOC++ with your docified sources.

At the commandline DOC++ may be called with a sequence of options and a list of files or directories. No option may be passed after the first filename. All files passed to DOC++ are parsed in the order they are specified for generating documentation from them. All directories are traversed recursively and all files *.h* or *.java (depending on the `-J' or `--java' command line option) are parsed. However, it is good practice to control the input files with one main input file and use the `@Include:' directive.

Options consists either of a leading character `-', followed by one or two characters, or a leading `--', followed by the option name, and optionally a space-separated argument.

Command line options come in three different flavours. The first type of options control parameters that are independent of the chosen output, HTML (the default) or TeX (selected with `-t' or `--tex' option). These are:

-A -all
Instructs DOC++ to generate manual entries for every declaration it finds, no matter if it is documented with a DOC++ comment or not.
-c --c-comments
Instructs DOC++ to use the C++-style `//' comments as DOC++ comments.
-h --help
Don't do anything, just print a one-line description of all options to the standard output.
-H --html
Instructs DOC++ to use HTML as formatting language instead of TeX.
-I --input FILE
Instructs DOC++ to read the list of input files from FILE instead of command line.
-J --java
Sets DOC++ into Java mode, i.e. lets DOC++ parse Java instead of C/C++.
-nd --no-define
Instructs DOC++ to ignore the `#define' macros.
-p --private
Instructs DOC++ to include private class members to the documentation. If not specified no private member will show up in the documentation (even if they are docified).
-q --quick
Turn DOC++ into a quick operating mode, which increase the generated documentation size.
-Q --quantel
Parse Quantel extensions.
-t --tex
Instructs DOC++ to produce TeX output rather than HTML.
-u --upwards-arrows
Draw arrows from derived class to the base class when generating class graphs.
-v --verbose
Sets DOC++ into verbose mode making it operate more noisy. This may be helpful when debugging your documentation.
-V --version
Don't do anything, just output version information.

The following command line options are only active when HTML output is selected, i.e. no `-t' or `--tex' option is passed:

-a --tables
When this option is specified, DOC++ will use HTML tables for listing the members of a class. This yields all member names to be aligned.
-b --tables-border
Same as ``--tables'' except that a bordered table will be used.
-B --footer FILE
Use FILE as the footer for every HTML page generated by DOC++. This is how to get rid of DOC++ logos and customize the output for your needs.
-d --dir NAME
This specifies the directory where the HTML files and gifs are to be written. If not specified, the current directory will be used. If the specified directory does not exist, it will be created by DOC++.
-f --filenames
Instructs DOC++ to write on each HTML page the file of the source code, where this manual entry has been declared.
-F --filenames-path
Same as ``--filenames'' except the complete path of the source file is shown.
-g --no-gifs
Instructs DOC++ not to generate gifs for equations and `\TEX{}' text in the documentation. This may reduce execution time when calling DOC++, but note that DOC++ keeps a database of already generated gifs, such that gifs are not recreated if they already exists. However, if you do not have `latex', `dvips', `ghostscript' and the `ppmtools' installed on your system, you must use this option, since then DOC++ will fail setting up the gifs.
-G --gifs
This instructs DOC++ to reconstruct all gifs, even if they already exists. This may be useful if the database is corrupted for some reason.
-i --no-inherited
Instructs DOC++ not to show inherited members in the generated HTML documentation.
-j --no-java-graphs
Suppresses the generation of Java applets for drawing class graphs.
-k --trivial-graphs
Generate class graphs for classes with neither base class nor child classes.
-m --no-members
Don't show the members with zero-length documentation in DOC section.
-M --full-toc
Show members in HTML TOC.
-S --sort
Instructs DOC++ to sort documentation entries alphabetically.
-T --header FILE
Use FILE as the header to every HTML page generated by DOC++. This is how to get rid of DOC++ logos and customize the output for your needs.
-w --before-group
Print the groups' documentation before groups.
-W --before-class
Print the classes' documentation before classes.
-x --suffix SUFFIX
Use SUFFIX as the suffix to every generated HTML page, instead of ``.html''.

Finally, this set of command line options provides some control for the TeX output of DOC++:

-ec --class-graph
Only generates the class graph.
-ef --env FILE
Reads the TeX environment from FILE.
-ei --index
Only generates the index.
-eo --style OPTION
Adds OPTION to TeX's `\documentclass'.
-ep --package PACKAGE
Adds `\usepackage{package}' to the TeX environment.
-et --title FILE
Uses the contents of FILE as TeX title page.
-D --depth DEPTH
Sets the minimum depth (number of levels) in TOC.
-l --no-env
Switches off generation of the TeX environment. This should be used if you intend to include the documentation in some TeX document.
-ng --no-class-graph
Suppress the class graph generation.
-o --output FILE
Sets the output file name. If not specified, the output is printed to standard output.
-s --source
Instead of generating a manual from the manual entries, DOC++ will generate a source code listing. This listing contains all normal C or C++ comments typeset in TeX quality. Every line is preceeded with its line number.

For further customization of the TeX output, please try to understand and edit the style file ``docxx.sty'' (sorry, there is no documentation on how to do this). The HTML output can be customized by means of the following 6 files:

indexHeader.inc
Header for index HTML pages
indexFooter.inc
Footer for index HTML pages
hierHeader.inc
Header for class hierarchy HTML pages
hierFooter.inc
Footer for class hierarchy HTML pages
classHeader.inc
Header for all other HTML pages
classFooter.inc
Footer for all other HTML pages

If one or more of these files are found in the current directory, the corresponding part of a HTML page is substituted by the contents of the file. The `indexHeader.inc' and `hierHeader.inc' files should start with ``<HTML><TITLE> ...''. File `classHeader.inc' should start with ``<BODY> ...'', since for such pages DOC++ sets up the title.

As an example, the TeX version of this document has been generated with

	    doc++ --tex --output doc.tex --package a4wide doc.dxx
	

while the HTML version has been created using

	    doc++ --dir html doc.dxx
	

As you can see, this documentation itself is written using DOC++ in order to gain the benefits of having just one documentation source and two different output possibilities.

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.