Doxygen Quick Reference
ADVERTISEMENT
1
2Doxygen Quick Reference
other parts of the documentation as the first argument to a
Member group documentation will not appear under under a
\ref <lbl> ‘‘<lnk>’’ command. This creates a link to the la-
separate header-tab in the generated documentation. Module
beled group using the lnk text enclosed in quotes, the second
groups are defined with the \name <label> command in a com-
Doxygen commands
argument is optional. The group members are enclosed by the
ment block which is taken as the group header, which gives the
Doxygen ( ) reads a configuration file
group open @{ and close @} commands, as follows:
group a label for later reference.
to control source code processing and documentation output
Page Groups
formats, the default filename is Doxyfile.
/** \defgroup <label> ‘‘<title>’’ */
Page group documentation will appear under the Related
/* @{ */
doxygen
Run with default config file.
Pages heading in the generated documentation. Page groups
// group members here ...
Run with <config-file>.
doxygen <config-file>
are defined with the \page <label> (title), which gives the
/* @} */
Generate <config-file>.
doxygen -g <config-file>
group a label for later reference.
and a title to display
Documenting the sources
in the documenation.
Pages can be further divided into
where groups initiated by \name or \page commands have sim-
sub-pages—with \sub-page <n> ‘‘<t>’’, sections and sub-
Doxygen-visible multi-line comment blocks begin with /**, or
ilar forms, see table below. The open and close group com-
sections, and sub-subsections with a command similar to:
/*!, and end with */. Alternately, the of C++ single line com-
mands must be placed in a comment block, this can be a stan-
\section <section-name> (section title) . The name of the
ment delimiters /// or //! may be used on each line. Within
dard C-style comment or single line C++ comment. Elements
command simply changes to subsection or subsubsection as
a comment block HTML tags or Doxygen specific markup tags,
may be members of multiple groups, which may lead to con-
required. These commands give a label <section-name> and
Special Commands, can be used. Documentation comment
flicts when generating documentation.
Doxygen implements
title (section title) to the section.
blocks can occur anywhere in the source code but placing such
a priority scheme for group membership. The priorities are
blocks before defined code elements, classes, functions, etc., is
assigned based on the command used to initiate group mem-
A special case of a page group is the main page group. The
recommended. Source code files should include the \file com-
bership. The priority order (highest to lowest) is \ingroup,
Doxygen command \mainpage within a comment block places
mand to make comments in the file visible to Doxygen.
\defgroup, \addtogroup, and \weakgroup
the documentation within that block on the Index page of the
generated documentation. You can refer to the main page using
Doxygen special commands, with a few exceptions, begin with
defines a module group with a la-
\defgroup <l> ‘‘<t>’’
\ref index (if the treeview is disabled, otherwise you should use
the prefix @ or , used in this document. Following the Doxygen
bel l and title t.
manual convention, the command arguments are enclosed here
\ref main).
\name <l>
defines a member group with a la-
in braces that signify the extent of the argument, these braces
bel l.
Formulas
are not part of the command, nor should they be included in
defines a page group with a label l
\page <l> (t)
the command:
and title t.
Doxygen can include L
A
T E X formulas in the HTML and L
A
T E X
defines a section on a page with a
\section <l> (t)
output formats. Formulas can be included within the text of
angle braces: argument is a single word.
< angle >
label l and title t.
2
2
a single line, for example—r =
(x
x
)
(y
y
)
or as a
round braces: argument extends to end of line.
( round )
0
0
defines a sub-section on a page
\subsection <l> (t)
centered formula such as (from the Doxygen manual):
curly braces: argument extends to next para-
{ curly }
with a label l and title t.
graph.
defines a documentation block to
\mainpage (t)
T
a
θ
dθ
Lists
place on the index page.
I
=
ψ(t)
u(a, t)
c(ξ)u
(ξ, t) dξ
dt
t
2
k(θ, t)
adds to a group, enclose in open-
\addtogroup <l> (t)
Column aligned hypens (-) create a unordered or bulleted list.
0
γ(t)
a
close pairs.
Column aligned hypens with a pound-number symbol (-#) cre-
To include an inline formula the command \f$ is used to begin
\ingroup <l>
adds documentation to the l
ate an ordered or numbered list. Lists can be made heirachi-
and end the formula block, the above formula would appear in
group.
cal using indentation levels, list items with identical column
the documentation as \f$ \sqrt{(x-x_0)^2-(y-y_0)^2} \f$.
references group l using the op-
\ref <l> ‘‘<t>’’
aligned symbols will appear at the same level of the heirarchy.
A centered formula is enclosed by the Doxygen commands \f[
tional link text t.
Unordered and ordered lists can be mixed in a heirarchy.
to open the formula block and \f] to close it. Additional L
A
T E X
comment to open a group block
/* @{ */
-
list item in unorderd list (column aligned).
equation environments, like eqnarray can be used with the com-
/* @} */
comment to close a group block
list item in orderd list (column aligned).
-#
mands \f{eqnarray} to open the formula block and \f} to close
comment to open a group block
// @{
list item in unorderd list.
\li
the block.
comment to open a group block
// @{
equivalent to \li.
\arg
HTML: starts an unordered list.
<ul>
Module Groups
L
A
T E X Formulas
</ul>
HTML: ends an unordered list.
Module group documentation will appear under the Modules
L
A
T E X formulas use a markup language with a rich set of tags
HTML: starts an ordered list.
<ol>
heading in the generated documentation. Module groups are
which can be combined to typeset any formula. A brief sub-set
HTML: ends an ordered list.
</ol>
defined with the \defgroup <label> ‘‘<title>’’, which gives
of those commands is included here. Additional resources can
HTML: list item, between <[uo]l> and </[uo]l>
<li>
the group a label for later reference. and a title to display in
be found on the web and in bookstores.
pairs.
the documenation; title includes everything enclosed by quotes.
2
Grouping
x
; superscript
x
; subscript
x^{2}
x_{0}
0
x
Member Groups
\frac{x}{y}
\sqrt[n]{x}
x
Doxygen can group things in many ways.
Groups are de-
y
n
b
fined with either a \defgroup, \name or \page command
Member group are used when “a compound (e.g. a class or file)
dt
\sum_{k=1}^n
\int_{a}^b dt
k=1
a
with a label and optional title.
The label can be used in
has many members, it is often desired to group them together”.
π; small Greek
Π; capital Greek
\pi
\Pi
ADVERTISEMENT
0 votes
Related Articles
Related forms
Related Categories
Parent category: Education