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 command line 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 (the way this documentation was written).
Options consists either of a leading character `-', followed by one or two characters, or a leading `--', followed by the long option name, and optionally a space-separated argument.
Note that options that are set in the configuration file overrides command line options.
Command line options come in three different flavours. The first type of options control parameters that are independent of the chosen output, the second type when generating HTML output (the default) and the third for TeX output (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/C++ comments as DOC++ comments.
- -C --config FILE
- Read options from the configuration file FILE.
- -h --help
- Don't do anything, just print a one-line description of all options to the standard output.
- -H --html
- Instructs DOC++ to parse 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. instructs DOC++ to parse Java instead of C/C++ (the default).
- -nd --no-define
- Instructs DOC++ to ignore the `#define' macros.
- -ng --no-class-graph
- Suppress the class graph generation.
- -p --private
- Instructs DOC++ to include private class members in 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.
- -R --internal-doc
- Generate internal documentation too.
- -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.
- -y --scan-includes
- Scan `#include'ed header files
- -Y --idl
- Sets DOC++ into IDL mode, i.e. instructs DOC++ to parse IDL instead of C/C++ (the default).
- -z --php
- Sets DOC++ into PHP mode, i.e. instructs DOC++ to parse PHP instead of C/C++ (the default).
- -Z --docbook
- Instructs DOC++ to produce DocBook SGML instead of HTML.
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.
- -P --no-general
- Discard general stuff.
- -S --sort
- Instructs DOC++ to sort documentation entries alphabetically.
- -T --header FILE
- Use FILE as header for 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 suffix for every generated HTML page, instead of ``.html''.
- -K --stylesheet FILE
- Use FILE as style sheet for every generated HTML page.
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.
- -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.
- -X --hide-index
- Turn off generation of index at beggining of every section.
Alphabetic index Hierarchy of classes