Doxygen 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 (http://www.doxygen.org/) 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 formats, the default filename is Doxyfile. Page Groups /** \defgroup <label> ‘‘<title>’’ */ doxygen Run with default config file. /* @{ */ Page group documentation will appear under the Related doxygen <config-file> Run with <config-file>. // group members here ... Pages heading in the generated documentation. Page groups doxygen -g <config-file> Generate <config-file>. /* @} */ are defined with the \page <label> (title), which gives the group a label for later reference. and a title to display Documenting the sources where groups initiated by \name or \page commands have sim- in the documenation. Pages can be further divided into Doxygen-visible multi-line comment blocks begin with /**, or ilar forms, see table below. The open and close group com- sub-pages—with \sub-page <n> ‘‘<t>’’, sections and sub- /*!, and end with */. Alternately, the of C++ single line com- mands must be placed in a comment block, this can be a stan- sections, and sub-subsections with a command similar to: ment delimiters /// or //! may be used on each line. Within dard C-style comment or single line C++ comment. Elements \section <section-name> (section title) . The name of the a comment block HTML tags or Doxygen specific markup tags, may be members of multiple groups, which may lead to con- command simply changes to subsection or subsubsection as Special Commands, can be used. Documentation comment flicts when generating documentation. Doxygen implements required. These commands give a label <section-name> and blocks can occur anywhere in the source code but placing such a priority scheme for group membership. The priorities are title (section title) to the section. blocks before defined code elements, classes, functions, etc., is assigned based on the command used to initiate group mem- recommended. Source code files should include the \file com- bership. The priority order (highest to lowest) is \ingroup, A special case of a page group is the main page group. The mand to make comments in the file visible to Doxygen. \defgroup, \addtogroup, and \weakgroup Doxygen command \mainpage within a comment block places the documentation within that block on the Index page of the Doxygen special commands, with a few exceptions, begin with \defgroup <l> ‘‘<t>’’ defines a module group with a la- generated documentation. You can refer to the main page using the prefix @ or \, used in this document. Following the Doxygen bel l and title t. \ref index (if the treeview is disabled, otherwise you should use manual convention, the command arguments are enclosed here \name <l> defines a member group with a la- \ref main). in braces that signify the extent of the argument, these braces bel l. are not part of the command, nor should they be included in \page <l> (t) defines a page group with a label l Formulas the command: and title t. Doxygen can include LATEX formulas in the HTML and LATEX \section <l> (t) defines a section on a page with a < angle > angle braces: argument is a single word. output formats. Formulas can be included within the text of label l and title t. p 2 2 ( round ) round braces: argument extends to end of line. a single line, for example—r = (x − x0) − (y − y0) or as a \subsection <l> (t) defines a sub-section on a page { curly } curly braces: argument extends to next para- centered formula such as (from the Doxygen manual): with a label l and title t. graph. \mainpage (t) defines a documentation block to Z T Z a Z θ dθ Lists place on the index page. |I2| = ψ(t) u(a, t) − c(ξ)ut(ξ, t) dξ dt k(θ, t) Column aligned hypens (-) create a unordered or bulleted list. \addtogroup <l> (t) adds to a group, enclose in open- 0 γ(t) a Column aligned hypens with a pound-number symbol (-#) cre- close pairs. To include an inline formula the command is used to begin ate an ordered or numbered list. Lists can be made heirachi- \ingroup <l> adds documentation to the l \f$ and end the formula block, the above formula would appear in cal using indentation levels, list items with identical column group. the documentation as . aligned symbols will appear at the same level of the heirarchy. \ref <l> ‘‘<t>’’ references group l using the op- \f$ \sqrt{(x-x_0)^2-(y-y_0)^2} \f$ A centered formula is enclosed by the Doxygen commands Unordered and ordered lists can be mixed in a heirarchy. tional link text t. \f[ to open the formula block and to close it. Additional LAT X - list item in unorderd list (column aligned). /* @{ */ comment to open a group block \f] E equation environments, like can be used with the com- -# list item in orderd list (column aligned). /* @} */ comment to close a group block eqnarray mands to open the formula block and to close \li list item in unorderd list. // @{ comment to open a group block \f{eqnarray} \f} the block. \arg equivalent to \li. // @{ comment to open a group block <ul> HTML: starts an unordered list. Module Groups LAT X Formulas </ul> HTML: ends an unordered list. E <ol> HTML: starts an ordered list. Module group documentation will appear under the Modules LATEX formulas use a markup language with a rich set of tags </ol> HTML: ends an ordered list. heading in the generated documentation. Module groups are which can be combined to typeset any formula. A brief sub-set <li> HTML: list item, between <[uo]l> and </[uo]l> defined with the \defgroup <label> ‘‘<title>’’, which gives of those commands is included here. Additional resources can pairs. the group a label for later reference. and a title to display in be found on the web and in bookstores. the documenation; title includes everything enclosed by quotes. 2 Grouping x^{2} x ; superscript x_{0} x√0; subscript Member Groups x n Doxygen can group things in many ways. Groups are de- \frac{x}{y} y \sqrt[n]{x} x n b fined with either a \defgroup, \name or \page command Member group are used when “a compound (e.g. a class or file) \sum_{k=1}^n P \int_{a}^b dt R 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”. \pi π; small Greek \Pi Π; capital Greek Graphs Structural Indicators Section Indicators Doxygen can produce graphs, generated by the dot tool from \attention {...} starts an Attention paragraph. Graphviz (http://www.graphviz.org/). Graph generation by \author {loa} includes the list of authors loa. Doxygen is normally performed automatically based on settings \brief {...} a brief description of the element. in the configuration file. These settings, with the exception of \addtogroup <l> (t) adds to a group, enclose in open-close \bug {...} a bug description. DOT_PATH are either YES or NO. These are global settings for the pairs. \cond <sec> begins a conditional section. project. Graphs will only be generated if you have dot installed \callgraph generates a call graph for function or \date {...} and HAVE_DOT = YES. method \deprecated {...} starts a Deprecated paragraph. \callergraph generates a caller graph for function or \else additional clause to a \if command HAVE_DOT signals that the dot tool is available. method \elseif <sec> additional clause to a \cond command. DOT_PATH path todot tool, if not in $PATH. \category documentation block for a class cate- \endcond ends a conditional section. GRAPHICAL_HIERARCHY generate a graph of class heirarchy. gory (Objective-C only). \endif ends an \if clause. CLASS_GRAPH generate inheritance graph for each \class <c> [<f>] [<n>]documents the class c, header file f \exception <e> starts an exception description for e documented class. and header name n can be included. \if <sec> starts a conditional section. INCLUDE_GRAPH generate dependency graph for each \def <name> documents the name #define macro \ifnot <sec> starts a conditional section. documented file. \defgroup <l> ‘‘<t>’’ defines a module group with a label l \invariant {...} starts a description of an invariant. CALL_GRAPH generate call graph for each docu- and title t. \note {...} starts a Note paragraph. mented function or method. \enum <name> documents the name enumeration \par (t) {...} starts a paragraph with and optional title CALLER_GRAPH generate a graph indicating func- \example <file> a documentation block for an example (t). tions called by the documented contained in file. \param <p> {...} starts a description of parameter p. function. \file <name> a documentation block for file name \post {...} starts a post-condition description. COLLABORATION_GRAPH generate a graph showing inheri- \fn <sig> documents the function with signature \pre {...} starts a pre-condition description. tance and usage relationships be- sig \remarks {...} starts a Remarks paragraph. tween classes and structs. \hideinitializer hides the default value of a #define \return {...} starts a description of return values. \retval <f> {...} describes a return value for function f You can also use the dot language syntax to generate a graph. \ingroup <l1> [<l2>] adds documentation to the l1 group, multiple groups can be used.