DOC++ 3.4.

9 Referen e Card Inline DOC++ Tags

The following tags are useful when writing do umentation for
Supported TeX ma ros
For best results with both printed (TeX) and online (HTML)
by Steven R. Gould
a fun tion, method, variable, and so on. do umentation, it is re ommended that TeX ma ros are used
Comment Styles Tag Des ription Tag Des ription
Every DOC++ omment denes a manual entry. A manual #text# Corresponds to TeX \nverb!f oo!" $...$ math mode for inline equations
entry onsists of do umentation from the DOC++ omment - outputs \f oo" verbatim. \[...\℄ display math mode
and information from the subsequent de laration. filename le For e manual entry to go to \# Output hara ter \#"
Trailing omments an be used to dene manual entries. the named le \ Output hara ter \ "
Enable these by turning on Quantel extensions (-Q). {link entry name } Cross-referen e to manual entry. \ Output hara ter \ " (a spa e)
name spe ies link name (optional). \hline Horizontal line
/** ... */ C style \Date Insert urrent date and time
/// ... C++ style \IMG{le } Insert image into do umentation The following ma ros are all of the form:
\IMG[param ℄{le } Insert image, using HTML parameters {\name text }
//{ \IMG[param ℄[param ℄{le } Insert image, using HTML and TeX The ma ro applies to all text en losed within the urly
... Denes do umentation s ope/grouping params, resp. For TeX output, bra kets, {}, and following the ma ro name .
//} in lude the 'graphi x' TeX pa kage Ma ro Des ription
\Label{label } Make a label \em Emphasize en losed hara ters
//In lude:le In ludes named le. Wild ards allowed. \Ref{entry } Cross-referen e to manual entry \bf Bold fa e for en losed hara ters
\URL{URL} Make link to web page, URL \it Itali ize en losed hara ters
DOC++ De laration Tags
These tags are used immediately before a subsequent
\URL[name ℄{URL} Make link to web page, with text as
the link text
\tt
\tiny
Use xed font for en losed hara ters
Use small font for en losed hara ters
de laration. Note that in the following se tion, the \TEX{text } In lude the TeX \text " in do ument \s riptsize Use s ript size for en losed hara ters
term fun tion refers to a method of a lass, or a - for HTML output, generates GIFs \footnotesize Use footnote size for en losed hara ters
standalone fun tion. \in ludegraphi s Same as \IMG \small Use small font for en losed hara ters
\today Same as \Date \large Use large font for en losed hara ters
\Large Use Large font for en losed hara ters
Tag
author
depre ated
Des ription
Author of fun tion
Fun tion has been depre ated
Supported HTML ma ros
For best results with both printed (TeX) and online (HTML)
\LARGE
\huge
Use LARGE font for en losed hara ters
Use huge font for en losed hara ters
do Long do umentation \Huge Use Huge font for en losed hara ters
do umentation, it is re ommended that TeX ma ros are used \HUGE Use HUGE font for en losed hara ters
ex eption Do uments ex eptions thrown - see next se tion - and not the HTML ma ros given below.
field Do uments elds
Do uments invariants The following TeX ma ros are all of the form:
invariant Tag Des ription \begin{name } ... \end{name }
memo Short do umentation (typi ally, one line) <BR> New line; i.e. line break
name Fun tion name (overrides DOC++) For brevity only the name of the tag is given below.
<P> New paragraph
param Do uments the named parameter <EM>text </EM> Emphasize text - usually means itali
post ondition Do uments post onditions Ma ro Des ription
<I>text </I> Itali ize text enter Center paragraph
pre ondition Do uments pre onditions <B>text </B> Make text bold
return Do uments fun tions return value flushleft Left align paragraph
<STRONG>text </STRONG> Make text \strong" - usually bold flushright Right align paragraph
see Cross referen e. <TT>text </TT> Display verbatim - don't format
sin e Version when fun tion was introdu ed verbatim Output en losed text as is
<PRE>text </PRE> Display verbatim - don't format tabular Denes a table
version Current version <CODE>text </CODE> Display verbatim - don't format array Denes an array
<OL>...</OL> Ordered/numbered list itemize Denes a bulleted list of items
<DL>...</DL> Des ription enumerate Denes a numerated list of items
<DT>...</DT> des ription Des ription (???)
<DD>...</DD> equation Denes an equation
<UL>...</UL> Unordered/bulleted list eqnarray Equation array (???)
<LL>...</LL> Enumerations
<LI> List item, used within <OL> or <UL>

2002 Steven R. Gould. Permissions on ba k. v1.01

 DOC++ 3.4.9 Referen e Card
Command Line Options Customizing HTML Output Customizing TeX Output
Input Formats HTML-spe i Command Line Options TeX-spe i Command Line Options
These options are only a tive when HTML output is sele ted, These options provide ontrol over the TeX output of DOC++.
If none of the following input options are used, DOC++ i.e. when no -t or --tex option is used. Short Long Des ription
defaults to C++/C mode. -e -- lass-graph Only generates the lass graph
Short Long Sour e le format Short Long Des ription -ef le --env le Read TeX environment from le
C++/C mode (default) -a --tables Use HTML tables -ei --index Only generate the index
-J --java Java les -b --tables-border Use HTML tables, with borders -eo option --style option Adds option to TeX's \do ument lass
-Y --idl IDL les -B le --footer le Use le as HTML footer -ep name --pa kage name Adds \usepa kage{name } to TeX env.
-z --php PHP les -d name --dir name Spe ies output dire tory for HTML -et le --title le Use le as TeX title page
Output Formats -f --filenames Output sour e le name on ea h page -D x --depth x Sets min. depth in Table of Contents
-F --filenames-path As above, but output full path -l --no-env Disable generation of TeX environment
If none of the following output options are used, DOC++ -g --no-gifs Don't generate GIFs for equations/TeX -o le --output le Sets the output lename
defaults to output in HTML format. -G --gifs For e re-generation of GIFs -s --sour e Generate formatted sour e ode listing
Short Long Output le format -i --no-inherited Don't show inherited members -X --hide-index Disable index at start of ea h se tion
HTML (default) -j --no-java-graphs Don't use Java applets for lass graphs
-t --tex TeX (PS/PDF) -k --trivial-graphs Generate even trivial lass graphs Customizing the TeX Do ument
-Z --do book Do Book (SGML) -K le --stylesheet le Use le as stylesheet for generated pages In addition to the above ommand line options, the TeX
-m --no-members Hide members with no do umentation output an be ustomized by editing the style le do xx.sty
General Options -M --full-to Show members in Table of Contents (Sorry, but there is no do umentation on how to do this.)
Short Long Des ription -P --no-general Dis ard general stu
-A --all Generate entry for all elements Sort entries alphabeti ally
C/C++ omments as DOC++ omments -S --sort
- -- - omments
-C le -- onfig le
-h --help
Read options
Display available options
-T le
-w
--header le
--before-group
Use le as the HTML header
Print groups' do . before groups Example Command Lines
Use HTML as formatting language -W --before- lass Print lasses' do . before lasses
-H --html
-I le --input le Read list of input les from le -x x --suffix x Use x as le extension, instead of .html To generate HTML do umentation, I often use something like:
-J --java Parse Java sour e les Customizing HTML Pages do ++ -p -u -d do s/html -B do s/banner.html \
-nd --no-define Ignore #define ma ros In addition to the above ommand line options, the HTML do s/name .dxx
-ng --no- lass-graph Don't generate lass graphs
In lude private members in output output an be ustomized by dening any ombination of the
-p --private
following les. They will be inserted in the appropriate pla es This in ludes private members, uses up-arrows in lass graphs,
-q --qui k Run fast, even if larger le output on the relevant pages. stores the resulting HTML les in the do s/html subdire tory,
-Q --quantel Parse Quantel extensions uses the do s/banner.html le as a footer on ea h page, and
-R --internal-do Generate internal do umentation File name Des ription reads do s/name .dxx as the main DOC++ input le.
-t --tex Produ e TeX output indexHeader.in Header for index pages
-u --upwards-arrow Draw upwards arrows in lass graphs Similarly, to generate TeX do umentation (whi h is then
indexFooter.in Footer for index pages
-v --verbose Put DOC++ in verbose mode hierHeader.in Header for lass hierar hy pages pro essed to reate a PDF or PS le), I use:
-V --version Output DOC++ version info. hierFooter.in Footer for lass hierar hy pages
-y --s an-in ludes S an #in lude'ed header les do ++ -p -u -t -o do s/latex/name .tex do s/name .dxx
lassHeader.in Header for all other pages
-Y --idl Parse IDL sour e les lassFooter.in Footer for all other pages
-z --php Parse PHP sour e les
-Z --do book Output Do Book SGML The indexHeader.in and hierHeader.in les should start
with <HTML><TITLE>...<BODY>, whereas lassHeader.in should
start with <BODY> (sin e DOC++ sets up the title).
Referen e
DOC++ proje t http://sour eforge.net/proje ts/do pp/
Within these les, ertain spe ial tags are supported, as listed DOC++ home page http://do pp.sour eforge.net/
below. DOC++ will substitute these when generating the Author's web site http://www.stevengould.org/
HTML pages.
Tag Des ription
%file Entry's le name
%fullname
%name
Entry's full name (in ludes the inheritan e)
Entry's name
August 2002 v1.01. Copyright
2002 Steven R. Gould

%type Entry's return type Permission is granted to make and distribute opies of this ard pro-
vided the opyright noti e and this permission noti e are preserved on
all opies.

h i
Send omments and orre tions to Steven R. Gould, Dallas, TX 75252,
USA. steven.gouldstevengould.org