Doxygen Manual 1.8.14
doxygen_manual-1.8.14
User Manual: Pdf
Open the PDF directly: View PDF
.
Page Count: 324
Manual for version 1.8.14
Written by Dimitri van Heesch
©1997-2017
Contents
I
User Manual
1
1
Introduction
3
2
Installation
7
2.1
Compiling from source on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
2.2
Installing the binaries on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
2.3
Compiling from source on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
2.4
Installing the binaries on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9
3
Getting Started
11
3.1
Step 0: Check if doxygen supports your programming language . . . . . . . . . . . . . . . . . . . .
12
3.2
Step 1: Creating a configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
3.3
Step 2: Running doxygen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
3.3.1
HTML output
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
3.3.2
LaTeX output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
3.3.3
RTF output
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
3.3.4
XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
3.3.5
Man page output
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
3.3.6
DocBook output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
Step 3: Documenting the sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
15
3.4
4
4.1
4.2
Documenting the code
17
Special comment blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
4.1.1
Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java) . . . . . . . . . . .
17
Putting documentation after members . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
Documentation at other places . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
4.1.2
Comment blocks in Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
4.1.3
Comment blocks in VHDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
4.1.4
Comment blocks in Fortran . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
4.1.5
Comment blocks in Tcl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
Anatomy of a comment block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
II
5
5.1
CONTENTS
Markdown
31
Standard Markdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
5.1.1
Paragraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
5.1.2
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31
5.1.3
Block quotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
5.1.4
Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
5.1.5
Code Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
5.1.6
Horizontal Rulers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
5.1.7
Emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
5.1.8
code spans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
5.1.9
Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
Inline Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
Reference Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
5.1.10 Images
5.2
5.3
5.4
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
5.1.11 Automatic Linking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
Markdown Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
5.2.1
Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
5.2.2
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
35
5.2.3
Fenced Code Blocks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
5.2.4
Header Id Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
Doxygen specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
5.3.1
Including Markdown files as pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37
5.3.2
Treatment of HTML blocks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
38
5.3.3
Code Block Indentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
38
5.3.4
Emphasis limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
38
5.3.5
Code Spans Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
5.3.6
Lists Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
5.3.7
Use of asterisks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
5.3.8
Limits on markup scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
Debugging of problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
6
Lists
41
7
Grouping
43
7.1
Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
7.2
Member Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
45
7.3
Subpaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
8
Including Formulas
49
9
Including Tables
51
Generated by Doxygen 1.8.14
CONTENTS
III
10 Graphs and diagrams
53
11 Preprocessing
57
12 Automatic link generation
61
12.1
Links to web pages and mail addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
12.2
Links to classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
12.3
Links to files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
12.4
Links to functions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
12.5
Links to other members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
62
12.6
typedefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
13 Output Formats
65
14 Searching
67
14.1
External Indexing and Searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
14.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
14.1.2 Configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
70
Single project index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
Multi project index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
14.1.3 Updating the index
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
14.1.4 Programming interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
Indexer input format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
Search URL format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
Search results format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
15 Customizing the Output
75
15.1
Minor Tweaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
75
15.1.1 Overall Color
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
75
15.1.2 Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
75
15.1.3 Dynamic Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
76
15.1.4 Header, Footer, and Stylesheet changes . . . . . . . . . . . . . . . . . . . . . . . . . . . .
76
15.2
Changing the layout of pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
15.3
Using the XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
80
16 Custom Commands
81
16.1
Simple aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81
16.2
Aliases with arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81
16.3
Nesting custom command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
17 Link to external documentation
83
18 Frequently Asked Questions
85
Generated by Doxygen 1.8.14
IV
CONTENTS
18.1
How to get information on the index page in HTML? . . . . . . . . . . . . . . . . . . . . . . . . . .
85
18.2
Help, some/all of the members of my class / file / namespace are not documented? . . . . . . . . . .
85
18.3
When I set EXTRACT_ALL to NO none of my functions are shown in the documentation. . . . . . . .
86
18.4
My file with a custom extension is not parsed (properly) (anymore). . . . . . . . . . . . . . . . . . .
86
18.5
How can I make doxygen ignore some code fragment? . . . . . . . . . . . . . . . . . . . . . . . . .
86
18.6
How can I change what is after the #include
in the class documentation? . . . . . .
86
18.7
How can I use tag files in combination with compressed HTML? . . . . . . . . . . . . . . . . . . . .
87
18.8
I don't like the quick index that is put above each HTML page, what do I do? . . . . . . . . . . . . . .
87
18.9
The overall HTML output looks different, while I only wanted to use my own html header file
. . . . .
87
18.10 Why does doxygen use Qt? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
18.11 How can I exclude all test directories from my directory tree? . . . . . . . . . . . . . . . . . . . . . .
88
18.12 Doxygen automatically generates a link to the class MyClass somewhere in the running text. How do I
prevent that at a certain place? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
88
18.13 My favorite programming language is X. Can I still use doxygen? . . . . . . . . . . . . . . . . . . . .
88
18.14 Help! I get the cryptic message "input buffer overflow, can't enlarge buffer because scanner uses
REJECT" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
88
18.15 When running make in the latex dir I get "TeX capacity exceeded". Now what? . . . . . . . . . . . .
88
18.16 Why are dependencies via STL classes not shown in the dot graphs? . . . . . . . . . . . . . . . . .
88
18.17 I have problems getting the search engine to work with PHP5 and/or windows . . . . . . . . . . . . .
89
18.18 Can I configure doxygen from the command line?
. . . . . . . . . . . . . . . . . . . . . . . . . . .
89
18.19 How did doxygen get its name? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
18.20 What was the reason to develop doxygen? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
19 Troubleshooting
91
19.1
Known Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
19.2
How to Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
19.3
How to report a bug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
II
Reference Manual
93
20 Features
95
21 Doxygen usage
97
21.1
97
Fine-tuning the output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22 Doxywizard usage
23 Configuration
99
105
23.1
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
23.2
Project related configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
23.3
Build related configuration options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
23.4
Configuration options related to warning and progress messages . . . . . . . . . . . . . . . . . . . 116
Generated by Doxygen 1.8.14
CONTENTS
V
23.5
Configuration options related to the input files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
23.6
Configuration options related to source browsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
23.7
Configuration options related to the alphabetical class index . . . . . . . . . . . . . . . . . . . . . . 120
23.8
Configuration options related to the HTML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
23.9
Configuration options related to the LaTeX output . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
23.10 Configuration options related to the RTF output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
23.11 Configuration options related to the man page output . . . . . . . . . . . . . . . . . . . . . . . . . . 131
23.12 Configuration options related to the XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
23.13 Configuration options related to the DOCBOOK output . . . . . . . . . . . . . . . . . . . . . . . . . 132
23.14 Configuration options for the AutoGen Definitions output . . . . . . . . . . . . . . . . . . . . . . . . 133
23.15 Configuration options related to the Perl module output . . . . . . . . . . . . . . . . . . . . . . . . . 133
23.16 Configuration options related to the preprocessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
23.17 Configuration options related to external references
. . . . . . . . . . . . . . . . . . . . . . . . . . 134
23.18 Configuration options related to the dot tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
23.19 Examples
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
24 Special Commands
141
24.1
Introduction
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
24.2
\addtogroup [(title)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
24.3
\callgraph
24.4
\hidecallgraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
24.5
\callergraph
24.6
\hidecallergraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
24.7
\category [] [] . . . . . . . . . . . . . . . . . . . . . . . . 144
24.8
\class [] [] . . . . . . . . . . . . . . . . . . . . . . . . . . 144
24.9
\def . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
24.10 \defgroup (group title) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
24.11 \dir [] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
24.12 \enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
24.13 \example
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
24.14 \endinternal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
24.15 \extends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
24.16 \file [] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
24.17 \fn (function declaration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
24.18 \headerfile [] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
24.19 \hideinitializer
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
24.20 \idlexcept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
24.21 \implements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
24.22 \ingroup ( [ ])
24.23 \interface [] []
Generated by Doxygen 1.8.14
. . . . . . . . . . . . . . . . . . . . . . 149
. . . . . . . . . . . . . . . . . . . . . . . . 149
VI
CONTENTS
24.24 \internal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
24.25 \mainpage [(title)]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
24.26 \memberof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
24.27 \name [(header)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
24.28 \namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
24.29 \nosubgrouping
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
24.30 \overload [(function declaration)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
24.31 \package
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
24.32 \page (title) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
24.33 \private . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
24.34 \privatesection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
24.35 \property (qualified property name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
24.36 \protected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
24.37 \protectedsection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
24.38 \protocol [] [] . . . . . . . . . . . . . . . . . . . . . . . . . 153
24.39 \public . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
24.40 \publicsection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
24.41 \pure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
24.42 \relates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
24.43 \related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.44 \relatesalso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.45 \relatedalso . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.46 \showinitializer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.47 \static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.48 \struct [] [] . . . . . . . . . . . . . . . . . . . . . . . . . . 155
24.49 \typedef (typedef declaration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.50 \union [] [] . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.51 \var (variable declaration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.52 \vhdlflow [(title for the flow chart)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.53 \weakgroup [(title)]
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.54 \attention { attention text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
24.55 \author { list of authors } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
24.56 \authors { list of authors }
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
24.57 \brief { brief description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
24.58 \bug { bug description }
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
24.59 \cond [(section-label)] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
24.60 \copyright { copyright description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
24.61 \date { date description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
24.62 \deprecated { description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
24.63 \details { detailed description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Generated by Doxygen 1.8.14
CONTENTS
VII
24.64 \else . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
24.65 \elseif (section-label) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
24.66 \endcond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
24.67 \endif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
24.68 \exception { exception description } . . . . . . . . . . . . . . . . . . . . . . . . 160
24.69 \if (section-label) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
24.70 \ifnot (section-label) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
24.71 \invariant { description of invariant } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
24.72 \note { text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
24.73 \par [(paragraph title)] { paragraph } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
24.74 \param [(dir)] { parameter description } . . . . . . . . . . . . . . . . . . . . . . 162
24.75 \parblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
24.76 \endparblock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
24.77 \tparam { description } . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.78 \post { description of the postcondition } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.79 \pre { description of the precondition } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.80 \remark { remark text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.81 \remarks { remark text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.82 \result { description of the result value } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.83 \return { description of the return value } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
24.84 \returns { description of the return value } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.85 \retval { description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.86 \sa { references } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.87 \see { references } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.88 \short { short description } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.89 \since { text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.90 \test { paragraph describing a test case } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.91 \throw { exception description } . . . . . . . . . . . . . . . . . . . . . . . . . . 164
24.92 \throws { exception description } . . . . . . . . . . . . . . . . . . . . . . . . . . 165
24.93 \todo { paragraph describing what is to be done } . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
24.94 \version { version number }
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
24.95 \warning { warning message } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
24.96 \xrefitem "(heading)" "(list title)" { text } . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
24.97 \addindex (text)
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
24.98 \anchor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
24.99 \cite