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