summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Friloux <guillaume.friloux@gmail.com>2014-01-02 15:11:07 +0100
committerGuillaume Friloux <guillaume.friloux@gmail.com>2014-01-02 15:11:07 +0100
commit33e96015d92d5d25ddf874aba7d6fbf17e01539c (patch)
treeee8d06fcdd20f8f592c7393695674d675c023f9b
parentc4e7e2a985fdab5f469d658e2eab801aa2b99122 (diff)
Update Doxyfile to 1.8.2 doxygen format to 1.8.5.
-rw-r--r--doc/Doxyfile2337
1 files changed, 1403 insertions, 934 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 13aed12..6b0267a 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -1,110 +1,119 @@
1# Doxyfile 1.8.2 1# Doxyfile 1.8.5
2 2
3# This file describes the settings to be used by the documentation system 3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project. 4# doxygen (www.doxygen.org) for a project.
5# 5#
6# All text after a hash (#) is considered a comment and will be ignored. 6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
7# The format is: 10# The format is:
8# TAG = value [value, ...] 11# TAG = value [value, ...]
9# For lists items can also be appended using: 12# For lists, items can also be appended using:
10# TAG += value [value, ...] 13# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" "). 14# Values that contain spaces should be placed between quotes (\" \").
12 15
13#--------------------------------------------------------------------------- 16#---------------------------------------------------------------------------
14# Project related configuration options 17# Project related configuration options
15#--------------------------------------------------------------------------- 18#---------------------------------------------------------------------------
16 19
17# This tag specifies the encoding used for all characters in the config file 20# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all 21# that follow. The default is UTF-8 which is also the encoding used for all text
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the 22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
20# iconv built into libc) for the transcoding. See 23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
21# http://www.gnu.org/software/libiconv for the list of possible encodings. 24# for the list of possible encodings.
25# The default value is: UTF-8.
22 26
23DOXYFILE_ENCODING = UTF-8 27DOXYFILE_ENCODING = UTF-8
24 28
25# The PROJECT_NAME tag is a single word (or sequence of words) that should 29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
26# identify the project. Note that if you do not use Doxywizard you need 30# double-quotes, unless you are using Doxywizard) that should identify the
27# to put quotes around the project name if it contains spaces. 31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
28 34
29PROJECT_NAME = "Syslog Message MANager" 35PROJECT_NAME = "Syslog Message MANager"
30 36
31# The PROJECT_NUMBER tag can be used to enter a project or revision number. 37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
32# This could be handy for archiving the generated documentation or 38# could be handy for archiving the generated documentation or if some version
33# if some version control system is used. 39# control system is used.
34 40
35PROJECT_NUMBER = 41PROJECT_NUMBER =
36 42
37# Using the PROJECT_BRIEF tag one can provide an optional one line description 43# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer 44# for a project that appears at the top of each page and should give viewer a
39# a quick idea about the purpose of the project. Keep the description short. 45# quick idea about the purpose of the project. Keep the description short.
40 46
41PROJECT_BRIEF = 47PROJECT_BRIEF =
42 48
43# With the PROJECT_LOGO tag one can specify an logo or icon that is 49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
44# included in the documentation. The maximum height of the logo should not 50# the documentation. The maximum height of the logo should not exceed 55 pixels
45# exceed 55 pixels and the maximum width should not exceed 200 pixels. 51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
46# Doxygen will copy the logo to the output directory. 52# to the output directory.
47 53
48PROJECT_LOGO = 54PROJECT_LOGO =
49 55
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
51# base path where the generated documentation will be put. 57# into which the generated documentation will be written. If a relative path is
52# If a relative path is entered, it will be relative to the location 58# entered, it will be relative to the location where doxygen was started. If
53# where doxygen was started. If left blank the current directory will be used. 59# left blank the current directory will be used.
54 60
55OUTPUT_DIRECTORY = . 61OUTPUT_DIRECTORY = .
56 62
57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
58# 4096 sub-directories (in 2 levels) under the output directory of each output 64# directories (in 2 levels) under the output directory of each output format and
59# format and will distribute the generated files over these directories. 65# will distribute the generated files over these directories. Enabling this
60# Enabling this option can be useful when feeding doxygen a huge amount of 66# option can be useful when feeding doxygen a huge amount of source files, where
61# source files, where putting all generated files in the same directory would 67# putting all generated files in the same directory would otherwise causes
62# otherwise cause performance problems for the file system. 68# performance problems for the file system.
69# The default value is: NO.
63 70
64CREATE_SUBDIRS = NO 71CREATE_SUBDIRS = NO
65 72
66# The OUTPUT_LANGUAGE tag is used to specify the language in which all 73# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this 74# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language. 75# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are: 76# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 77# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 78# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 79# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 80# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 81# Turkish, Ukrainian and Vietnamese.
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 82# The default value is: English.
76 83
77OUTPUT_LANGUAGE = English 84OUTPUT_LANGUAGE = English
78 85
79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 86# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
80# include brief member descriptions after the members that are listed in 87# descriptions after the members that are listed in the file and class
81# the file and class documentation (similar to JavaDoc). 88# documentation (similar to Javadoc). Set to NO to disable this.
82# Set to NO to disable this. 89# The default value is: YES.
83 90
84BRIEF_MEMBER_DESC = YES 91BRIEF_MEMBER_DESC = YES
85 92
86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 93# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
87# the brief description of a member or function before the detailed description. 94# description of a member or function before the detailed description
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 95#
96# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89# brief descriptions will be completely suppressed. 97# brief descriptions will be completely suppressed.
98# The default value is: YES.
90 99
91REPEAT_BRIEF = YES 100REPEAT_BRIEF = YES
92 101
93# This tag implements a quasi-intelligent brief description abbreviator 102# This tag implements a quasi-intelligent brief description abbreviator that is
94# that is used to form the text in various listings. Each string 103# used to form the text in various listings. Each string in this list, if found
95# in this list, if found as the leading text of the brief description, will be 104# as the leading text of the brief description, will be stripped from the text
96# stripped from the text and the result after processing the whole list, is 105# and the result, after processing the whole list, is used as the annotated
97# used as the annotated text. Otherwise, the brief description is used as-is. 106# text. Otherwise, the brief description is used as-is. If left blank, the
98# If left blank, the following values are used ("$name" is automatically 107# following values are used ($name is automatically replaced with the name of
99# replaced with the name of the entity): "The $name class" "The $name widget" 108# the entity):The $name class, The $name widget, The $name file, is, provides,
100# "The $name file" "is" "provides" "specifies" "contains" 109# specifies, contains, represents, a, an and the.
101# "represents" "a" "an" "the"
102 110
103ABBREVIATE_BRIEF = 111ABBREVIATE_BRIEF =
104 112
105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 113# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106# Doxygen will generate a detailed section even if there is only a brief 114# doxygen will generate a detailed section even if there is only a brief
107# description. 115# description.
116# The default value is: NO.
108 117
109ALWAYS_DETAILED_SEC = NO 118ALWAYS_DETAILED_SEC = NO
110 119
@@ -112,174 +121,205 @@ ALWAYS_DETAILED_SEC = NO
112# inherited members of a class in the documentation of that class as if those 121# inherited members of a class in the documentation of that class as if those
113# members were ordinary class members. Constructors, destructors and assignment 122# members were ordinary class members. Constructors, destructors and assignment
114# operators of the base classes will not be shown. 123# operators of the base classes will not be shown.
124# The default value is: NO.
115 125
116INLINE_INHERITED_MEMB = NO 126INLINE_INHERITED_MEMB = NO
117 127
118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 128# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
119# path before files name in the file list and in the header files. If set 129# before files name in the file list and in the header files. If set to NO the
120# to NO the shortest path that makes the file name unique will be used. 130# shortest path that makes the file name unique will be used
131# The default value is: YES.
121 132
122FULL_PATH_NAMES = NO 133FULL_PATH_NAMES = NO
123 134
124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
125# can be used to strip a user-defined part of the path. Stripping is 136# Stripping is only done if one of the specified strings matches the left-hand
126# only done if one of the specified strings matches the left-hand part of 137# part of the path. The tag can be used to show relative paths in the file list.
127# the path. The tag can be used to show relative paths in the file list. 138# If left blank the directory from which doxygen is run is used as the path to
128# If left blank the directory from which doxygen is run is used as the 139# strip.
129# path to strip. Note that you specify absolute paths here, but also 140#
130# relative paths, which will be relative from the directory where doxygen is 141# Note that you can specify absolute paths here, but also relative paths, which
131# started. 142# will be relative from the directory where doxygen is started.
143# This tag requires that the tag FULL_PATH_NAMES is set to YES.
132 144
133STRIP_FROM_PATH = 145STRIP_FROM_PATH =
134 146
135# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 147# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
136# the path mentioned in the documentation of a class, which tells 148# path mentioned in the documentation of a class, which tells the reader which
137# the reader which header file to include in order to use a class. 149# header file to include in order to use a class. If left blank only the name of
138# If left blank only the name of the header file containing the class 150# the header file containing the class definition is used. Otherwise one should
139# definition is used. Otherwise one should specify the include paths that 151# specify the list of include paths that are normally passed to the compiler
140# are normally passed to the compiler using the -I flag. 152# using the -I flag.
141 153
142STRIP_FROM_INC_PATH = 154STRIP_FROM_INC_PATH =
143 155
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 156# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
145# (but less readable) file names. This can be useful if your file system 157# less readable) file names. This can be useful is your file systems doesn't
146# doesn't support long names like on DOS, Mac, or CD-ROM. 158# support long names like on DOS, Mac, or CD-ROM.
159# The default value is: NO.
147 160
148SHORT_NAMES = NO 161SHORT_NAMES = NO
149 162
150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 163# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
151# will interpret the first line (until the first dot) of a JavaDoc-style 164# first line (until the first dot) of a Javadoc-style comment as the brief
152# comment as the brief description. If set to NO, the JavaDoc 165# description. If set to NO, the Javadoc-style will behave just like regular Qt-
153# comments will behave just like regular Qt-style comments 166# style comments (thus requiring an explicit @brief command for a brief
154# (thus requiring an explicit @brief command for a brief description.) 167# description.)
168# The default value is: NO.
155 169
156JAVADOC_AUTOBRIEF = YES 170JAVADOC_AUTOBRIEF = YES
157 171
158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 172# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
159# interpret the first line (until the first dot) of a Qt-style 173# line (until the first dot) of a Qt-style comment as the brief description. If
160# comment as the brief description. If set to NO, the comments 174# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
161# will behave just like regular Qt-style comments (thus requiring 175# requiring an explicit \brief command for a brief description.)
162# an explicit \brief command for a brief description.) 176# The default value is: NO.
163 177
164QT_AUTOBRIEF = NO 178QT_AUTOBRIEF = NO
165 179
166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 180# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
167# treat a multi-line C++ special comment block (i.e. a block of //! or /// 181# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
168# comments) as a brief description. This used to be the default behaviour. 182# a brief description. This used to be the default behavior. The new default is
169# The new default is to treat a multi-line C++ comment block as a detailed 183# to treat a multi-line C++ comment block as a detailed description. Set this
170# description. Set this tag to YES if you prefer the old behaviour instead. 184# tag to YES if you prefer the old behavior instead.
185#
186# Note that setting this tag to YES also means that rational rose comments are
187# not recognized any more.
188# The default value is: NO.
171 189
172MULTILINE_CPP_IS_BRIEF = NO 190MULTILINE_CPP_IS_BRIEF = NO
173 191
174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 192# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
175# member inherits the documentation from any documented member that it 193# documentation from any documented member that it re-implements.
176# re-implements. 194# The default value is: YES.
177 195
178INHERIT_DOCS = YES 196INHERIT_DOCS = YES
179 197
180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 198# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
181# a new page for each member. If set to NO, the documentation of a member will 199# new page for each member. If set to NO, the documentation of a member will be
182# be part of the file/class/namespace that contains it. 200# part of the file/class/namespace that contains it.
201# The default value is: NO.
183 202
184SEPARATE_MEMBER_PAGES = NO 203SEPARATE_MEMBER_PAGES = NO
185 204
186# The TAB_SIZE tag can be used to set the number of spaces in a tab. 205# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
187# Doxygen uses this value to replace tabs by spaces in code fragments. 206# uses this value to replace tabs by spaces in code fragments.
207# Minimum value: 1, maximum value: 16, default value: 4.
188 208
189TAB_SIZE = 8 209TAB_SIZE = 8
190 210
191# This tag can be used to specify a number of aliases that acts 211# This tag can be used to specify a number of aliases that act as commands in
192# as commands in the documentation. An alias has the form "name=value". 212# the documentation. An alias has the form:
193# For example adding "sideeffect=\par Side Effects:\n" will allow you to 213# name=value
194# put the command \sideeffect (or @sideeffect) in the documentation, which 214# For example adding
195# will result in a user-defined paragraph with heading "Side Effects:". 215# "sideeffect=@par Side Effects:\n"
196# You can put \n's in the value part of an alias to insert newlines. 216# will allow you to put the command \sideeffect (or @sideeffect) in the
217# documentation, which will result in a user-defined paragraph with heading
218# "Side Effects:". You can put \n's in the value part of an alias to insert
219# newlines.
197 220
198ALIASES = 221ALIASES = "xmpp=<blockquote class=\"xmpp\">" \
222 "endxmpp=</blockquote>"
199 223
200# This tag can be used to specify a number of word-keyword mappings (TCL only). 224# This tag can be used to specify a number of word-keyword mappings (TCL only).
201# A mapping has the form "name=value". For example adding 225# A mapping has the form "name=value". For example adding "class=itcl::class"
202# "class=itcl::class" will allow you to use the command class in the 226# will allow you to use the command class in the itcl::class meaning.
203# itcl::class meaning.
204 227
205TCL_SUBST = 228TCL_SUBST =
206 229
207# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 230# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
208# sources only. Doxygen will then generate output that is more tailored for C. 231# only. Doxygen will then generate output that is more tailored for C. For
209# For instance, some of the names that are used will be different. The list 232# instance, some of the names that are used will be different. The list of all
210# of all members will be omitted, etc. 233# members will be omitted, etc.
234# The default value is: NO.
211 235
212OPTIMIZE_OUTPUT_FOR_C = YES 236OPTIMIZE_OUTPUT_FOR_C = YES
213 237
214# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 238# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
215# sources only. Doxygen will then generate output that is more tailored for 239# Python sources only. Doxygen will then generate output that is more tailored
216# Java. For instance, namespaces will be presented as packages, qualified 240# for that language. For instance, namespaces will be presented as packages,
217# scopes will look different, etc. 241# qualified scopes will look different, etc.
242# The default value is: NO.
218 243
219OPTIMIZE_OUTPUT_JAVA = NO 244OPTIMIZE_OUTPUT_JAVA = NO
220 245
221# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 246# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
222# sources only. Doxygen will then generate output that is more tailored for 247# sources. Doxygen will then generate output that is tailored for Fortran.
223# Fortran. 248# The default value is: NO.
224 249
225OPTIMIZE_FOR_FORTRAN = NO 250OPTIMIZE_FOR_FORTRAN = NO
226 251
227# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 252# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
228# sources. Doxygen will then generate output that is tailored for 253# sources. Doxygen will then generate output that is tailored for VHDL.
229# VHDL. 254# The default value is: NO.
230 255
231OPTIMIZE_OUTPUT_VHDL = NO 256OPTIMIZE_OUTPUT_VHDL = NO
232 257
233# Doxygen selects the parser to use depending on the extension of the files it 258# Doxygen selects the parser to use depending on the extension of the files it
234# parses. With this tag you can assign which parser to use for a given 259# parses. With this tag you can assign which parser to use for a given
235# extension. Doxygen has a built-in mapping, but you can override or extend it 260# extension. Doxygen has a built-in mapping, but you can override or extend it
236# using this tag. The format is ext=language, where ext is a file extension, 261# using this tag. The format is ext=language, where ext is a file extension, and
237# and language is one of the parsers supported by doxygen: IDL, Java, 262# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
238# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 263# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
239# C++. For instance to make doxygen treat .inc files as Fortran files (default 264# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
240# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 265# (default is Fortran), use: inc=Fortran f=C.
241# that for custom extensions you also need to set FILE_PATTERNS otherwise the 266#
242# files are not read by doxygen. 267# Note For files without extension you can use no_extension as a placeholder.
268#
269# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
270# the files are not read by doxygen.
243 271
244EXTENSION_MAPPING = 272EXTENSION_MAPPING =
245 273
246# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 274# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
247# comments according to the Markdown format, which allows for more readable 275# according to the Markdown format, which allows for more readable
248# documentation. See http://daringfireball.net/projects/markdown/ for details. 276# documentation. See http://daringfireball.net/projects/markdown/ for details.
249# The output of markdown processing is further processed by doxygen, so you 277# The output of markdown processing is further processed by doxygen, so you can
250# can mix doxygen, HTML, and XML commands with Markdown formatting. 278# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
251# Disable only in case of backward compatibilities issues. 279# case of backward compatibilities issues.
280# The default value is: YES.
252 281
253MARKDOWN_SUPPORT = YES 282MARKDOWN_SUPPORT = YES
254 283
255# When enabled doxygen tries to link words that correspond to documented classes, 284# When enabled doxygen tries to link words that correspond to documented
256# or namespaces to their corresponding documentation. Such a link can be 285# classes, or namespaces to their corresponding documentation. Such a link can
257# prevented in individual cases by by putting a % sign in front of the word or 286# be prevented in individual cases by by putting a % sign in front of the word
258# globally by setting AUTOLINK_SUPPORT to NO. 287# or globally by setting AUTOLINK_SUPPORT to NO.
288# The default value is: YES.
259 289
260AUTOLINK_SUPPORT = YES 290AUTOLINK_SUPPORT = YES
261 291
262# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 292# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
263# to include (a tag file for) the STL sources as input, then you should 293# to include (a tag file for) the STL sources as input, then you should set this
264# set this tag to YES in order to let doxygen match functions declarations and 294# tag to YES in order to let doxygen match functions declarations and
265# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 295# definitions whose arguments contain STL classes (e.g. func(std::string);
266# func(std::string) {}). This also makes the inheritance and collaboration 296# versus func(std::string) {}). This also make the inheritance and collaboration
267# diagrams that involve STL classes more complete and accurate. 297# diagrams that involve STL classes more complete and accurate.
298# The default value is: NO.
268 299
269BUILTIN_STL_SUPPORT = NO 300BUILTIN_STL_SUPPORT = NO
270 301
271# If you use Microsoft's C++/CLI language, you should set this option to YES to 302# If you use Microsoft's C++/CLI language, you should set this option to YES to
272# enable parsing support. 303# enable parsing support.
304# The default value is: NO.
273 305
274CPP_CLI_SUPPORT = NO 306CPP_CLI_SUPPORT = NO
275 307
276# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 308# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
277# Doxygen will parse them like normal C++ but will assume all classes use public 309# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
278# instead of private inheritance when no explicit protection keyword is present. 310# will parse them like normal C++ but will assume all classes use public instead
311# of private inheritance when no explicit protection keyword is present.
312# The default value is: NO.
279 313
280SIP_SUPPORT = NO 314SIP_SUPPORT = NO
281 315
282# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. 316# For Microsoft's IDL there are propget and propput attributes to indicate
317# getter and setter methods for a property. Setting this option to YES will make
318# doxygen to replace the get and set methods by a property in the documentation.
319# This will only work if the methods are indeed getting or setting a simple
320# type. If this is not the case, or you want to show the methods anyway, you
321# should set this option to NO.
322# The default value is: YES.
283 323
284IDL_PROPERTY_SUPPORT = YES 324IDL_PROPERTY_SUPPORT = YES
285 325
@@ -287,67 +327,61 @@ IDL_PROPERTY_SUPPORT = YES
287# tag is set to YES, then doxygen will reuse the documentation of the first 327# tag is set to YES, then doxygen will reuse the documentation of the first
288# member in the group (if any) for the other members of the group. By default 328# member in the group (if any) for the other members of the group. By default
289# all members of a group must be documented explicitly. 329# all members of a group must be documented explicitly.
330# The default value is: NO.
290 331
291DISTRIBUTE_GROUP_DOC = NO 332DISTRIBUTE_GROUP_DOC = NO
292 333
293# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 334# Set the SUBGROUPING tag to YES to allow class member groups of the same type
294# the same type (for instance a group of public functions) to be put as a 335# (for instance a group of public functions) to be put as a subgroup of that
295# subgroup of that type (e.g. under the Public Functions section). Set it to 336# type (e.g. under the Public Functions section). Set it to NO to prevent
296# NO to prevent subgrouping. Alternatively, this can be done per class using 337# subgrouping. Alternatively, this can be done per class using the
297# the \nosubgrouping command. 338# \nosubgrouping command.
339# The default value is: YES.
298 340
299SUBGROUPING = YES 341SUBGROUPING = YES
300 342
301# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 343# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
302# unions are shown inside the group in which they are included (e.g. using 344# are shown inside the group in which they are included (e.g. using \ingroup)
303# @ingroup) instead of on a separate page (for HTML and Man pages) or 345# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
304# section (for LaTeX and RTF). 346# and RTF).
347#
348# Note that this feature does not work in combination with
349# SEPARATE_MEMBER_PAGES.
350# The default value is: NO.
305 351
306INLINE_GROUPED_CLASSES = NO 352INLINE_GROUPED_CLASSES = NO
307 353
308# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 354# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
309# unions with only public data fields will be shown inline in the documentation 355# with only public data fields or simple typedef fields will be shown inline in
310# of the scope in which they are defined (i.e. file, namespace, or group 356# the documentation of the scope in which they are defined (i.e. file,
311# documentation), provided this scope is documented. If set to NO (the default), 357# namespace, or group documentation), provided this scope is documented. If set
312# structs, classes, and unions are shown on a separate page (for HTML and Man 358# to NO, structs, classes, and unions are shown on a separate page (for HTML and
313# pages) or section (for LaTeX and RTF). 359# Man pages) or section (for LaTeX and RTF).
360# The default value is: NO.
314 361
315INLINE_SIMPLE_STRUCTS = NO 362INLINE_SIMPLE_STRUCTS = NO
316 363
317# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 364# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
318# is documented as struct, union, or enum with the name of the typedef. So 365# enum is documented as struct, union, or enum with the name of the typedef. So
319# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 366# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
320# with name TypeT. When disabled the typedef will appear as a member of a file, 367# with name TypeT. When disabled the typedef will appear as a member of a file,
321# namespace, or class. And the struct will be named TypeS. This can typically 368# namespace, or class. And the struct will be named TypeS. This can typically be
322# be useful for C code in case the coding convention dictates that all compound 369# useful for C code in case the coding convention dictates that all compound
323# types are typedef'ed and only the typedef is referenced, never the tag name. 370# types are typedef'ed and only the typedef is referenced, never the tag name.
371# The default value is: NO.
324 372
325TYPEDEF_HIDES_STRUCT = NO 373TYPEDEF_HIDES_STRUCT = NO
326 374
327# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 375# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
328# determine which symbols to keep in memory and which to flush to disk. 376# cache is used to resolve symbols given their name and scope. Since this can be
329# When the cache is full, less often used symbols will be written to disk. 377# an expensive process and often the same symbol appears multiple times in the
330# For small to medium size projects (<1000 input files) the default value is 378# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
331# probably good enough. For larger projects a too small cache size can cause 379# doxygen will become slower. If the cache is too large, memory is wasted. The
332# doxygen to be busy swapping symbols to and from disk most of the time 380# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
333# causing a significant performance penalty. 381# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
334# If the system has enough physical memory increasing the cache will improve the 382# symbols. At the end of a run doxygen will report the cache usage and suggest
335# performance by keeping more symbols in memory. Note that the value works on 383# the optimal cache size from a speed point of view.
336# a logarithmic scale so increasing the size by one will roughly double the 384# Minimum value: 0, maximum value: 9, default value: 0.
337# memory usage. The cache size is given by this formula:
338# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
339# corresponding to a cache size of 2^16 = 65536 symbols.
340
341SYMBOL_CACHE_SIZE = 0
342
343# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
344# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
345# their name and scope. Since this can be an expensive process and often the
346# same symbol appear multiple times in the code, doxygen keeps a cache of
347# pre-resolved symbols. If the cache is too small doxygen will become slower.
348# If the cache is too large, memory is wasted. The cache size is given by this
349# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
350# corresponding to a cache size of 2^16 = 65536 symbols.
351 385
352LOOKUP_CACHE_SIZE = 0 386LOOKUP_CACHE_SIZE = 0
353 387
@@ -356,310 +390,349 @@ LOOKUP_CACHE_SIZE = 0
356#--------------------------------------------------------------------------- 390#---------------------------------------------------------------------------
357 391
358# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 392# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
359# documentation are documented, even if no documentation was available. 393# documentation are documented, even if no documentation was available. Private
360# Private class members and static file members will be hidden unless 394# class members and static file members will be hidden unless the
361# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 395# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
396# Note: This will also disable the warnings about undocumented members that are
397# normally produced when WARNINGS is set to YES.
398# The default value is: NO.
362 399
363EXTRACT_ALL = NO 400EXTRACT_ALL = NO
364 401
365# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 402# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
366# will be included in the documentation. 403# be included in the documentation.
404# The default value is: NO.
367 405
368EXTRACT_PRIVATE = NO 406EXTRACT_PRIVATE = NO
369 407
370# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 408# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
371# scope will be included in the documentation. 409# scope will be included in the documentation.
410# The default value is: NO.
372 411
373EXTRACT_PACKAGE = NO 412EXTRACT_PACKAGE = NO
374 413
375# If the EXTRACT_STATIC tag is set to YES all static members of a file 414# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
376# will be included in the documentation. 415# included in the documentation.
416# The default value is: NO.
377 417
378EXTRACT_STATIC = YES 418EXTRACT_STATIC = YES
379 419
380# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 420# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
381# defined locally in source files will be included in the documentation. 421# locally in source files will be included in the documentation. If set to NO
382# If set to NO only classes defined in header files are included. 422# only classes defined in header files are included. Does not have any effect
423# for Java sources.
424# The default value is: YES.
383 425
384EXTRACT_LOCAL_CLASSES = NO 426EXTRACT_LOCAL_CLASSES = NO
385 427
386# This flag is only useful for Objective-C code. When set to YES local 428# This flag is only useful for Objective-C code. When set to YES local methods,
387# methods, which are defined in the implementation section but not in 429# which are defined in the implementation section but not in the interface are
388# the interface are included in the documentation. 430# included in the documentation. If set to NO only methods in the interface are
389# If set to NO (the default) only methods in the interface are included. 431# included.
432# The default value is: NO.
390 433
391EXTRACT_LOCAL_METHODS = NO 434EXTRACT_LOCAL_METHODS = NO
392 435
393# If this flag is set to YES, the members of anonymous namespaces will be 436# If this flag is set to YES, the members of anonymous namespaces will be
394# extracted and appear in the documentation as a namespace called 437# extracted and appear in the documentation as a namespace called
395# 'anonymous_namespace{file}', where file will be replaced with the base 438# 'anonymous_namespace{file}', where file will be replaced with the base name of
396# name of the file that contains the anonymous namespace. By default 439# the file that contains the anonymous namespace. By default anonymous namespace
397# anonymous namespaces are hidden. 440# are hidden.
441# The default value is: NO.
398 442
399EXTRACT_ANON_NSPACES = NO 443EXTRACT_ANON_NSPACES = NO
400 444
401# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 445# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
402# undocumented members of documented classes, files or namespaces. 446# undocumented members inside documented classes or files. If set to NO these
403# If set to NO (the default) these members will be included in the 447# members will be included in the various overviews, but no documentation
404# various overviews, but no documentation section is generated. 448# section is generated. This option has no effect if EXTRACT_ALL is enabled.
405# This option has no effect if EXTRACT_ALL is enabled. 449# The default value is: NO.
406 450
407HIDE_UNDOC_MEMBERS = NO 451HIDE_UNDOC_MEMBERS = NO
408 452
409# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 453# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
410# undocumented classes that are normally visible in the class hierarchy. 454# undocumented classes that are normally visible in the class hierarchy. If set
411# If set to NO (the default) these classes will be included in the various 455# to NO these classes will be included in the various overviews. This option has
412# overviews. This option has no effect if EXTRACT_ALL is enabled. 456# no effect if EXTRACT_ALL is enabled.
457# The default value is: NO.
413 458
414HIDE_UNDOC_CLASSES = NO 459HIDE_UNDOC_CLASSES = NO
415 460
416# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 461# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
417# friend (class|struct|union) declarations. 462# (class|struct|union) declarations. If set to NO these declarations will be
418# If set to NO (the default) these declarations will be included in the 463# included in the documentation.
419# documentation. 464# The default value is: NO.
420 465
421HIDE_FRIEND_COMPOUNDS = NO 466HIDE_FRIEND_COMPOUNDS = NO
422 467
423# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 468# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
424# documentation blocks found inside the body of a function. 469# documentation blocks found inside the body of a function. If set to NO these
425# If set to NO (the default) these blocks will be appended to the 470# blocks will be appended to the function's detailed documentation block.
426# function's detailed documentation block. 471# The default value is: NO.
427 472
428HIDE_IN_BODY_DOCS = NO 473HIDE_IN_BODY_DOCS = NO
429 474
430# The INTERNAL_DOCS tag determines if documentation 475# The INTERNAL_DOCS tag determines if documentation that is typed after a
431# that is typed after a \internal command is included. If the tag is set 476# \internal command is included. If the tag is set to NO then the documentation
432# to NO (the default) then the documentation will be excluded. 477# will be excluded. Set it to YES to include the internal documentation.
433# Set it to YES to include the internal documentation. 478# The default value is: NO.
434 479
435INTERNAL_DOCS = NO 480INTERNAL_DOCS = NO
436 481
437# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 482# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
438# file names in lower-case letters. If set to YES upper-case letters are also 483# names in lower-case letters. If set to YES upper-case letters are also
439# allowed. This is useful if you have classes or files whose names only differ 484# allowed. This is useful if you have classes or files whose names only differ
440# in case and if your file system supports case sensitive file names. Windows 485# in case and if your file system supports case sensitive file names. Windows
441# and Mac users are advised to set this option to NO. 486# and Mac users are advised to set this option to NO.
487# The default value is: system dependent.
442 488
443CASE_SENSE_NAMES = YES 489CASE_SENSE_NAMES = YES
444 490
445# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 491# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
446# will show members with their full class and namespace scopes in the 492# their full class and namespace scopes in the documentation. If set to YES the
447# documentation. If set to YES the scope will be hidden. 493# scope will be hidden.
494# The default value is: NO.
448 495
449HIDE_SCOPE_NAMES = NO 496HIDE_SCOPE_NAMES = NO
450 497
451# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 498# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
452# will put a list of the files that are included by a file in the documentation 499# the files that are included by a file in the documentation of that file.
453# of that file. 500# The default value is: YES.
454 501
455SHOW_INCLUDE_FILES = NO 502SHOW_INCLUDE_FILES = NO
456 503
457# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 504# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
458# will list include files with double quotes in the documentation 505# files with double quotes in the documentation rather than with sharp brackets.
459# rather than with sharp brackets. 506# The default value is: NO.
460 507
461FORCE_LOCAL_INCLUDES = NO 508FORCE_LOCAL_INCLUDES = NO
462 509
463# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 510# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
464# is inserted in the documentation for inline members. 511# documentation for inline members.
512# The default value is: YES.
465 513
466INLINE_INFO = YES 514INLINE_INFO = YES
467 515
468# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 516# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
469# will sort the (detailed) documentation of file and class members 517# (detailed) documentation of file and class members alphabetically by member
470# alphabetically by member name. If set to NO the members will appear in 518# name. If set to NO the members will appear in declaration order.
471# declaration order. 519# The default value is: YES.
472 520
473SORT_MEMBER_DOCS = NO 521SORT_MEMBER_DOCS = NO
474 522
475# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 523# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
476# brief documentation of file, namespace and class members alphabetically 524# descriptions of file, namespace and class members alphabetically by member
477# by member name. If set to NO (the default) the members will appear in 525# name. If set to NO the members will appear in declaration order.
478# declaration order. 526# The default value is: NO.
479 527
480SORT_BRIEF_DOCS = NO 528SORT_BRIEF_DOCS = NO
481 529
482# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 530# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
483# will sort the (brief and detailed) documentation of class members so that 531# (brief and detailed) documentation of class members so that constructors and
484# constructors and destructors are listed first. If set to NO (the default) 532# destructors are listed first. If set to NO the constructors will appear in the
485# the constructors will appear in the respective orders defined by 533# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
486# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 534# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
487# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 535# member documentation.
488# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 536# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
537# detailed member documentation.
538# The default value is: NO.
489 539
490SORT_MEMBERS_CTORS_1ST = NO 540SORT_MEMBERS_CTORS_1ST = NO
491 541
492# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 542# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
493# hierarchy of group names into alphabetical order. If set to NO (the default) 543# of group names into alphabetical order. If set to NO the group names will
494# the group names will appear in their defined order. 544# appear in their defined order.
545# The default value is: NO.
495 546
496SORT_GROUP_NAMES = NO 547SORT_GROUP_NAMES = NO
497 548
498# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 549# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
499# sorted by fully-qualified names, including namespaces. If set to 550# fully-qualified names, including namespaces. If set to NO, the class list will
500# NO (the default), the class list will be sorted only by class name, 551# be sorted only by class name, not including the namespace part.
501# not including the namespace part.
502# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 552# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
503# Note: This option applies only to the class list, not to the 553# Note: This option applies only to the class list, not to the alphabetical
504# alphabetical list. 554# list.
555# The default value is: NO.
505 556
506SORT_BY_SCOPE_NAME = NO 557SORT_BY_SCOPE_NAME = NO
507 558
508# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 559# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
509# do proper type resolution of all parameters of a function it will reject a 560# type resolution of all parameters of a function it will reject a match between
510# match between the prototype and the implementation of a member function even 561# the prototype and the implementation of a member function even if there is
511# if there is only one candidate or it is obvious which candidate to choose 562# only one candidate or it is obvious which candidate to choose by doing a
512# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 563# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
513# will still accept a match between prototype and implementation in such cases. 564# accept a match between prototype and implementation in such cases.
565# The default value is: NO.
514 566
515STRICT_PROTO_MATCHING = NO 567STRICT_PROTO_MATCHING = NO
516 568
517# The GENERATE_TODOLIST tag can be used to enable (YES) or 569# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
518# disable (NO) the todo list. This list is created by putting \todo 570# todo list. This list is created by putting \todo commands in the
519# commands in the documentation. 571# documentation.
572# The default value is: YES.
520 573
521GENERATE_TODOLIST = YES 574GENERATE_TODOLIST = YES
522 575
523# The GENERATE_TESTLIST tag can be used to enable (YES) or 576# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
524# disable (NO) the test list. This list is created by putting \test 577# test list. This list is created by putting \test commands in the
525# commands in the documentation. 578# documentation.
579# The default value is: YES.
526 580
527GENERATE_TESTLIST = YES 581GENERATE_TESTLIST = YES
528 582
529# The GENERATE_BUGLIST tag can be used to enable (YES) or 583# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
530# disable (NO) the bug list. This list is created by putting \bug 584# list. This list is created by putting \bug commands in the documentation.
531# commands in the documentation. 585# The default value is: YES.
532 586
533GENERATE_BUGLIST = YES 587GENERATE_BUGLIST = YES
534 588
535# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 589# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
536# disable (NO) the deprecated list. This list is created by putting 590# the deprecated list. This list is created by putting \deprecated commands in
537# \deprecated commands in the documentation. 591# the documentation.
592# The default value is: YES.
538 593
539GENERATE_DEPRECATEDLIST= YES 594GENERATE_DEPRECATEDLIST= YES
540 595
541# The ENABLED_SECTIONS tag can be used to enable conditional 596# The ENABLED_SECTIONS tag can be used to enable conditional documentation
542# documentation sections, marked by \if sectionname ... \endif. 597# sections, marked by \if <section_label> ... \endif and \cond <section_label>
598# ... \endcond blocks.
543 599
544ENABLED_SECTIONS = 600ENABLED_SECTIONS =
545 601
546# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 602# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
547# the initial value of a variable or macro consists of for it to appear in 603# initial value of a variable or macro / define can have for it to appear in the
548# the documentation. If the initializer consists of more lines than specified 604# documentation. If the initializer consists of more lines than specified here
549# here it will be hidden. Use a value of 0 to hide initializers completely. 605# it will be hidden. Use a value of 0 to hide initializers completely. The
550# The appearance of the initializer of individual variables and macros in the 606# appearance of the value of individual variables and macros / defines can be
551# documentation can be controlled using \showinitializer or \hideinitializer 607# controlled using \showinitializer or \hideinitializer command in the
552# command in the documentation regardless of this setting. 608# documentation regardless of this setting.
609# Minimum value: 0, maximum value: 10000, default value: 30.
553 610
554MAX_INITIALIZER_LINES = 30 611MAX_INITIALIZER_LINES = 30
555 612
556# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 613# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
557# at the bottom of the documentation of classes and structs. If set to YES the 614# the bottom of the documentation of classes and structs. If set to YES the list
558# list will mention the files that were used to generate the documentation. 615# will mention the files that were used to generate the documentation.
616# The default value is: YES.
559 617
560SHOW_USED_FILES = NO 618SHOW_USED_FILES = NO
561 619
562# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 620# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
563# This will remove the Files entry from the Quick Index and from the 621# will remove the Files entry from the Quick Index and from the Folder Tree View
564# Folder Tree View (if specified). The default is YES. 622# (if specified).
623# The default value is: YES.
565 624
566SHOW_FILES = YES 625SHOW_FILES = YES
567 626
568# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 627# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
569# Namespaces page. 628# page. This will remove the Namespaces entry from the Quick Index and from the
570# This will remove the Namespaces entry from the Quick Index 629# Folder Tree View (if specified).
571# and from the Folder Tree View (if specified). The default is YES. 630# The default value is: YES.
572 631
573SHOW_NAMESPACES = YES 632SHOW_NAMESPACES = YES
574 633
575# The FILE_VERSION_FILTER tag can be used to specify a program or script that 634# The FILE_VERSION_FILTER tag can be used to specify a program or script that
576# doxygen should invoke to get the current version for each file (typically from 635# doxygen should invoke to get the current version for each file (typically from
577# the version control system). Doxygen will invoke the program by executing (via 636# the version control system). Doxygen will invoke the program by executing (via
578# popen()) the command <command> <input-file>, where <command> is the value of 637# popen()) the command command input-file, where command is the value of the
579# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 638# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
580# provided by doxygen. Whatever the program writes to standard output 639# by doxygen. Whatever the program writes to standard output is used as the file
581# is used as the file version. See the manual for examples. 640# version. For an example see the documentation.
582 641
583FILE_VERSION_FILTER = 642FILE_VERSION_FILTER =
584 643
585# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 644# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
586# by doxygen. The layout file controls the global structure of the generated 645# by doxygen. The layout file controls the global structure of the generated
587# output files in an output format independent way. To create the layout file 646# output files in an output format independent way. To create the layout file
588# that represents doxygen's defaults, run doxygen with the -l option. 647# that represents doxygen's defaults, run doxygen with the -l option. You can
589# You can optionally specify a file name after the option, if omitted 648# optionally specify a file name after the option, if omitted DoxygenLayout.xml
590# DoxygenLayout.xml will be used as the name of the layout file. 649# will be used as the name of the layout file.
650#
651# Note that if you run doxygen from a directory containing a file called
652# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
653# tag is left empty.
591 654
592LAYOUT_FILE = 655LAYOUT_FILE =
593 656
594# The CITE_BIB_FILES tag can be used to specify one or more bib files 657# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
595# containing the references data. This must be a list of .bib files. The 658# the reference definitions. This must be a list of .bib files. The .bib
596# .bib extension is automatically appended if omitted. Using this command 659# extension is automatically appended if omitted. This requires the bibtex tool
597# requires the bibtex tool to be installed. See also 660# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
598# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 661# For LaTeX the style of the bibliography can be controlled using
599# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 662# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
600# feature you need bibtex and perl available in the search path. 663# search path. Do not use file names with spaces, bibtex cannot handle them. See
664# also \cite for info how to create references.
601 665
602CITE_BIB_FILES = 666CITE_BIB_FILES =
603 667
604#--------------------------------------------------------------------------- 668#---------------------------------------------------------------------------
605# configuration options related to warning and progress messages 669# Configuration options related to warning and progress messages
606#--------------------------------------------------------------------------- 670#---------------------------------------------------------------------------
607 671
608# The QUIET tag can be used to turn on/off the messages that are generated 672# The QUIET tag can be used to turn on/off the messages that are generated to
609# by doxygen. Possible values are YES and NO. If left blank NO is used. 673# standard output by doxygen. If QUIET is set to YES this implies that the
674# messages are off.
675# The default value is: NO.
610 676
611QUIET = NO 677QUIET = NO
612 678
613# The WARNINGS tag can be used to turn on/off the warning messages that are 679# The WARNINGS tag can be used to turn on/off the warning messages that are
614# generated by doxygen. Possible values are YES and NO. If left blank 680# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
615# NO is used. 681# this implies that the warnings are on.
682#
683# Tip: Turn warnings on while writing the documentation.
684# The default value is: YES.
616 685
617WARNINGS = YES 686WARNINGS = YES
618 687
619# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 688# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
620# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 689# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
621# automatically be disabled. 690# will automatically be disabled.
691# The default value is: YES.
622 692
623WARN_IF_UNDOCUMENTED = YES 693WARN_IF_UNDOCUMENTED = YES
624 694
625# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 695# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
626# potential errors in the documentation, such as not documenting some 696# potential errors in the documentation, such as not documenting some parameters
627# parameters in a documented function, or documenting parameters that 697# in a documented function, or documenting parameters that don't exist or using
628# don't exist or using markup commands wrongly. 698# markup commands wrongly.
699# The default value is: YES.
629 700
630WARN_IF_DOC_ERROR = YES 701WARN_IF_DOC_ERROR = YES
631 702
632# The WARN_NO_PARAMDOC option can be enabled to get warnings for 703# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
633# functions that are documented, but have no documentation for their parameters 704# are documented, but have no documentation for their parameters or return
634# or return value. If set to NO (the default) doxygen will only warn about 705# value. If set to NO doxygen will only warn about wrong or incomplete parameter
635# wrong or incomplete parameter documentation, but not about the absence of 706# documentation, but not about the absence of documentation.
636# documentation. 707# The default value is: NO.
637 708
638WARN_NO_PARAMDOC = YES 709WARN_NO_PARAMDOC = YES
639 710
640# The WARN_FORMAT tag determines the format of the warning messages that 711# The WARN_FORMAT tag determines the format of the warning messages that doxygen
641# doxygen can produce. The string should contain the $file, $line, and $text 712# can produce. The string should contain the $file, $line, and $text tags, which
642# tags, which will be replaced by the file and line number from which the 713# will be replaced by the file and line number from which the warning originated
643# warning originated and the warning text. Optionally the format may contain 714# and the warning text. Optionally the format may contain $version, which will
644# $version, which will be replaced by the version of the file (if it could 715# be replaced by the version of the file (if it could be obtained via
645# be obtained via FILE_VERSION_FILTER) 716# FILE_VERSION_FILTER)
717# The default value is: $file:$line: $text.
646 718
647WARN_FORMAT = "$file:$line: $text" 719WARN_FORMAT = "$file:$line: $text"
648 720
649# The WARN_LOGFILE tag can be used to specify a file to which warning 721# The WARN_LOGFILE tag can be used to specify a file to which warning and error
650# and error messages should be written. If left blank the output is written 722# messages should be written. If left blank the output is written to standard
651# to stderr. 723# error (stderr).
652 724
653WARN_LOGFILE = 725WARN_LOGFILE =
654 726
655#--------------------------------------------------------------------------- 727#---------------------------------------------------------------------------
656# configuration options related to the input files 728# Configuration options related to the input files
657#--------------------------------------------------------------------------- 729#---------------------------------------------------------------------------
658 730
659# The INPUT tag can be used to specify the files and/or directories that contain 731# The INPUT tag is used to specify the files and/or directories that contain
660# documented source files. You may enter file names like "myfile.cpp" or 732# documented source files. You may enter file names like myfile.cpp or
661# directories like "/usr/src/myproject". Separate the files or directories 733# directories like /usr/src/myproject. Separate the files or directories with
662# with spaces. 734# spaces.
735# Note: If this tag is empty the current directory is searched.
663 736
664INPUT = ../src/bin/ \ 737INPUT = ../src/bin/ \
665 ../src/lib/ \ 738 ../src/lib/ \
@@ -667,34 +740,37 @@ INPUT = ../src/bin/ \
667 smman.dox 740 smman.dox
668 741
669# This tag can be used to specify the character encoding of the source files 742# This tag can be used to specify the character encoding of the source files
670# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 743# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
671# also the default input encoding. Doxygen uses libiconv (or the iconv built 744# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
672# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 745# documentation (see: http://www.gnu.org/software/libiconv) for the list of
673# the list of possible encodings. 746# possible encodings.
747# The default value is: UTF-8.
674 748
675INPUT_ENCODING = UTF-8 749INPUT_ENCODING = UTF-8
676 750
677# If the value of the INPUT tag contains directories, you can use the 751# If the value of the INPUT tag contains directories, you can use the
678# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 752# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
679# and *.h) to filter out the source-files in the directories. If left 753# *.h) to filter out the source-files in the directories. If left blank the
680# blank the following patterns are tested: 754# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
681# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 755# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
682# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 756# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
683# *.f90 *.f *.for *.vhd *.vhdl 757# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
758# *.qsf, *.as and *.js.
684 759
685FILE_PATTERNS = *.c \ 760FILE_PATTERNS = *.c \
686 *.h \ 761 *.h \
687 *.x 762 *.x
688 763
689# The RECURSIVE tag can be used to turn specify whether or not subdirectories 764# The RECURSIVE tag can be used to specify whether or not subdirectories should
690# should be searched for input files as well. Possible values are YES and NO. 765# be searched for input files as well.
691# If left blank NO is used. 766# The default value is: NO.
692 767
693RECURSIVE = YES 768RECURSIVE = YES
694 769
695# The EXCLUDE tag can be used to specify files and/or directories that should be 770# The EXCLUDE tag can be used to specify files and/or directories that should be
696# excluded from the INPUT source files. This way you can easily exclude a 771# excluded from the INPUT source files. This way you can easily exclude a
697# subdirectory from a directory tree whose root is specified with the INPUT tag. 772# subdirectory from a directory tree whose root is specified with the INPUT tag.
773#
698# Note that relative paths are relative to the directory from which doxygen is 774# Note that relative paths are relative to the directory from which doxygen is
699# run. 775# run.
700 776
@@ -703,14 +779,16 @@ EXCLUDE =
703# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 779# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
704# directories that are symbolic links (a Unix file system feature) are excluded 780# directories that are symbolic links (a Unix file system feature) are excluded
705# from the input. 781# from the input.
782# The default value is: NO.
706 783
707EXCLUDE_SYMLINKS = NO 784EXCLUDE_SYMLINKS = NO
708 785
709# If the value of the INPUT tag contains directories, you can use the 786# If the value of the INPUT tag contains directories, you can use the
710# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 787# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
711# certain files from those directories. Note that the wildcards are matched 788# certain files from those directories.
712# against the file with absolute path, so to exclude all test directories 789#
713# for example use the pattern */test/* 790# Note that the wildcards are matched against the file with absolute path, so to
791# exclude all test directories for example use the pattern */test/*
714 792
715EXCLUDE_PATTERNS = 793EXCLUDE_PATTERNS =
716 794
@@ -719,766 +797,1080 @@ EXCLUDE_PATTERNS =
719# output. The symbol name can be a fully qualified name, a word, or if the 797# output. The symbol name can be a fully qualified name, a word, or if the
720# wildcard * is used, a substring. Examples: ANamespace, AClass, 798# wildcard * is used, a substring. Examples: ANamespace, AClass,
721# AClass::ANamespace, ANamespace::*Test 799# AClass::ANamespace, ANamespace::*Test
800#
801# Note that the wildcards are matched against the file with absolute path, so to
802# exclude all test directories use the pattern */test/*
722 803
723EXCLUDE_SYMBOLS = 804EXCLUDE_SYMBOLS =
724 805
725# The EXAMPLE_PATH tag can be used to specify one or more files or 806# The EXAMPLE_PATH tag can be used to specify one or more files or directories
726# directories that contain example code fragments that are included (see 807# that contain example code fragments that are included (see the \include
727# the \include command). 808# command).
728 809
729EXAMPLE_PATH = 810EXAMPLE_PATH =
730 811
731# If the value of the EXAMPLE_PATH tag contains directories, you can use the 812# If the value of the EXAMPLE_PATH tag contains directories, you can use the
732# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 813# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
733# and *.h) to filter out the source-files in the directories. If left 814# *.h) to filter out the source-files in the directories. If left blank all
734# blank all files are included. 815# files are included.
735 816
736EXAMPLE_PATTERNS = 817EXAMPLE_PATTERNS =
737 818
738# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 819# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
739# searched for input files to be used with the \include or \dontinclude 820# searched for input files to be used with the \include or \dontinclude commands
740# commands irrespective of the value of the RECURSIVE tag. 821# irrespective of the value of the RECURSIVE tag.
741# Possible values are YES and NO. If left blank NO is used. 822# The default value is: NO.
742 823
743EXAMPLE_RECURSIVE = NO 824EXAMPLE_RECURSIVE = NO
744 825
745# The IMAGE_PATH tag can be used to specify one or more files or 826# The IMAGE_PATH tag can be used to specify one or more files or directories
746# directories that contain image that are included in the documentation (see 827# that contain images that are to be included in the documentation (see the
747# the \image command). 828# \image command).
748 829
749IMAGE_PATH = doc/img \ 830IMAGE_PATH = doxygen/data/img/
750 doc/benchmark
751 831
752# The INPUT_FILTER tag can be used to specify a program that doxygen should 832# The INPUT_FILTER tag can be used to specify a program that doxygen should
753# invoke to filter for each input file. Doxygen will invoke the filter program 833# invoke to filter for each input file. Doxygen will invoke the filter program
754# by executing (via popen()) the command <filter> <input-file>, where <filter> 834# by executing (via popen()) the command:
755# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 835#
756# input file. Doxygen will then use the output that the filter program writes 836# <filter> <input-file>
757# to standard output. 837#
758# If FILTER_PATTERNS is specified, this tag will be 838# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
759# ignored. 839# name of an input file. Doxygen will then use the output that the filter
840# program writes to standard output. If FILTER_PATTERNS is specified, this tag
841# will be ignored.
842#
843# Note that the filter must not add or remove lines; it is applied before the
844# code is scanned, but not when the output code is generated. If lines are added
845# or removed, the anchors will not be placed correctly.
760 846
761INPUT_FILTER = 847INPUT_FILTER =
762 848
763# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 849# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
764# basis. 850# basis. Doxygen will compare the file name with each pattern and apply the
765# Doxygen will compare the file name with each pattern and apply the 851# filter if there is a match. The filters are a list of the form: pattern=filter
766# filter if there is a match. 852# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
767# The filters are a list of the form: 853# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
768# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 854# patterns match the file name, INPUT_FILTER is applied.
769# info on how filters are used. If FILTER_PATTERNS is empty or if
770# non of the patterns match the file name, INPUT_FILTER is applied.
771 855
772FILTER_PATTERNS = 856FILTER_PATTERNS =
773 857
774# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 858# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
775# INPUT_FILTER) will be used to filter the input files when producing source 859# INPUT_FILTER ) will also be used to filter the input files that are used for
776# files to browse (i.e. when SOURCE_BROWSER is set to YES). 860# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
861# The default value is: NO.
777 862
778FILTER_SOURCE_FILES = NO 863FILTER_SOURCE_FILES = NO
779 864
780# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 865# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
781# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 866# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
782# and it is also possible to disable source filtering for a specific pattern 867# it is also possible to disable source filtering for a specific pattern using
783# using *.ext= (so without naming a filter). This option only has effect when 868# *.ext= (so without naming a filter).
784# FILTER_SOURCE_FILES is enabled. 869# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
785 870
786FILTER_SOURCE_PATTERNS = 871FILTER_SOURCE_PATTERNS =
787 872
873# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
874# is part of the input, its contents will be placed on the main page
875# (index.html). This can be useful if you have a project on for instance GitHub
876# and want to reuse the introduction page also for the doxygen output.
877
878USE_MDFILE_AS_MAINPAGE =
879
788#--------------------------------------------------------------------------- 880#---------------------------------------------------------------------------
789# configuration options related to source browsing 881# Configuration options related to source browsing
790#--------------------------------------------------------------------------- 882#---------------------------------------------------------------------------
791 883
792# If the SOURCE_BROWSER tag is set to YES then a list of source files will 884# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
793# be generated. Documented entities will be cross-referenced with these sources. 885# generated. Documented entities will be cross-referenced with these sources.
794# Note: To get rid of all source code in the generated output, make sure also 886#
795# VERBATIM_HEADERS is set to NO. 887# Note: To get rid of all source code in the generated output, make sure that
888# also VERBATIM_HEADERS is set to NO.
889# The default value is: NO.
796 890
797SOURCE_BROWSER = NO 891SOURCE_BROWSER = NO
798 892
799# Setting the INLINE_SOURCES tag to YES will include the body 893# Setting the INLINE_SOURCES tag to YES will include the body of functions,
800# of functions and classes directly in the documentation. 894# classes and enums directly into the documentation.
895# The default value is: NO.
801 896
802INLINE_SOURCES = NO 897INLINE_SOURCES = NO
803 898
804# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 899# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
805# doxygen to hide any special comment blocks from generated source code 900# special comment blocks from generated source code fragments. Normal C, C++ and
806# fragments. Normal C, C++ and Fortran comments will always remain visible. 901# Fortran comments will always remain visible.
902# The default value is: YES.
807 903
808STRIP_CODE_COMMENTS = YES 904STRIP_CODE_COMMENTS = YES
809 905
810# If the REFERENCED_BY_RELATION tag is set to YES 906# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
811# then for each documented function all documented 907# function all documented functions referencing it will be listed.
812# functions referencing it will be listed. 908# The default value is: NO.
813 909
814REFERENCED_BY_RELATION = YES 910REFERENCED_BY_RELATION = YES
815 911
816# If the REFERENCES_RELATION tag is set to YES 912# If the REFERENCES_RELATION tag is set to YES then for each documented function
817# then for each documented function all documented entities 913# all documented entities called/used by that function will be listed.
818# called/used by that function will be listed. 914# The default value is: NO.
819 915
820REFERENCES_RELATION = YES 916REFERENCES_RELATION = YES
821 917
822# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 918# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
823# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 919# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
824# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 920# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
825# link to the source code. 921# link to the documentation.
826# Otherwise they will link to the documentation. 922# The default value is: YES.
827 923
828REFERENCES_LINK_SOURCE = YES 924REFERENCES_LINK_SOURCE = YES
829 925
830# If the USE_HTAGS tag is set to YES then the references to source code 926# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
831# will point to the HTML generated by the htags(1) tool instead of doxygen 927# source code will show a tooltip with additional information such as prototype,
832# built-in source browser. The htags tool is part of GNU's global source 928# brief description and links to the definition and documentation. Since this
833# tagging system (see http://www.gnu.org/software/global/global.html). You 929# will make the HTML file larger and loading of large files a bit slower, you
834# will need version 4.8.6 or higher. 930# can opt to disable this feature.
931# The default value is: YES.
932# This tag requires that the tag SOURCE_BROWSER is set to YES.
933
934SOURCE_TOOLTIPS = YES
935
936# If the USE_HTAGS tag is set to YES then the references to source code will
937# point to the HTML generated by the htags(1) tool instead of doxygen built-in
938# source browser. The htags tool is part of GNU's global source tagging system
939# (see http://www.gnu.org/software/global/global.html). You will need version
940# 4.8.6 or higher.
941#
942# To use it do the following:
943# - Install the latest version of global
944# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
945# - Make sure the INPUT points to the root of the source tree
946# - Run doxygen as normal
947#
948# Doxygen will invoke htags (and that will in turn invoke gtags), so these
949# tools must be available from the command line (i.e. in the search path).
950#
951# The result: instead of the source browser generated by doxygen, the links to
952# source code will now point to the output of htags.
953# The default value is: NO.
954# This tag requires that the tag SOURCE_BROWSER is set to YES.
835 955
836USE_HTAGS = NO 956USE_HTAGS = NO
837 957
838# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 958# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
839# will generate a verbatim copy of the header file for each class for 959# verbatim copy of the header file for each class for which an include is
840# which an include is specified. Set to NO to disable this. 960# specified. Set to NO to disable this.
961# See also: Section \class.
962# The default value is: YES.
841 963
842VERBATIM_HEADERS = NO 964VERBATIM_HEADERS = NO
843 965
844#--------------------------------------------------------------------------- 966#---------------------------------------------------------------------------
845# configuration options related to the alphabetical class index 967# Configuration options related to the alphabetical class index
846#--------------------------------------------------------------------------- 968#---------------------------------------------------------------------------
847 969
848# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 970# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
849# of all compounds will be generated. Enable this if the project 971# compounds will be generated. Enable this if the project contains a lot of
850# contains a lot of classes, structs, unions or interfaces. 972# classes, structs, unions or interfaces.
973# The default value is: YES.
851 974
852ALPHABETICAL_INDEX = YES 975ALPHABETICAL_INDEX = YES
853 976
854# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 977# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
855# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 978# which the alphabetical index list will be split.
856# in which this list will be split (can be a number in the range [1..20]) 979# Minimum value: 1, maximum value: 20, default value: 5.
980# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
857 981
858COLS_IN_ALPHA_INDEX = 2 982COLS_IN_ALPHA_INDEX = 2
859 983
860# In case all classes in a project start with a common prefix, all 984# In case all classes in a project start with a common prefix, all classes will
861# classes will be put under the same header in the alphabetical index. 985# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
862# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 986# can be used to specify a prefix (or a list of prefixes) that should be ignored
863# should be ignored while generating the index headers. 987# while generating the index headers.
988# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
864 989
865IGNORE_PREFIX = 990IGNORE_PREFIX =
866 991
867#--------------------------------------------------------------------------- 992#---------------------------------------------------------------------------
868# configuration options related to the HTML output 993# Configuration options related to the HTML output
869#--------------------------------------------------------------------------- 994#---------------------------------------------------------------------------
870 995
871# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 996# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
872# generate HTML output. 997# The default value is: YES.
873 998
874GENERATE_HTML = YES 999GENERATE_HTML = YES
875 1000
876# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 1001# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
877# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1002# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
878# put in front of it. If left blank `html' will be used as the default path. 1003# it.
1004# The default directory is: html.
1005# This tag requires that the tag GENERATE_HTML is set to YES.
879 1006
880HTML_OUTPUT = html 1007HTML_OUTPUT = html
881 1008
882# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 1009# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
883# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 1010# generated HTML page (for example: .htm, .php, .asp).
884# doxygen will generate files with .html extension. 1011# The default value is: .html.
1012# This tag requires that the tag GENERATE_HTML is set to YES.
885 1013
886HTML_FILE_EXTENSION = .html 1014HTML_FILE_EXTENSION = .html
887 1015
888# The HTML_HEADER tag can be used to specify a personal HTML header for 1016# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
889# each generated HTML page. If it is left blank doxygen will generate a 1017# each generated HTML page. If the tag is left blank doxygen will generate a
890# standard header. Note that when using a custom header you are responsible 1018# standard header.
891# for the proper inclusion of any scripts and style sheets that doxygen 1019#
892# needs, which is dependent on the configuration options used. 1020# To get valid HTML the header file that includes any scripts and style sheets
893# It is advised to generate a default header using "doxygen -w html 1021# that doxygen needs, which is dependent on the configuration options used (e.g.
894# header.html footer.html stylesheet.css YourConfigFile" and then modify 1022# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
895# that header. Note that the header is subject to change so you typically 1023# default header using
896# have to redo this when upgrading to a newer version of doxygen or when 1024# doxygen -w html new_header.html new_footer.html new_stylesheet.css
897# changing the value of configuration settings such as GENERATE_TREEVIEW! 1025# YourConfigFile
1026# and then modify the file new_header.html. See also section "Doxygen usage"
1027# for information on how to generate the default header that doxygen normally
1028# uses.
1029# Note: The header is subject to change so you typically have to regenerate the
1030# default header when upgrading to a newer version of doxygen. For a description
1031# of the possible markers and block names see the documentation.
1032# This tag requires that the tag GENERATE_HTML is set to YES.
898 1033
899HTML_HEADER = doxygen/data/head.html 1034HTML_HEADER = doxygen/data/head.html
900 1035
901# The HTML_FOOTER tag can be used to specify a personal HTML footer for 1036# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
902# each generated HTML page. If it is left blank doxygen will generate a 1037# generated HTML page. If the tag is left blank doxygen will generate a standard
903# standard footer. 1038# footer. See HTML_HEADER for more information on how to generate a default
1039# footer and what special commands can be used inside the footer. See also
1040# section "Doxygen usage" for information on how to generate the default footer
1041# that doxygen normally uses.
1042# This tag requires that the tag GENERATE_HTML is set to YES.
904 1043
905HTML_FOOTER = doxygen/data/foot.html 1044HTML_FOOTER = doxygen/data/foot.html
906 1045
907# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 1046# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
908# style sheet that is used by each HTML page. It can be used to 1047# sheet that is used by each HTML page. It can be used to fine-tune the look of
909# fine-tune the look of the HTML output. If left blank doxygen will 1048# the HTML output. If left blank doxygen will generate a default style sheet.
910# generate a default style sheet. Note that it is recommended to use 1049# See also section "Doxygen usage" for information on how to generate the style
911# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 1050# sheet that doxygen normally uses.
912# tag will in the future become obsolete. 1051# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
913 1052# it is more robust and this tag (HTML_STYLESHEET) will in the future become
914HTML_STYLESHEET = doxygen/data/css/style.css 1053# obsolete.
915 1054# This tag requires that the tag GENERATE_HTML is set to YES.
916# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 1055
917# user-defined cascading style sheet that is included after the standard 1056#HTML_STYLESHEET =
918# style sheets created by doxygen. Using this option one can overrule 1057
919# certain style aspects. This is preferred over using HTML_STYLESHEET 1058# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
920# since it does not replace the standard style sheet and is therefor more 1059# defined cascading style sheet that is included after the standard style sheets
921# robust against future updates. Doxygen will copy the style sheet file to 1060# created by doxygen. Using this option one can overrule certain style aspects.
922# the output directory. 1061# This is preferred over using HTML_STYLESHEET since it does not replace the
923 1062# standard style sheet and is therefor more robust against future updates.
924HTML_EXTRA_STYLESHEET = 1063# Doxygen will copy the style sheet file to the output directory. For an example
1064# see the documentation.
1065# This tag requires that the tag GENERATE_HTML is set to YES.
1066
1067HTML_EXTRA_STYLESHEET = doxygen/data/css/a.css
925 1068
926# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1069# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
927# other source files which should be copied to the HTML output directory. Note 1070# other source files which should be copied to the HTML output directory. Note
928# that these files will be copied to the base HTML output directory. Use the 1071# that these files will be copied to the base HTML output directory. Use the
929# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1072# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
930# files. In the HTML_STYLESHEET file, use the file name only. Also note that 1073# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
931# the files will be copied as-is; there are no commands or markers available. 1074# files will be copied as-is; there are no commands or markers available.
1075# This tag requires that the tag GENERATE_HTML is set to YES.
932 1076
933HTML_EXTRA_FILES = 1077HTML_EXTRA_FILES =
934 1078
935# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 1079# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
936# Doxygen will adjust the colors in the style sheet and background images 1080# will adjust the colors in the stylesheet and background images according to
937# according to this color. Hue is specified as an angle on a colorwheel, 1081# this color. Hue is specified as an angle on a colorwheel, see
938# see http://en.wikipedia.org/wiki/Hue for more information. 1082# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
939# For instance the value 0 represents red, 60 is yellow, 120 is green, 1083# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
940# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 1084# purple, and 360 is red again.
941# The allowed range is 0 to 359. 1085# Minimum value: 0, maximum value: 359, default value: 220.
1086# This tag requires that the tag GENERATE_HTML is set to YES.
942 1087
943HTML_COLORSTYLE_HUE = 220 1088HTML_COLORSTYLE_HUE = 220
944 1089
945# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 1090# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
946# the colors in the HTML output. For a value of 0 the output will use 1091# in the HTML output. For a value of 0 the output will use grayscales only. A
947# grayscales only. A value of 255 will produce the most vivid colors. 1092# value of 255 will produce the most vivid colors.
1093# Minimum value: 0, maximum value: 255, default value: 100.
1094# This tag requires that the tag GENERATE_HTML is set to YES.
948 1095
949HTML_COLORSTYLE_SAT = 100 1096HTML_COLORSTYLE_SAT = 100
950 1097
951# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 1098# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
952# the luminance component of the colors in the HTML output. Values below 1099# luminance component of the colors in the HTML output. Values below 100
953# 100 gradually make the output lighter, whereas values above 100 make 1100# gradually make the output lighter, whereas values above 100 make the output
954# the output darker. The value divided by 100 is the actual gamma applied, 1101# darker. The value divided by 100 is the actual gamma applied, so 80 represents
955# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 1102# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
956# and 100 does not change the gamma. 1103# change the gamma.
1104# Minimum value: 40, maximum value: 240, default value: 80.
1105# This tag requires that the tag GENERATE_HTML is set to YES.
957 1106
958HTML_COLORSTYLE_GAMMA = 80 1107HTML_COLORSTYLE_GAMMA = 80
959 1108
960# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1109# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
961# page will contain the date and time when the page was generated. Setting 1110# page will contain the date and time when the page was generated. Setting this
962# this to NO can help when comparing the output of multiple runs. 1111# to NO can help when comparing the output of multiple runs.
1112# The default value is: YES.
1113# This tag requires that the tag GENERATE_HTML is set to YES.
963 1114
964HTML_TIMESTAMP = YES 1115HTML_TIMESTAMP = YES
965 1116
966# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1117# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
967# documentation will contain sections that can be hidden and shown after the 1118# documentation will contain sections that can be hidden and shown after the
968# page has loaded. 1119# page has loaded.
1120# The default value is: NO.
1121# This tag requires that the tag GENERATE_HTML is set to YES.
969 1122
970HTML_DYNAMIC_SECTIONS = NO 1123HTML_DYNAMIC_SECTIONS = NO
971 1124
972# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 1125# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
973# entries shown in the various tree structured indices initially; the user 1126# shown in the various tree structured indices initially; the user can expand
974# can expand and collapse entries dynamically later on. Doxygen will expand 1127# and collapse entries dynamically later on. Doxygen will expand the tree to
975# the tree to such a level that at most the specified number of entries are 1128# such a level that at most the specified number of entries are visible (unless
976# visible (unless a fully collapsed tree already exceeds this amount). 1129# a fully collapsed tree already exceeds this amount). So setting the number of
977# So setting the number of entries 1 will produce a full collapsed tree by 1130# entries 1 will produce a full collapsed tree by default. 0 is a special value
978# default. 0 is a special value representing an infinite number of entries 1131# representing an infinite number of entries and will result in a full expanded
979# and will result in a full expanded tree by default. 1132# tree by default.
1133# Minimum value: 0, maximum value: 9999, default value: 100.
1134# This tag requires that the tag GENERATE_HTML is set to YES.
980 1135
981HTML_INDEX_NUM_ENTRIES = 100 1136HTML_INDEX_NUM_ENTRIES = 100
982 1137
983# If the GENERATE_DOCSET tag is set to YES, additional index files 1138# If the GENERATE_DOCSET tag is set to YES, additional index files will be
984# will be generated that can be used as input for Apple's Xcode 3 1139# generated that can be used as input for Apple's Xcode 3 integrated development
985# integrated development environment, introduced with OSX 10.5 (Leopard). 1140# environment (see: http://developer.apple.com/tools/xcode/), introduced with
986# To create a documentation set, doxygen will generate a Makefile in the 1141# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
987# HTML output directory. Running make will produce the docset in that 1142# Makefile in the HTML output directory. Running make will produce the docset in
988# directory and running "make install" will install the docset in 1143# that directory and running make install will install the docset in
989# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1144# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
990# it at startup. 1145# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
991# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
992# for more information. 1146# for more information.
1147# The default value is: NO.
1148# This tag requires that the tag GENERATE_HTML is set to YES.
993 1149
994GENERATE_DOCSET = NO 1150GENERATE_DOCSET = NO
995 1151
996# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1152# This tag determines the name of the docset feed. A documentation feed provides
997# feed. A documentation feed provides an umbrella under which multiple 1153# an umbrella under which multiple documentation sets from a single provider
998# documentation sets from a single provider (such as a company or product suite) 1154# (such as a company or product suite) can be grouped.
999# can be grouped. 1155# The default value is: Doxygen generated docs.
1156# This tag requires that the tag GENERATE_DOCSET is set to YES.
1000 1157
1001DOCSET_FEEDNAME = "Doxygen generated docs" 1158DOCSET_FEEDNAME = "Doxygen generated docs"
1002 1159
1003# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1160# This tag specifies a string that should uniquely identify the documentation
1004# should uniquely identify the documentation set bundle. This should be a 1161# set bundle. This should be a reverse domain-name style string, e.g.
1005# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1162# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1006# will append .docset to the name. 1163# The default value is: org.doxygen.Project.
1164# This tag requires that the tag GENERATE_DOCSET is set to YES.
1007 1165
1008DOCSET_BUNDLE_ID = com.asp64.corepack 1166DOCSET_BUNDLE_ID = com.asp64.corepack
1009 1167
1010# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1168# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1011# identify the documentation publisher. This should be a reverse domain-name 1169# the documentation publisher. This should be a reverse domain-name style
1012# style string, e.g. com.mycompany.MyDocSet.documentation. 1170# string, e.g. com.mycompany.MyDocSet.documentation.
1171# The default value is: org.doxygen.Publisher.
1172# This tag requires that the tag GENERATE_DOCSET is set to YES.
1013 1173
1014DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1174DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1015 1175
1016# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1176# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1177# The default value is: Publisher.
1178# This tag requires that the tag GENERATE_DOCSET is set to YES.
1017 1179
1018DOCSET_PUBLISHER_NAME = Publisher 1180DOCSET_PUBLISHER_NAME = Publisher
1019 1181
1020# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1182# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1021# will be generated that can be used as input for tools like the 1183# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1022# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1184# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1023# of the generated HTML documentation. 1185# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1186# Windows.
1187#
1188# The HTML Help Workshop contains a compiler that can convert all HTML output
1189# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1190# files are now used as the Windows 98 help format, and will replace the old
1191# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1192# HTML files also contain an index, a table of contents, and you can search for
1193# words in the documentation. The HTML workshop also contains a viewer for
1194# compressed HTML files.
1195# The default value is: NO.
1196# This tag requires that the tag GENERATE_HTML is set to YES.
1024 1197
1025GENERATE_HTMLHELP = NO 1198GENERATE_HTMLHELP = NO
1026 1199
1027# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1200# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1028# be used to specify the file name of the resulting .chm file. You 1201# file. You can add a path in front of the file if the result should not be
1029# can add a path in front of the file if the result should not be
1030# written to the html output directory. 1202# written to the html output directory.
1203# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1031 1204
1032CHM_FILE = 1205CHM_FILE =
1033 1206
1034# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1207# The HHC_LOCATION tag can be used to specify the location (absolute path
1035# be used to specify the location (absolute path including file name) of 1208# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1036# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1209# doxygen will try to run the HTML help compiler on the generated index.hhp.
1037# the HTML help compiler on the generated index.hhp. 1210# The file has to be specified with full path.
1211# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1038 1212
1039HHC_LOCATION = 1213HHC_LOCATION =
1040 1214
1041# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1215# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1042# controls if a separate .chi index file is generated (YES) or that 1216# YES) or that it should be included in the master .chm file ( NO).
1043# it should be included in the master .chm file (NO). 1217# The default value is: NO.
1218# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1044 1219
1045GENERATE_CHI = NO 1220GENERATE_CHI = NO
1046 1221
1047# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1222# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1048# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1223# and project file content.
1049# content. 1224# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1050 1225
1051CHM_INDEX_ENCODING = 1226CHM_INDEX_ENCODING =
1052 1227
1053# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1228# The BINARY_TOC flag controls whether a binary table of contents is generated (
1054# controls whether a binary table of contents is generated (YES) or a 1229# YES) or a normal table of contents ( NO) in the .chm file.
1055# normal table of contents (NO) in the .chm file. 1230# The default value is: NO.
1231# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1056 1232
1057BINARY_TOC = NO 1233BINARY_TOC = NO
1058 1234
1059# The TOC_EXPAND flag can be set to YES to add extra items for group members 1235# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1060# to the contents of the HTML help documentation and to the tree view. 1236# the table of contents of the HTML help documentation and to the tree view.
1237# The default value is: NO.
1238# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1061 1239
1062TOC_EXPAND = NO 1240TOC_EXPAND = NO
1063 1241
1064# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1242# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1065# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1243# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1066# that can be used as input for Qt's qhelpgenerator to generate a 1244# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1067# Qt Compressed Help (.qch) of the generated HTML documentation. 1245# (.qch) of the generated HTML documentation.
1246# The default value is: NO.
1247# This tag requires that the tag GENERATE_HTML is set to YES.
1068 1248
1069GENERATE_QHP = NO 1249GENERATE_QHP = NO
1070 1250
1071# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1251# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1072# be used to specify the file name of the resulting .qch file. 1252# the file name of the resulting .qch file. The path specified is relative to
1073# The path specified is relative to the HTML output folder. 1253# the HTML output folder.
1254# This tag requires that the tag GENERATE_QHP is set to YES.
1074 1255
1075QCH_FILE = 1256QCH_FILE =
1076 1257
1077# The QHP_NAMESPACE tag specifies the namespace to use when generating 1258# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1078# Qt Help Project output. For more information please see 1259# Project output. For more information please see Qt Help Project / Namespace
1079# http://doc.trolltech.com/qthelpproject.html#namespace 1260# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1261# The default value is: org.doxygen.Project.
1262# This tag requires that the tag GENERATE_QHP is set to YES.
1080 1263
1081QHP_NAMESPACE = org.doxygen.Project 1264QHP_NAMESPACE = org.doxygen.Project
1082 1265
1083# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1266# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1084# Qt Help Project output. For more information please see 1267# Help Project output. For more information please see Qt Help Project / Virtual
1085# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1268# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1269# folders).
1270# The default value is: doc.
1271# This tag requires that the tag GENERATE_QHP is set to YES.
1086 1272
1087QHP_VIRTUAL_FOLDER = doc 1273QHP_VIRTUAL_FOLDER = doc
1088 1274
1089# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1275# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1090# add. For more information please see 1276# filter to add. For more information please see Qt Help Project / Custom
1091# http://doc.trolltech.com/qthelpproject.html#custom-filters 1277# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1278# filters).
1279# This tag requires that the tag GENERATE_QHP is set to YES.
1092 1280
1093QHP_CUST_FILTER_NAME = 1281QHP_CUST_FILTER_NAME =
1094 1282
1095# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1283# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1096# custom filter to add. For more information please see 1284# custom filter to add. For more information please see Qt Help Project / Custom
1097# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1285# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1098# Qt Help Project / Custom Filters</a>. 1286# filters).
1287# This tag requires that the tag GENERATE_QHP is set to YES.
1099 1288
1100QHP_CUST_FILTER_ATTRS = 1289QHP_CUST_FILTER_ATTRS =
1101 1290
1102# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1291# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1103# project's 1292# project's filter section matches. Qt Help Project / Filter Attributes (see:
1104# filter section matches. 1293# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1105# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1294# This tag requires that the tag GENERATE_QHP is set to YES.
1106# Qt Help Project / Filter Attributes</a>.
1107 1295
1108QHP_SECT_FILTER_ATTRS = 1296QHP_SECT_FILTER_ATTRS =
1109 1297
1110# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1298# The QHG_LOCATION tag can be used to specify the location of Qt's
1111# be used to specify the location of Qt's qhelpgenerator. 1299# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1112# If non-empty doxygen will try to run qhelpgenerator on the generated 1300# generated .qhp file.
1113# .qhp file. 1301# This tag requires that the tag GENERATE_QHP is set to YES.
1114 1302
1115QHG_LOCATION = 1303QHG_LOCATION =
1116 1304
1117# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1305# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1118# will be generated, which together with the HTML files, form an Eclipse help 1306# generated, together with the HTML files, they form an Eclipse help plugin. To
1119# plugin. To install this plugin and make it available under the help contents 1307# install this plugin and make it available under the help contents menu in
1120# menu in Eclipse, the contents of the directory containing the HTML and XML 1308# Eclipse, the contents of the directory containing the HTML and XML files needs
1121# files needs to be copied into the plugins directory of eclipse. The name of 1309# to be copied into the plugins directory of eclipse. The name of the directory
1122# the directory within the plugins directory should be the same as 1310# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1123# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1311# After copying Eclipse needs to be restarted before the help appears.
1124# the help appears. 1312# The default value is: NO.
1313# This tag requires that the tag GENERATE_HTML is set to YES.
1125 1314
1126GENERATE_ECLIPSEHELP = NO 1315GENERATE_ECLIPSEHELP = NO
1127 1316
1128# A unique identifier for the eclipse help plugin. When installing the plugin 1317# A unique identifier for the Eclipse help plugin. When installing the plugin
1129# the directory name containing the HTML and XML files should also have 1318# the directory name containing the HTML and XML files should also have this
1130# this name. 1319# name. Each documentation set should have its own identifier.
1320# The default value is: org.doxygen.Project.
1321# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1131 1322
1132ECLIPSE_DOC_ID = org.doxygen.Project 1323ECLIPSE_DOC_ID = org.doxygen.Project
1133 1324
1134# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1325# If you want full control over the layout of the generated HTML pages it might
1135# at top of each HTML page. The value NO (the default) enables the index and 1326# be necessary to disable the index and replace it with your own. The
1136# the value YES disables it. Since the tabs have the same information as the 1327# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1137# navigation tree you can set this option to NO if you already set 1328# of each HTML page. A value of NO enables the index and the value YES disables
1138# GENERATE_TREEVIEW to YES. 1329# it. Since the tabs in the index contain the same information as the navigation
1330# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1331# The default value is: NO.
1332# This tag requires that the tag GENERATE_HTML is set to YES.
1139 1333
1140DISABLE_INDEX = YES 1334DISABLE_INDEX = YES
1141 1335
1142# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1336# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1143# structure should be generated to display hierarchical information. 1337# structure should be generated to display hierarchical information. If the tag
1144# If the tag value is set to YES, a side panel will be generated 1338# value is set to YES, a side panel will be generated containing a tree-like
1145# containing a tree-like index structure (just like the one that 1339# index structure (just like the one that is generated for HTML Help). For this
1146# is generated for HTML Help). For this to work a browser that supports 1340# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1147# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1341# (i.e. any modern browser). Windows users are probably better off using the
1148# Windows users are probably better off using the HTML help feature. 1342# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1149# Since the tree basically has the same information as the tab index you 1343# further fine-tune the look of the index. As an example, the default style
1150# could consider to set DISABLE_INDEX to NO when enabling this option. 1344# sheet generated by doxygen has an example that shows how to put an image at
1345# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1346# the same information as the tab index, you could consider setting
1347# DISABLE_INDEX to YES when enabling this option.
1348# The default value is: NO.
1349# This tag requires that the tag GENERATE_HTML is set to YES.
1151 1350
1152GENERATE_TREEVIEW = YES 1351GENERATE_TREEVIEW = YES
1153 1352
1154# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1353# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1155# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1354# doxygen will group on one line in the generated HTML documentation.
1156# documentation. Note that a value of 0 will completely suppress the enum 1355#
1157# values from appearing in the overview section. 1356# Note that a value of 0 will completely suppress the enum values from appearing
1357# in the overview section.
1358# Minimum value: 0, maximum value: 20, default value: 4.
1359# This tag requires that the tag GENERATE_HTML is set to YES.
1158 1360
1159ENUM_VALUES_PER_LINE = 1 1361ENUM_VALUES_PER_LINE = 1
1160 1362
1161# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1363# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1162# used to set the initial width (in pixels) of the frame in which the tree 1364# to set the initial width (in pixels) of the frame in which the tree is shown.
1163# is shown. 1365# Minimum value: 0, maximum value: 1500, default value: 250.
1366# This tag requires that the tag GENERATE_HTML is set to YES.
1164 1367
1165TREEVIEW_WIDTH = 250 1368TREEVIEW_WIDTH = 250
1166 1369
1167# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1370# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1168# links to external symbols imported via tag files in a separate window. 1371# external symbols imported via tag files in a separate window.
1372# The default value is: NO.
1373# This tag requires that the tag GENERATE_HTML is set to YES.
1169 1374
1170EXT_LINKS_IN_WINDOW = NO 1375EXT_LINKS_IN_WINDOW = NO
1171 1376
1172# Use this tag to change the font size of Latex formulas included 1377# Use this tag to change the font size of LaTeX formulas included as images in
1173# as images in the HTML documentation. The default is 10. Note that 1378# the HTML documentation. When you change the font size after a successful
1174# when you change the font size after a successful doxygen run you need 1379# doxygen run you need to manually remove any form_*.png images from the HTML
1175# to manually remove any form_*.png images from the HTML output directory 1380# output directory to force them to be regenerated.
1176# to force them to be regenerated. 1381# Minimum value: 8, maximum value: 50, default value: 10.
1382# This tag requires that the tag GENERATE_HTML is set to YES.
1177 1383
1178FORMULA_FONTSIZE = 10 1384FORMULA_FONTSIZE = 10
1179 1385
1180# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1386# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1181# generated for formulas are transparent PNGs. Transparent PNGs are 1387# generated for formulas are transparent PNGs. Transparent PNGs are not
1182# not supported properly for IE 6.0, but are supported on all modern browsers. 1388# supported properly for IE 6.0, but are supported on all modern browsers.
1183# Note that when changing this option you need to delete any form_*.png files 1389#
1184# in the HTML output before the changes have effect. 1390# Note that when changing this option you need to delete any form_*.png files in
1391# the HTML output directory before the changes have effect.
1392# The default value is: YES.
1393# This tag requires that the tag GENERATE_HTML is set to YES.
1185 1394
1186FORMULA_TRANSPARENT = YES 1395FORMULA_TRANSPARENT = YES
1187 1396
1188# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1397# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1189# (see http://www.mathjax.org) which uses client side Javascript for the 1398# http://www.mathjax.org) which uses client side Javascript for the rendering
1190# rendering instead of using prerendered bitmaps. Use this if you do not 1399# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1191# have LaTeX installed or if you want to formulas look prettier in the HTML 1400# installed or if you want to formulas look prettier in the HTML output. When
1192# output. When enabled you may also need to install MathJax separately and 1401# enabled you may also need to install MathJax separately and configure the path
1193# configure the path to it using the MATHJAX_RELPATH option. 1402# to it using the MATHJAX_RELPATH option.
1403# The default value is: NO.
1404# This tag requires that the tag GENERATE_HTML is set to YES.
1194 1405
1195USE_MATHJAX = NO 1406USE_MATHJAX = NO
1196 1407
1197# When MathJax is enabled you need to specify the location relative to the 1408# When MathJax is enabled you can set the default output format to be used for
1198# HTML output directory using the MATHJAX_RELPATH option. The destination 1409# the MathJax output. See the MathJax site (see:
1199# directory should contain the MathJax.js script. For instance, if the mathjax 1410# http://docs.mathjax.org/en/latest/output.html) for more details.
1200# directory is located at the same level as the HTML output directory, then 1411# Possible values are: HTML-CSS (which is slower, but has the best
1201# MATHJAX_RELPATH should be ../mathjax. The default value points to 1412# compatibility), NativeMML (i.e. MathML) and SVG.
1202# the MathJax Content Delivery Network so you can quickly see the result without 1413# The default value is: HTML-CSS.
1203# installing MathJax. 1414# This tag requires that the tag USE_MATHJAX is set to YES.
1204# However, it is strongly recommended to install a local 1415
1205# copy of MathJax from http://www.mathjax.org before deployment. 1416MATHJAX_FORMAT = HTML-CSS
1417
1418# When MathJax is enabled you need to specify the location relative to the HTML
1419# output directory using the MATHJAX_RELPATH option. The destination directory
1420# should contain the MathJax.js script. For instance, if the mathjax directory
1421# is located at the same level as the HTML output directory, then
1422# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1423# Content Delivery Network so you can quickly see the result without installing
1424# MathJax. However, it is strongly recommended to install a local copy of
1425# MathJax from http://www.mathjax.org before deployment.
1426# The default value is: http://cdn.mathjax.org/mathjax/latest.
1427# This tag requires that the tag USE_MATHJAX is set to YES.
1206 1428
1207MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1429MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1208 1430
1209# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1431# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1210# names that should be enabled during MathJax rendering. 1432# extension names that should be enabled during MathJax rendering. For example
1433# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1434# This tag requires that the tag USE_MATHJAX is set to YES.
1211 1435
1212MATHJAX_EXTENSIONS = 1436MATHJAX_EXTENSIONS =
1213 1437
1214# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1438# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1215# for the HTML output. The underlying search engine uses javascript 1439# of code that will be used on startup of the MathJax code. See the MathJax site
1216# and DHTML and should work on any modern browser. Note that when using 1440# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1217# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1441# example see the documentation.
1218# (GENERATE_DOCSET) there is already a search function so this one should 1442# This tag requires that the tag USE_MATHJAX is set to YES.
1219# typically be disabled. For large projects the javascript based search engine 1443
1220# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1444MATHJAX_CODEFILE =
1445
1446# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1447# the HTML output. The underlying search engine uses javascript and DHTML and
1448# should work on any modern browser. Note that when using HTML help
1449# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1450# there is already a search function so this one should typically be disabled.
1451# For large projects the javascript based search engine can be slow, then
1452# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1453# search using the keyboard; to jump to the search box use <access key> + S
1454# (what the <access key> is depends on the OS and browser, but it is typically
1455# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1456# key> to jump into the search results window, the results can be navigated
1457# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1458# the search. The filter options can be selected when the cursor is inside the
1459# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1460# to select a filter and <Enter> or <escape> to activate or cancel the filter
1461# option.
1462# The default value is: YES.
1463# This tag requires that the tag GENERATE_HTML is set to YES.
1221 1464
1222SEARCHENGINE = NO 1465SEARCHENGINE = NO
1223 1466
1224# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1467# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1225# implemented using a PHP enabled web server instead of at the web client 1468# implemented using a web server instead of a web client using Javascript. There
1226# using Javascript. Doxygen will generate the search PHP script and index 1469# are two flavours of web server based searching depending on the
1227# file to put on the web server. The advantage of the server 1470# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1228# based approach is that it scales better to large projects and allows 1471# searching and an index file used by the script. When EXTERNAL_SEARCH is
1229# full text search. The disadvantages are that it is more difficult to setup 1472# enabled the indexing and searching needs to be provided by external tools. See
1230# and does not have live searching capabilities. 1473# the section "External Indexing and Searching" for details.
1474# The default value is: NO.
1475# This tag requires that the tag SEARCHENGINE is set to YES.
1231 1476
1232SERVER_BASED_SEARCH = NO 1477SERVER_BASED_SEARCH = NO
1233 1478
1479# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1480# script for searching. Instead the search results are written to an XML file
1481# which needs to be processed by an external indexer. Doxygen will invoke an
1482# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1483# search results.
1484#
1485# Doxygen ships with an example indexer ( doxyindexer) and search engine
1486# (doxysearch.cgi) which are based on the open source search engine library
1487# Xapian (see: http://xapian.org/).
1488#
1489# See the section "External Indexing and Searching" for details.
1490# The default value is: NO.
1491# This tag requires that the tag SEARCHENGINE is set to YES.
1492
1493EXTERNAL_SEARCH = NO
1494
1495# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1496# which will return the search results when EXTERNAL_SEARCH is enabled.
1497#
1498# Doxygen ships with an example indexer ( doxyindexer) and search engine
1499# (doxysearch.cgi) which are based on the open source search engine library
1500# Xapian (see: http://xapian.org/). See the section "External Indexing and
1501# Searching" for details.
1502# This tag requires that the tag SEARCHENGINE is set to YES.
1503
1504SEARCHENGINE_URL =
1505
1506# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1507# search data is written to a file for indexing by an external tool. With the
1508# SEARCHDATA_FILE tag the name of this file can be specified.
1509# The default file is: searchdata.xml.
1510# This tag requires that the tag SEARCHENGINE is set to YES.
1511
1512SEARCHDATA_FILE = searchdata.xml
1513
1514# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1515# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1516# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1517# projects and redirect the results back to the right project.
1518# This tag requires that the tag SEARCHENGINE is set to YES.
1519
1520EXTERNAL_SEARCH_ID =
1521
1522# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1523# projects other than the one defined by this configuration file, but that are
1524# all added to the same external search index. Each project needs to have a
1525# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1526# to a relative location where the documentation can be found. The format is:
1527# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1528# This tag requires that the tag SEARCHENGINE is set to YES.
1529
1530EXTRA_SEARCH_MAPPINGS =
1531
1234#--------------------------------------------------------------------------- 1532#---------------------------------------------------------------------------
1235# configuration options related to the LaTeX output 1533# Configuration options related to the LaTeX output
1236#--------------------------------------------------------------------------- 1534#---------------------------------------------------------------------------
1237 1535
1238# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1536# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1239# generate Latex output. 1537# The default value is: YES.
1240 1538
1241GENERATE_LATEX = YES 1539GENERATE_LATEX = YES
1242 1540
1243# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1541# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1244# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1542# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1245# put in front of it. If left blank `latex' will be used as the default path. 1543# it.
1544# The default directory is: latex.
1545# This tag requires that the tag GENERATE_LATEX is set to YES.
1246 1546
1247LATEX_OUTPUT = latex 1547LATEX_OUTPUT = latex
1248 1548
1249# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1549# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1250# invoked. If left blank `latex' will be used as the default command name. 1550# invoked.
1251# Note that when enabling USE_PDFLATEX this option is only used for 1551#
1252# generating bitmaps for formulas in the HTML output, but not in the 1552# Note that when enabling USE_PDFLATEX this option is only used for generating
1253# Makefile that is written to the output directory. 1553# bitmaps for formulas in the HTML output, but not in the Makefile that is
1554# written to the output directory.
1555# The default file is: latex.
1556# This tag requires that the tag GENERATE_LATEX is set to YES.
1254 1557
1255LATEX_CMD_NAME = latex 1558LATEX_CMD_NAME = latex
1256 1559
1257# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1560# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1258# generate index for LaTeX. If left blank `makeindex' will be used as the 1561# index for LaTeX.
1259# default command name. 1562# The default file is: makeindex.
1563# This tag requires that the tag GENERATE_LATEX is set to YES.
1260 1564
1261MAKEINDEX_CMD_NAME = makeindex 1565MAKEINDEX_CMD_NAME = makeindex
1262 1566
1263# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1567# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1264# LaTeX documents. This may be useful for small projects and may help to 1568# documents. This may be useful for small projects and may help to save some
1265# save some trees in general. 1569# trees in general.
1570# The default value is: NO.
1571# This tag requires that the tag GENERATE_LATEX is set to YES.
1266 1572
1267COMPACT_LATEX = NO 1573COMPACT_LATEX = NO
1268 1574
1269# The PAPER_TYPE tag can be used to set the paper type that is used 1575# The PAPER_TYPE tag can be used to set the paper type that is used by the
1270# by the printer. Possible values are: a4, letter, legal and 1576# printer.
1271# executive. If left blank a4wide will be used. 1577# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1578# 14 inches) and executive (7.25 x 10.5 inches).
1579# The default value is: a4.
1580# This tag requires that the tag GENERATE_LATEX is set to YES.
1272 1581
1273PAPER_TYPE = a4wide 1582PAPER_TYPE = a4wide
1274 1583
1275# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1584# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1276# packages that should be included in the LaTeX output. 1585# that should be included in the LaTeX output. To get the times font for
1586# instance you can specify
1587# EXTRA_PACKAGES=times
1588# If left blank no extra packages will be included.
1589# This tag requires that the tag GENERATE_LATEX is set to YES.
1277 1590
1278EXTRA_PACKAGES = 1591EXTRA_PACKAGES =
1279 1592
1280# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1593# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1281# the generated latex document. The header should contain everything until 1594# generated LaTeX document. The header should contain everything until the first
1282# the first chapter. If it is left blank doxygen will generate a 1595# chapter. If it is left blank doxygen will generate a standard header. See
1283# standard header. Notice: only use this tag if you know what you are doing! 1596# section "Doxygen usage" for information on how to let doxygen write the
1597# default header to a separate file.
1598#
1599# Note: Only use a user-defined header if you know what you are doing! The
1600# following commands have a special meaning inside the header: $title,
1601# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1602# replace them by respectively the title of the page, the current date and time,
1603# only the current date, the version number of doxygen, the project name (see
1604# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1605# This tag requires that the tag GENERATE_LATEX is set to YES.
1284 1606
1285LATEX_HEADER = 1607LATEX_HEADER =
1286 1608
1287# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1609# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1288# the generated latex document. The footer should contain everything after 1610# generated LaTeX document. The footer should contain everything after the last
1289# the last chapter. If it is left blank doxygen will generate a 1611# chapter. If it is left blank doxygen will generate a standard footer.
1290# standard footer. Notice: only use this tag if you know what you are doing! 1612#
1613# Note: Only use a user-defined footer if you know what you are doing!
1614# This tag requires that the tag GENERATE_LATEX is set to YES.
1291 1615
1292LATEX_FOOTER = 1616LATEX_FOOTER =
1293 1617
1294# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1618# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1295# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1619# other source files which should be copied to the LATEX_OUTPUT output
1296# contain links (just like the HTML output) instead of page references 1620# directory. Note that the files will be copied as-is; there are no commands or
1297# This makes the output suitable for online browsing using a pdf viewer. 1621# markers available.
1622# This tag requires that the tag GENERATE_LATEX is set to YES.
1623
1624LATEX_EXTRA_FILES =
1625
1626# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1627# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1628# contain links (just like the HTML output) instead of page references. This
1629# makes the output suitable for online browsing using a PDF viewer.
1630# The default value is: YES.
1631# This tag requires that the tag GENERATE_LATEX is set to YES.
1298 1632
1299PDF_HYPERLINKS = YES 1633PDF_HYPERLINKS = YES
1300 1634
1301# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1635# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1302# plain latex in the generated Makefile. Set this option to YES to get a 1636# the PDF file directly from the LaTeX files. Set this option to YES to get a
1303# higher quality PDF documentation. 1637# higher quality PDF documentation.
1638# The default value is: YES.
1639# This tag requires that the tag GENERATE_LATEX is set to YES.
1304 1640
1305USE_PDFLATEX = NO 1641USE_PDFLATEX = NO
1306 1642
1307# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1643# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1308# command to the generated LaTeX files. This will instruct LaTeX to keep 1644# command to the generated LaTeX files. This will instruct LaTeX to keep running
1309# running if errors occur, instead of asking the user for help. 1645# if errors occur, instead of asking the user for help. This option is also used
1310# This option is also used when generating formulas in HTML. 1646# when generating formulas in HTML.
1647# The default value is: NO.
1648# This tag requires that the tag GENERATE_LATEX is set to YES.
1311 1649
1312LATEX_BATCHMODE = NO 1650LATEX_BATCHMODE = NO
1313 1651
1314# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1652# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1315# include the index chapters (such as File Index, Compound Index, etc.) 1653# index chapters (such as File Index, Compound Index, etc.) in the output.
1316# in the output. 1654# The default value is: NO.
1655# This tag requires that the tag GENERATE_LATEX is set to YES.
1317 1656
1318LATEX_HIDE_INDICES = NO 1657LATEX_HIDE_INDICES = NO
1319 1658
1320# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1659# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1321# source code with syntax highlighting in the LaTeX output. 1660# code with syntax highlighting in the LaTeX output.
1322# Note that which sources are shown also depends on other settings 1661#
1323# such as SOURCE_BROWSER. 1662# Note that which sources are shown also depends on other settings such as
1663# SOURCE_BROWSER.
1664# The default value is: NO.
1665# This tag requires that the tag GENERATE_LATEX is set to YES.
1324 1666
1325LATEX_SOURCE_CODE = NO 1667LATEX_SOURCE_CODE = NO
1326 1668
1327# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1669# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1328# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1670# bibliography, e.g. plainnat, or ieeetr. See
1329# http://en.wikipedia.org/wiki/BibTeX for more info. 1671# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1672# The default value is: plain.
1673# This tag requires that the tag GENERATE_LATEX is set to YES.
1330 1674
1331LATEX_BIB_STYLE = plain 1675LATEX_BIB_STYLE = plain
1332 1676
1333#--------------------------------------------------------------------------- 1677#---------------------------------------------------------------------------
1334# configuration options related to the RTF output 1678# Configuration options related to the RTF output
1335#--------------------------------------------------------------------------- 1679#---------------------------------------------------------------------------
1336 1680
1337# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1681# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1338# The RTF output is optimized for Word 97 and may not look very pretty with 1682# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1339# other RTF readers or editors. 1683# readers/editors.
1684# The default value is: NO.
1340 1685
1341GENERATE_RTF = NO 1686GENERATE_RTF = NO
1342 1687
1343# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1688# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1344# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1689# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1345# put in front of it. If left blank `rtf' will be used as the default path. 1690# it.
1691# The default directory is: rtf.
1692# This tag requires that the tag GENERATE_RTF is set to YES.
1346 1693
1347RTF_OUTPUT = rtf 1694RTF_OUTPUT = rtf
1348 1695
1349# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1696# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1350# RTF documents. This may be useful for small projects and may help to 1697# documents. This may be useful for small projects and may help to save some
1351# save some trees in general. 1698# trees in general.
1699# The default value is: NO.
1700# This tag requires that the tag GENERATE_RTF is set to YES.
1352 1701
1353COMPACT_RTF = NO 1702COMPACT_RTF = NO
1354 1703
1355# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1704# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1356# will contain hyperlink fields. The RTF file will 1705# contain hyperlink fields. The RTF file will contain links (just like the HTML
1357# contain links (just like the HTML output) instead of page references. 1706# output) instead of page references. This makes the output suitable for online
1358# This makes the output suitable for online browsing using WORD or other 1707# browsing using Word or some other Word compatible readers that support those
1359# programs which support those fields. 1708# fields.
1360# Note: wordpad (write) and others do not support links. 1709#
1710# Note: WordPad (write) and others do not support links.
1711# The default value is: NO.
1712# This tag requires that the tag GENERATE_RTF is set to YES.
1361 1713
1362RTF_HYPERLINKS = NO 1714RTF_HYPERLINKS = NO
1363 1715
1364# Load style sheet definitions from file. Syntax is similar to doxygen's 1716# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1365# config file, i.e. a series of assignments. You only have to provide 1717# file, i.e. a series of assignments. You only have to provide replacements,
1366# replacements, missing definitions are set to their default value. 1718# missing definitions are set to their default value.
1719#
1720# See also section "Doxygen usage" for information on how to generate the
1721# default style sheet that doxygen normally uses.
1722# This tag requires that the tag GENERATE_RTF is set to YES.
1367 1723
1368RTF_STYLESHEET_FILE = 1724RTF_STYLESHEET_FILE =
1369 1725
1370# Set optional variables used in the generation of an rtf document. 1726# Set optional variables used in the generation of an RTF document. Syntax is
1371# Syntax is similar to doxygen's config file. 1727# similar to doxygen's config file. A template extensions file can be generated
1728# using doxygen -e rtf extensionFile.
1729# This tag requires that the tag GENERATE_RTF is set to YES.
1372 1730
1373RTF_EXTENSIONS_FILE = 1731RTF_EXTENSIONS_FILE =
1374 1732
1375#--------------------------------------------------------------------------- 1733#---------------------------------------------------------------------------
1376# configuration options related to the man page output 1734# Configuration options related to the man page output
1377#--------------------------------------------------------------------------- 1735#---------------------------------------------------------------------------
1378 1736
1379# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1737# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1380# generate man pages 1738# classes and files.
1739# The default value is: NO.
1381 1740
1382GENERATE_MAN = YES 1741GENERATE_MAN = YES
1383 1742
1384# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1743# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1385# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1744# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1386# put in front of it. If left blank `man' will be used as the default path. 1745# it. A directory man3 will be created inside the directory specified by
1746# MAN_OUTPUT.
1747# The default directory is: man.
1748# This tag requires that the tag GENERATE_MAN is set to YES.
1387 1749
1388MAN_OUTPUT = man 1750MAN_OUTPUT = man
1389 1751
1390# The MAN_EXTENSION tag determines the extension that is added to 1752# The MAN_EXTENSION tag determines the extension that is added to the generated
1391# the generated man pages (default is the subroutine's section .3) 1753# man pages. In case the manual section does not start with a number, the number
1754# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1755# optional.
1756# The default value is: .3.
1757# This tag requires that the tag GENERATE_MAN is set to YES.
1392 1758
1393MAN_EXTENSION = .3 1759MAN_EXTENSION = .3
1394 1760
1395# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1761# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1396# then it will generate one additional man file for each entity 1762# will generate one additional man file for each entity documented in the real
1397# documented in the real man page(s). These additional files 1763# man page(s). These additional files only source the real man page, but without
1398# only source the real man page, but without them the man command 1764# them the man command would be unable to find the correct page.
1399# would be unable to find the correct page. The default is NO. 1765# The default value is: NO.
1766# This tag requires that the tag GENERATE_MAN is set to YES.
1400 1767
1401MAN_LINKS = YES 1768MAN_LINKS = YES
1402 1769
1403#--------------------------------------------------------------------------- 1770#---------------------------------------------------------------------------
1404# configuration options related to the XML output 1771# Configuration options related to the XML output
1405#--------------------------------------------------------------------------- 1772#---------------------------------------------------------------------------
1406 1773
1407# If the GENERATE_XML tag is set to YES Doxygen will 1774# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1408# generate an XML file that captures the structure of 1775# captures the structure of the code including all documentation.
1409# the code including all documentation. 1776# The default value is: NO.
1410 1777
1411GENERATE_XML = NO 1778GENERATE_XML = NO
1412 1779
1413# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1780# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1414# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1781# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1415# put in front of it. If left blank `xml' will be used as the default path. 1782# it.
1783# The default directory is: xml.
1784# This tag requires that the tag GENERATE_XML is set to YES.
1416 1785
1417XML_OUTPUT = xml 1786XML_OUTPUT = xml
1418 1787
1419# The XML_SCHEMA tag can be used to specify an XML schema, 1788# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1420# which can be used by a validating XML parser to check the 1789# validating XML parser to check the syntax of the XML files.
1421# syntax of the XML files. 1790# This tag requires that the tag GENERATE_XML is set to YES.
1422 1791
1423XML_SCHEMA = 1792XML_SCHEMA =
1424 1793
1425# The XML_DTD tag can be used to specify an XML DTD, 1794# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1426# which can be used by a validating XML parser to check the 1795# validating XML parser to check the syntax of the XML files.
1427# syntax of the XML files. 1796# This tag requires that the tag GENERATE_XML is set to YES.
1428 1797
1429XML_DTD = 1798XML_DTD =
1430 1799
1431# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1800# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1432# dump the program listings (including syntax highlighting 1801# listings (including syntax highlighting and cross-referencing information) to
1433# and cross-referencing information) to the XML output. Note that 1802# the XML output. Note that enabling this will significantly increase the size
1434# enabling this will significantly increase the size of the XML output. 1803# of the XML output.
1804# The default value is: YES.
1805# This tag requires that the tag GENERATE_XML is set to YES.
1435 1806
1436XML_PROGRAMLISTING = YES 1807XML_PROGRAMLISTING = YES
1437 1808
1438#--------------------------------------------------------------------------- 1809#---------------------------------------------------------------------------
1439# configuration options for the AutoGen Definitions output 1810# Configuration options related to the DOCBOOK output
1440#--------------------------------------------------------------------------- 1811#---------------------------------------------------------------------------
1441 1812
1442# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1813# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1443# generate an AutoGen Definitions (see autogen.sf.net) file 1814# that can be used to generate PDF.
1444# that captures the structure of the code including all 1815# The default value is: NO.
1445# documentation. Note that this feature is still experimental 1816
1446# and incomplete at the moment. 1817GENERATE_DOCBOOK = NO
1818
1819# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1820# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1821# front of it.
1822# The default directory is: docbook.
1823# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1824
1825DOCBOOK_OUTPUT = docbook
1826
1827#---------------------------------------------------------------------------
1828# Configuration options for the AutoGen Definitions output
1829#---------------------------------------------------------------------------
1830
1831# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1832# Definitions (see http://autogen.sf.net) file that captures the structure of
1833# the code including all documentation. Note that this feature is still
1834# experimental and incomplete at the moment.
1835# The default value is: NO.
1447 1836
1448GENERATE_AUTOGEN_DEF = NO 1837GENERATE_AUTOGEN_DEF = NO
1449 1838
1450#--------------------------------------------------------------------------- 1839#---------------------------------------------------------------------------
1451# configuration options related to the Perl module output 1840# Configuration options related to the Perl module output
1452#--------------------------------------------------------------------------- 1841#---------------------------------------------------------------------------
1453 1842
1454# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1843# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1455# generate a Perl module file that captures the structure of 1844# file that captures the structure of the code including all documentation.
1456# the code including all documentation. Note that this 1845#
1457# feature is still experimental and incomplete at the 1846# Note that this feature is still experimental and incomplete at the moment.
1458# moment. 1847# The default value is: NO.
1459 1848
1460GENERATE_PERLMOD = NO 1849GENERATE_PERLMOD = NO
1461 1850
1462# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1851# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1463# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1852# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1464# to generate PDF and DVI output from the Perl module output. 1853# output from the Perl module output.
1854# The default value is: NO.
1855# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1465 1856
1466PERLMOD_LATEX = NO 1857PERLMOD_LATEX = NO
1467 1858
1468# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1859# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1469# nicely formatted so it can be parsed by a human reader. 1860# formatted so it can be parsed by a human reader. This is useful if you want to
1470# This is useful 1861# understand what is going on. On the other hand, if this tag is set to NO the
1471# if you want to understand what is going on. 1862# size of the Perl module output will be much smaller and Perl will parse it
1472# On the other hand, if this 1863# just the same.
1473# tag is set to NO the size of the Perl module output will be much smaller 1864# The default value is: YES.
1474# and Perl will parse it just the same. 1865# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1475 1866
1476PERLMOD_PRETTY = YES 1867PERLMOD_PRETTY = YES
1477 1868
1478# The names of the make variables in the generated doxyrules.make file 1869# The names of the make variables in the generated doxyrules.make file are
1479# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1870# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1480# This is useful so different doxyrules.make files included by the same 1871# so different doxyrules.make files included by the same Makefile don't
1481# Makefile don't overwrite each other's variables. 1872# overwrite each other's variables.
1873# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1482 1874
1483PERLMOD_MAKEVAR_PREFIX = 1875PERLMOD_MAKEVAR_PREFIX =
1484 1876
@@ -1486,106 +1878,128 @@ PERLMOD_MAKEVAR_PREFIX =
1486# Configuration options related to the preprocessor 1878# Configuration options related to the preprocessor
1487#--------------------------------------------------------------------------- 1879#---------------------------------------------------------------------------
1488 1880
1489# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1881# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1490# evaluate all C-preprocessor directives found in the sources and include 1882# C-preprocessor directives found in the sources and include files.
1491# files. 1883# The default value is: YES.
1492 1884
1493ENABLE_PREPROCESSING = YES 1885ENABLE_PREPROCESSING = YES
1494 1886
1495# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1887# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1496# names in the source code. If set to NO (the default) only conditional 1888# in the source code. If set to NO only conditional compilation will be
1497# compilation will be performed. Macro expansion can be done in a controlled 1889# performed. Macro expansion can be done in a controlled way by setting
1498# way by setting EXPAND_ONLY_PREDEF to YES. 1890# EXPAND_ONLY_PREDEF to YES.
1891# The default value is: NO.
1892# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1499 1893
1500MACRO_EXPANSION = YES 1894MACRO_EXPANSION = YES
1501 1895
1502# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1896# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1503# then the macro expansion is limited to the macros specified with the 1897# the macro expansion is limited to the macros specified with the PREDEFINED and
1504# PREDEFINED and EXPAND_AS_DEFINED tags. 1898# EXPAND_AS_DEFINED tags.
1899# The default value is: NO.
1900# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1505 1901
1506EXPAND_ONLY_PREDEF = YES 1902EXPAND_ONLY_PREDEF = YES
1507 1903
1508# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1904# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1509# pointed to by INCLUDE_PATH will be searched when a #include is found. 1905# INCLUDE_PATH will be searched if a #include is found.
1906# The default value is: YES.
1907# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1510 1908
1511SEARCH_INCLUDES = NO 1909SEARCH_INCLUDES = NO
1512 1910
1513# The INCLUDE_PATH tag can be used to specify one or more directories that 1911# The INCLUDE_PATH tag can be used to specify one or more directories that
1514# contain include files that are not input files but should be processed by 1912# contain include files that are not input files but should be processed by the
1515# the preprocessor. 1913# preprocessor.
1914# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1516 1915
1517INCLUDE_PATH = 1916INCLUDE_PATH =
1518 1917
1519# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1918# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1520# patterns (like *.h and *.hpp) to filter out the header-files in the 1919# patterns (like *.h and *.hpp) to filter out the header-files in the
1521# directories. If left blank, the patterns specified with FILE_PATTERNS will 1920# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1522# be used. 1921# used.
1922# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1523 1923
1524INCLUDE_FILE_PATTERNS = 1924INCLUDE_FILE_PATTERNS =
1525 1925
1526# The PREDEFINED tag can be used to specify one or more macro names that 1926# The PREDEFINED tag can be used to specify one or more macro names that are
1527# are defined before the preprocessor is started (similar to the -D option of 1927# defined before the preprocessor is started (similar to the -D option of e.g.
1528# gcc). The argument of the tag is a list of macros of the form: name 1928# gcc). The argument of the tag is a list of macros of the form: name or
1529# or name=definition (no spaces). If the definition and the = are 1929# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1530# omitted =1 is assumed. To prevent a macro definition from being 1930# is assumed. To prevent a macro definition from being undefined via #undef or
1531# undefined via #undef or recursively expanded use the := operator 1931# recursively expanded use the := operator instead of the = operator.
1532# instead of the = operator. 1932# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1533 1933
1534PREDEFINED = __UNUSED__= 1934PREDEFINED = __UNUSED__=
1535 1935
1536# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1936# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1537# this tag can be used to specify a list of macro names that should be expanded. 1937# tag can be used to specify a list of macro names that should be expanded. The
1538# The macro definition that is found in the sources will be used. 1938# macro definition that is found in the sources will be used. Use the PREDEFINED
1539# Use the PREDEFINED tag if you want to use a different macro definition that 1939# tag if you want to use a different macro definition that overrules the
1540# overrules the definition found in the source code. 1940# definition found in the source code.
1941# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1541 1942
1542EXPAND_AS_DEFINED = 1943EXPAND_AS_DEFINED =
1543 1944
1544# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1945# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1545# doxygen's preprocessor will remove all references to function-like macros 1946# remove all refrences to function-like macros that are alone on a line, have an
1546# that are alone on a line, have an all uppercase name, and do not end with a 1947# all uppercase name, and do not end with a semicolon. Such function macros are
1547# semicolon, because these will confuse the parser if not removed. 1948# typically used for boiler-plate code, and will confuse the parser if not
1949# removed.
1950# The default value is: YES.
1951# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1548 1952
1549SKIP_FUNCTION_MACROS = YES 1953SKIP_FUNCTION_MACROS = YES
1550 1954
1551#--------------------------------------------------------------------------- 1955#---------------------------------------------------------------------------
1552# Configuration::additions related to external references 1956# Configuration options related to external references
1553#--------------------------------------------------------------------------- 1957#---------------------------------------------------------------------------
1554 1958
1555# The TAGFILES option can be used to specify one or more tagfiles. For each 1959# The TAGFILES tag can be used to specify one or more tag files. For each tag
1556# tag file the location of the external documentation should be added. The 1960# file the location of the external documentation should be added. The format of
1557# format of a tag file without this location is as follows: 1961# a tag file without this location is as follows:
1558#
1559# TAGFILES = file1 file2 ... 1962# TAGFILES = file1 file2 ...
1560# Adding location for the tag files is done as follows: 1963# Adding location for the tag files is done as follows:
1561#
1562# TAGFILES = file1=loc1 "file2 = loc2" ... 1964# TAGFILES = file1=loc1 "file2 = loc2" ...
1563# where "loc1" and "loc2" can be relative or absolute paths 1965# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1564# or URLs. Note that each tag file must have a unique name (where the name does 1966# section "Linking to external documentation" for more information about the use
1565# NOT include the path). If a tag file is not located in the directory in which 1967# of tag files.
1566# doxygen is run, you must also specify the path to the tagfile here. 1968# Note: Each tag file must have an unique name (where the name does NOT include
1969# the path). If a tag file is not located in the directory in which doxygen is
1970# run, you must also specify the path to the tagfile here.
1567 1971
1568TAGFILES = 1972TAGFILES =
1569 1973
1570# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1974# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1571# a tag file that is based on the input files it reads. 1975# tag file that is based on the input files it reads. See section "Linking to
1976# external documentation" for more information about the usage of tag files.
1572 1977
1573GENERATE_TAGFILE = 1978GENERATE_TAGFILE =
1574 1979
1575# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1980# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1576# in the class index. If set to NO only the inherited external classes 1981# class index. If set to NO only the inherited external classes will be listed.
1577# will be listed. 1982# The default value is: NO.
1578 1983
1579ALLEXTERNALS = NO 1984ALLEXTERNALS = NO
1580 1985
1581# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1986# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1582# in the modules index. If set to NO, only the current project's groups will 1987# the modules index. If set to NO, only the current project's groups will be
1583# be listed. 1988# listed.
1989# The default value is: YES.
1584 1990
1585EXTERNAL_GROUPS = YES 1991EXTERNAL_GROUPS = YES
1586 1992
1993# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1994# the related pages index. If set to NO, only the current project's pages will
1995# be listed.
1996# The default value is: YES.
1997
1998EXTERNAL_PAGES = YES
1999
1587# The PERL_PATH should be the absolute path and name of the perl script 2000# The PERL_PATH should be the absolute path and name of the perl script
1588# interpreter (i.e. the result of `which perl'). 2001# interpreter (i.e. the result of 'which perl').
2002# The default file (with absolute path) is: /usr/bin/perl.
1589 2003
1590PERL_PATH = /usr/bin/perl 2004PERL_PATH = /usr/bin/perl
1591 2005
@@ -1593,225 +2007,280 @@ PERL_PATH = /usr/bin/perl
1593# Configuration options related to the dot tool 2007# Configuration options related to the dot tool
1594#--------------------------------------------------------------------------- 2008#---------------------------------------------------------------------------
1595 2009
1596# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 2010# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
1597# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 2011# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
1598# or super classes. Setting the tag to NO turns the diagrams off. Note that 2012# NO turns the diagrams off. Note that this option also works with HAVE_DOT
1599# this option also works with HAVE_DOT disabled, but it is recommended to 2013# disabled, but it is recommended to install and use dot, since it yields more
1600# install and use dot, since it yields more powerful graphs. 2014# powerful graphs.
2015# The default value is: YES.
1601 2016
1602CLASS_DIAGRAMS = NO 2017CLASS_DIAGRAMS = NO
1603 2018
1604# You can define message sequence charts within doxygen comments using the \msc 2019# You can define message sequence charts within doxygen comments using the \msc
1605# command. Doxygen will then run the mscgen tool (see 2020# command. Doxygen will then run the mscgen tool (see:
1606# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 2021# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
1607# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2022# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1608# the mscgen tool resides. If left empty the tool is assumed to be found in the 2023# the mscgen tool resides. If left empty the tool is assumed to be found in the
1609# default search path. 2024# default search path.
1610 2025
1611MSCGEN_PATH = 2026MSCGEN_PATH =
1612 2027
1613# If set to YES, the inheritance and collaboration graphs will hide 2028# If set to YES, the inheritance and collaboration graphs will hide inheritance
1614# inheritance and usage relations if the target is undocumented 2029# and usage relations if the target is undocumented or is not a class.
1615# or is not a class. 2030# The default value is: YES.
1616 2031
1617HIDE_UNDOC_RELATIONS = YES 2032HIDE_UNDOC_RELATIONS = YES
1618 2033
1619# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2034# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1620# available from the path. This tool is part of Graphviz, a graph visualization 2035# available from the path. This tool is part of Graphviz (see:
1621# toolkit from AT&T and Lucent Bell Labs. The other options in this section 2036# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
1622# have no effect if this option is set to NO (the default) 2037# Bell Labs. The other options in this section have no effect if this option is
2038# set to NO
2039# The default value is: NO.
1623 2040
1624HAVE_DOT = YES 2041HAVE_DOT = YES
1625 2042
1626# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 2043# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
1627# allowed to run in parallel. When set to 0 (the default) doxygen will 2044# to run in parallel. When set to 0 doxygen will base this on the number of
1628# base this on the number of processors available in the system. You can set it 2045# processors available in the system. You can set it explicitly to a value
1629# explicitly to a value larger than 0 to get control over the balance 2046# larger than 0 to get control over the balance between CPU load and processing
1630# between CPU load and processing speed. 2047# speed.
2048# Minimum value: 0, maximum value: 32, default value: 0.
2049# This tag requires that the tag HAVE_DOT is set to YES.
1631 2050
1632DOT_NUM_THREADS = 2 2051DOT_NUM_THREADS = 2
1633 2052
1634# By default doxygen will use the Helvetica font for all dot files that 2053# When you want a differently looking font n the dot files that doxygen
1635# doxygen generates. When you want a differently looking font you can specify 2054# generates you can specify the font name using DOT_FONTNAME. You need to make
1636# the font name using DOT_FONTNAME. You need to make sure dot is able to find 2055# sure dot is able to find the font, which can be done by putting it in a
1637# the font, which can be done by putting it in a standard location or by setting 2056# standard location or by setting the DOTFONTPATH environment variable or by
1638# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2057# setting DOT_FONTPATH to the directory containing the font.
1639# directory containing the font. 2058# The default value is: Helvetica.
2059# This tag requires that the tag HAVE_DOT is set to YES.
1640 2060
1641DOT_FONTNAME = FreeSans.ttf 2061#DOT_FONTNAME = FreeSans.ttf
1642 2062
1643# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 2063# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
1644# The default size is 10pt. 2064# dot graphs.
2065# Minimum value: 4, maximum value: 24, default value: 10.
2066# This tag requires that the tag HAVE_DOT is set to YES.
1645 2067
1646DOT_FONTSIZE = 10 2068DOT_FONTSIZE = 10
1647 2069
1648# By default doxygen will tell dot to use the Helvetica font. 2070# By default doxygen will tell dot to use the default font as specified with
1649# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 2071# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
1650# set the path where dot can find it. 2072# the path where dot can find it using this tag.
2073# This tag requires that the tag HAVE_DOT is set to YES.
1651 2074
1652DOT_FONTPATH = 2075DOT_FONTPATH =
1653 2076
1654# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 2077# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
1655# will generate a graph for each documented class showing the direct and 2078# each documented class showing the direct and indirect inheritance relations.
1656# indirect inheritance relations. Setting this tag to YES will force the 2079# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
1657# CLASS_DIAGRAMS tag to NO. 2080# The default value is: YES.
2081# This tag requires that the tag HAVE_DOT is set to YES.
1658 2082
1659CLASS_GRAPH = NO 2083CLASS_GRAPH = NO
1660 2084
1661# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 2085# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
1662# will generate a graph for each documented class showing the direct and 2086# graph for each documented class showing the direct and indirect implementation
1663# indirect implementation dependencies (inheritance, containment, and 2087# dependencies (inheritance, containment, and class references variables) of the
1664# class references variables) of the class with other documented classes. 2088# class with other documented classes.
2089# The default value is: YES.
2090# This tag requires that the tag HAVE_DOT is set to YES.
1665 2091
1666COLLABORATION_GRAPH = NO 2092COLLABORATION_GRAPH = NO
1667 2093
1668# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 2094# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
1669# will generate a graph for groups, showing the direct groups dependencies 2095# groups, showing the direct groups dependencies.
2096# The default value is: YES.
2097# This tag requires that the tag HAVE_DOT is set to YES.
1670 2098
1671GROUP_GRAPHS = NO 2099GROUP_GRAPHS = NO
1672 2100
1673# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 2101# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1674# collaboration diagrams in a style similar to the OMG's Unified Modeling 2102# collaboration diagrams in a style similar to the OMG's Unified Modeling
1675# Language. 2103# Language.
2104# The default value is: NO.
2105# This tag requires that the tag HAVE_DOT is set to YES.
1676 2106
1677UML_LOOK = NO 2107UML_LOOK = NO
1678 2108
1679# If the UML_LOOK tag is enabled, the fields and methods are shown inside 2109# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
1680# the class node. If there are many fields or methods and many nodes the 2110# class node. If there are many fields or methods and many nodes the graph may
1681# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 2111# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
1682# threshold limits the number of items for each type to make the size more 2112# number of items for each type to make the size more manageable. Set this to 0
1683# managable. Set this to 0 for no limit. Note that the threshold may be 2113# for no limit. Note that the threshold may be exceeded by 50% before the limit
1684# exceeded by 50% before the limit is enforced. 2114# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2115# but if the number exceeds 15, the total amount of fields shown is limited to
2116# 10.
2117# Minimum value: 0, maximum value: 100, default value: 10.
2118# This tag requires that the tag HAVE_DOT is set to YES.
1685 2119
1686UML_LIMIT_NUM_FIELDS = 10 2120UML_LIMIT_NUM_FIELDS = 10
1687 2121
1688# If set to YES, the inheritance and collaboration graphs will show the 2122# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
1689# relations between templates and their instances. 2123# collaboration graphs will show the relations between templates and their
2124# instances.
2125# The default value is: NO.
2126# This tag requires that the tag HAVE_DOT is set to YES.
1690 2127
1691TEMPLATE_RELATIONS = NO 2128TEMPLATE_RELATIONS = NO
1692 2129
1693# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 2130# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
1694# tags are set to YES then doxygen will generate a graph for each documented 2131# YES then doxygen will generate a graph for each documented file showing the
1695# file showing the direct and indirect include dependencies of the file with 2132# direct and indirect include dependencies of the file with other documented
1696# other documented files. 2133# files.
2134# The default value is: YES.
2135# This tag requires that the tag HAVE_DOT is set to YES.
1697 2136
1698INCLUDE_GRAPH = NO 2137INCLUDE_GRAPH = NO
1699 2138
1700# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 2139# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
1701# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 2140# set to YES then doxygen will generate a graph for each documented file showing
1702# documented header file showing the documented files that directly or 2141# the direct and indirect include dependencies of the file with other documented
1703# indirectly include this file. 2142# files.
2143# The default value is: YES.
2144# This tag requires that the tag HAVE_DOT is set to YES.
1704 2145
1705INCLUDED_BY_GRAPH = NO 2146INCLUDED_BY_GRAPH = NO
1706 2147
1707# If the CALL_GRAPH and HAVE_DOT options are set to YES then 2148# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
1708# doxygen will generate a call dependency graph for every global function 2149# dependency graph for every global function or class method.
1709# or class method. Note that enabling this option will significantly increase 2150#
1710# the time of a run. So in most cases it will be better to enable call graphs 2151# Note that enabling this option will significantly increase the time of a run.
1711# for selected functions only using the \callgraph command. 2152# So in most cases it will be better to enable call graphs for selected
2153# functions only using the \callgraph command.
2154# The default value is: NO.
2155# This tag requires that the tag HAVE_DOT is set to YES.
1712 2156
1713CALL_GRAPH = NO 2157CALL_GRAPH = NO
1714 2158
1715# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 2159# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
1716# doxygen will generate a caller dependency graph for every global function 2160# dependency graph for every global function or class method.
1717# or class method. Note that enabling this option will significantly increase 2161#
1718# the time of a run. So in most cases it will be better to enable caller 2162# Note that enabling this option will significantly increase the time of a run.
1719# graphs for selected functions only using the \callergraph command. 2163# So in most cases it will be better to enable caller graphs for selected
2164# functions only using the \callergraph command.
2165# The default value is: NO.
2166# This tag requires that the tag HAVE_DOT is set to YES.
1720 2167
1721CALLER_GRAPH = NO 2168CALLER_GRAPH = NO
1722 2169
1723# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 2170# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
1724# will generate a graphical hierarchy of all classes instead of a textual one. 2171# hierarchy of all classes instead of a textual one.
2172# The default value is: YES.
2173# This tag requires that the tag HAVE_DOT is set to YES.
1725 2174
1726GRAPHICAL_HIERARCHY = NO 2175GRAPHICAL_HIERARCHY = NO
1727 2176
1728# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 2177# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
1729# then doxygen will show the dependencies a directory has on other directories 2178# dependencies a directory has on other directories in a graphical way. The
1730# in a graphical way. The dependency relations are determined by the #include 2179# dependency relations are determined by the #include relations between the
1731# relations between the files in the directories. 2180# files in the directories.
2181# The default value is: YES.
2182# This tag requires that the tag HAVE_DOT is set to YES.
1732 2183
1733DIRECTORY_GRAPH = NO 2184DIRECTORY_GRAPH = NO
1734 2185
1735# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2186# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1736# generated by dot. Possible values are svg, png, jpg, or gif. 2187# generated by dot.
1737# If left blank png will be used. If you choose svg you need to set 2188# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
1738# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 2189# to make the SVG files visible in IE 9+ (other browsers do not have this
1739# visible in IE 9+ (other browsers do not have this requirement). 2190# requirement).
2191# Possible values are: png, jpg, gif and svg.
2192# The default value is: png.
2193# This tag requires that the tag HAVE_DOT is set to YES.
1740 2194
1741DOT_IMAGE_FORMAT = png 2195DOT_IMAGE_FORMAT = png
1742 2196
1743# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2197# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1744# enable generation of interactive SVG images that allow zooming and panning. 2198# enable generation of interactive SVG images that allow zooming and panning.
1745# Note that this requires a modern browser other than Internet Explorer. 2199#
1746# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 2200# Note that this requires a modern browser other than Internet Explorer. Tested
1747# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 2201# and working are Firefox, Chrome, Safari, and Opera.
1748# visible. Older versions of IE do not have SVG support. 2202# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2203# the SVG files visible. Older versions of IE do not have SVG support.
2204# The default value is: NO.
2205# This tag requires that the tag HAVE_DOT is set to YES.
1749 2206
1750INTERACTIVE_SVG = NO 2207INTERACTIVE_SVG = NO
1751 2208
1752# The tag DOT_PATH can be used to specify the path where the dot tool can be 2209# The DOT_PATH tag can be used to specify the path where the dot tool can be
1753# found. If left blank, it is assumed the dot tool can be found in the path. 2210# found. If left blank, it is assumed the dot tool can be found in the path.
2211# This tag requires that the tag HAVE_DOT is set to YES.
1754 2212
1755DOT_PATH = 2213DOT_PATH =
1756 2214
1757# The DOTFILE_DIRS tag can be used to specify one or more directories that 2215# The DOTFILE_DIRS tag can be used to specify one or more directories that
1758# contain dot files that are included in the documentation (see the 2216# contain dot files that are included in the documentation (see the \dotfile
1759# \dotfile command). 2217# command).
2218# This tag requires that the tag HAVE_DOT is set to YES.
1760 2219
1761DOTFILE_DIRS = 2220DOTFILE_DIRS =
1762 2221
1763# The MSCFILE_DIRS tag can be used to specify one or more directories that 2222# The MSCFILE_DIRS tag can be used to specify one or more directories that
1764# contain msc files that are included in the documentation (see the 2223# contain msc files that are included in the documentation (see the \mscfile
1765# \mscfile command). 2224# command).
1766 2225
1767MSCFILE_DIRS = 2226MSCFILE_DIRS =
1768 2227
1769# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 2228# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
1770# nodes that will be shown in the graph. If the number of nodes in a graph 2229# that will be shown in the graph. If the number of nodes in a graph becomes
1771# becomes larger than this value, doxygen will truncate the graph, which is 2230# larger than this value, doxygen will truncate the graph, which is visualized
1772# visualized by representing a node as a red box. Note that doxygen if the 2231# by representing a node as a red box. Note that doxygen if the number of direct
1773# number of direct children of the root node in a graph is already larger than 2232# children of the root node in a graph is already larger than
1774# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 2233# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
1775# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2234# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2235# Minimum value: 0, maximum value: 10000, default value: 50.
2236# This tag requires that the tag HAVE_DOT is set to YES.
1776 2237
1777DOT_GRAPH_MAX_NODES = 50 2238DOT_GRAPH_MAX_NODES = 50
1778 2239
1779# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 2240# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
1780# graphs generated by dot. A depth value of 3 means that only nodes reachable 2241# generated by dot. A depth value of 3 means that only nodes reachable from the
1781# from the root by following a path via at most 3 edges will be shown. Nodes 2242# root by following a path via at most 3 edges will be shown. Nodes that lay
1782# that lay further from the root node will be omitted. Note that setting this 2243# further from the root node will be omitted. Note that setting this option to 1
1783# option to 1 or 2 may greatly reduce the computation time needed for large 2244# or 2 may greatly reduce the computation time needed for large code bases. Also
1784# code bases. Also note that the size of a graph can be further restricted by 2245# note that the size of a graph can be further restricted by
1785# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2246# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2247# Minimum value: 0, maximum value: 1000, default value: 0.
2248# This tag requires that the tag HAVE_DOT is set to YES.
1786 2249
1787MAX_DOT_GRAPH_DEPTH = 0 2250MAX_DOT_GRAPH_DEPTH = 0
1788 2251
1789# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2252# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1790# background. This is disabled by default, because dot on Windows does not 2253# background. This is disabled by default, because dot on Windows does not seem
1791# seem to support this out of the box. Warning: Depending on the platform used, 2254# to support this out of the box.
1792# enabling this option may lead to badly anti-aliased labels on the edges of 2255#
1793# a graph (i.e. they become hard to read). 2256# Warning: Depending on the platform used, enabling this option may lead to
2257# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2258# read).
2259# The default value is: NO.
2260# This tag requires that the tag HAVE_DOT is set to YES.
1794 2261
1795DOT_TRANSPARENT = YES 2262DOT_TRANSPARENT = YES
1796 2263
1797# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 2264# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1798# files in one run (i.e. multiple -o and -T options on the command line). This 2265# files in one run (i.e. multiple -o and -T options on the command line). This
1799# makes dot run faster, but since only newer versions of dot (>1.8.10) 2266# makes dot run faster, but since only newer versions of dot (>1.8.10) support
1800# support this, this feature is disabled by default. 2267# this, this feature is disabled by default.
2268# The default value is: NO.
2269# This tag requires that the tag HAVE_DOT is set to YES.
1801 2270
1802DOT_MULTI_TARGETS = NO 2271DOT_MULTI_TARGETS = NO
1803 2272
1804# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 2273# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
1805# generate a legend page explaining the meaning of the various boxes and 2274# explaining the meaning of the various boxes and arrows in the dot generated
1806# arrows in the dot generated graphs. 2275# graphs.
2276# The default value is: YES.
2277# This tag requires that the tag HAVE_DOT is set to YES.
1807 2278
1808GENERATE_LEGEND = YES 2279GENERATE_LEGEND = YES
1809 2280
1810# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 2281# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
1811# remove the intermediate dot files that are used to generate 2282# files that are used to generate the various graphs.
1812# the various graphs. 2283# The default value is: YES.
2284# This tag requires that the tag HAVE_DOT is set to YES.
1813 2285
1814DOT_CLEANUP = YES 2286DOT_CLEANUP = YES
1815
1816ALIASES += xmpp="<blockquote class=\"xmpp\">"
1817ALIASES += endxmpp="</blockquote>"