3
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.
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.
8
8
# TAG = value [value, ...]
9
9
# For lists items can also be appended using:
10
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
11
# Values that contain spaces should be placed between quotes (" ").
13
13
#---------------------------------------------------------------------------
14
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
20
PROJECT_NAME = Zorba XQuery Processor
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
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
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or sequence of words) that should
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.
29
PROJECT_NAME = "Zorba XQuery Processor"
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
# This could be handy for archiving the generated documentation or
24
33
# if some version control system is used.
26
35
PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38
# for a project that appears at the top of each page and should give viewer
39
# a quick idea about the purpose of the project. Keep the description short.
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.
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
31
53
# where doxygen was started. If left blank the current directory will be used.
33
55
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 4096 sub-directories (in 2 levels) under the output directory of each output
37
# format and will distribute the generated files over these directories.
38
# Enabling this option can be useful when feeding doxygen a huge amount of
39
# source files, where putting all generated files in the same directory would
57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58
# 4096 sub-directories (in 2 levels) under the output directory of each output
59
# format and will distribute the generated files over these directories.
60
# Enabling this option can be useful when feeding doxygen a huge amount of
61
# source files, where putting all generated files in the same directory would
40
62
# otherwise cause performance problems for the file system.
42
64
CREATE_SUBDIRS = NO
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45
# documentation generated by doxygen is written. Doxygen will use this
46
# information to generate all constant output in the proper language.
47
# The default language is English, other supported languages are:
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52
# Swedish, and Ukrainian.
66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67
# documentation generated by doxygen is written. Doxygen will use this
68
# information to generate all constant output in the proper language.
69
# The default language is English, other supported languages are:
70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
54
77
OUTPUT_LANGUAGE = English
56
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57
# include brief member descriptions after the members that are listed in
58
# the file and class documentation (similar to JavaDoc).
79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80
# include brief member descriptions after the members that are listed in
81
# the file and class documentation (similar to JavaDoc).
59
82
# Set to NO to disable this.
61
84
BRIEF_MEMBER_DESC = YES
63
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64
# the brief description of a member or function before the detailed description.
65
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87
# the brief description of a member or function before the detailed description.
88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66
89
# brief descriptions will be completely suppressed.
70
# This tag implements a quasi-intelligent brief description abbreviator
71
# that is used to form the text in various listings. Each string
72
# in this list, if found as the leading text of the brief description, will be
73
# stripped from the text and the result after processing the whole list, is
74
# used as the annotated text. Otherwise, the brief description is used as-is.
75
# If left blank, the following values are used ("$name" is automatically
76
# replaced with the name of the entity): "The $name class" "The $name widget"
77
# "The $name file" "is" "provides" "specifies" "contains"
93
# This tag implements a quasi-intelligent brief description abbreviator
94
# that is used to form the text in various listings. Each string
95
# in this list, if found as the leading text of the brief description, will be
96
# stripped from the text and the result after processing the whole list, is
97
# used as the annotated text. Otherwise, the brief description is used as-is.
98
# If left blank, the following values are used ("$name" is automatically
99
# replaced with the name of the entity): "The $name class" "The $name widget"
100
# "The $name file" "is" "provides" "specifies" "contains"
78
101
# "represents" "a" "an" "the"
82
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83
# Doxygen will generate a detailed section even if there is only a brief
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
# Doxygen will generate a detailed section even if there is only a brief
86
109
ALWAYS_DETAILED_SEC = NO
88
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89
# inherited members of a class in the documentation of that class as if those
90
# members were ordinary class members. Constructors, destructors and assignment
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112
# inherited members of a class in the documentation of that class as if those
113
# members were ordinary class members. Constructors, destructors and assignment
91
114
# operators of the base classes will not be shown.
93
116
INLINE_INHERITED_MEMB = YES
95
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96
# path before files name in the file list and in the header files. If set
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
# path before files name in the file list and in the header files. If set
97
120
# to NO the shortest path that makes the file name unique will be used.
99
122
FULL_PATH_NAMES = NO
101
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102
# can be used to strip a user-defined part of the path. Stripping is
103
# only done if one of the specified strings matches the left-hand part of
104
# the path. The tag can be used to show relative paths in the file list.
105
# If left blank the directory from which doxygen is run is used as the
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
# can be used to strip a user-defined part of the path. Stripping is
126
# only done if one of the specified strings matches the left-hand part of
127
# the path. The tag can be used to show relative paths in the file list.
128
# If left blank the directory from which doxygen is run is used as the
108
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src
111
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
112
# the path mentioned in the documentation of a class, which tells
113
# the reader which header file to include in order to use a class.
114
# If left blank only the name of the header file containing the class
115
# definition is used. Otherwise one should specify the include paths that
131
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
132
@CMAKE_BINARY_DIR@/src
134
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
135
# the path mentioned in the documentation of a class, which tells
136
# the reader which header file to include in order to use a class.
137
# If left blank only the name of the header file containing the class
138
# definition is used. Otherwise one should specify the include paths that
116
139
# are normally passed to the compiler using the -I flag.
118
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include
141
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
142
@CMAKE_BINARY_DIR@/include
120
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
121
# (but less readable) file names. This can be useful is your file systems
144
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145
# (but less readable) file names. This can be useful if your file system
122
146
# doesn't support long names like on DOS, Mac, or CD-ROM.
126
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
127
# will interpret the first line (until the first dot) of a JavaDoc-style
128
# comment as the brief description. If set to NO, the JavaDoc
129
# comments will behave just like the Qt-style comments (thus requiring an
130
# explicit @brief command for a brief description.
150
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151
# will interpret the first line (until the first dot) of a JavaDoc-style
152
# comment as the brief description. If set to NO, the JavaDoc
153
# comments will behave just like regular Qt-style comments
154
# (thus requiring an explicit @brief command for a brief description.)
132
156
JAVADOC_AUTOBRIEF = YES
134
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
135
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
136
# comments) as a brief description. This used to be the default behaviour.
137
# The new default is to treat a multi-line C++ comment block as a detailed
158
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159
# interpret the first line (until the first dot) of a Qt-style
160
# comment as the brief description. If set to NO, the comments
161
# will behave just like regular Qt-style comments (thus requiring
162
# an explicit \brief command for a brief description.)
166
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
168
# comments) as a brief description. This used to be the default behaviour.
169
# The new default is to treat a multi-line C++ comment block as a detailed
138
170
# description. Set this tag to YES if you prefer the old behaviour instead.
140
172
MULTILINE_CPP_IS_BRIEF = NO
142
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
143
# will output the detailed description near the top, like JavaDoc.
144
# If set to NO, the detailed description appears after the member
149
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150
# member inherits the documentation from any documented member that it
174
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175
# member inherits the documentation from any documented member that it
153
178
INHERIT_DOCS = YES
155
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156
# a new page for each member. If set to NO, the documentation of a member will
180
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181
# a new page for each member. If set to NO, the documentation of a member will
157
182
# be part of the file/class/namespace that contains it.
159
184
SEPARATE_MEMBER_PAGES = NO
161
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
186
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
162
187
# Doxygen uses this value to replace tabs by spaces in code fragments.
166
# This tag can be used to specify a number of aliases that acts
167
# as commands in the documentation. An alias has the form "name=value".
168
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
169
# put the command \sideeffect (or @sideeffect) in the documentation, which
170
# will result in a user-defined paragraph with heading "Side Effects:".
191
# This tag can be used to specify a number of aliases that acts
192
# as commands in the documentation. An alias has the form "name=value".
193
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
194
# put the command \sideeffect (or @sideeffect) in the documentation, which
195
# will result in a user-defined paragraph with heading "Side Effects:".
171
196
# You can put \n's in the value part of an alias to insert newlines.
175
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176
# sources only. Doxygen will then generate output that is more tailored for C.
177
# For instance, some of the names that are used will be different. The list
200
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
201
# sources only. Doxygen will then generate output that is more tailored for C.
202
# For instance, some of the names that are used will be different. The list
178
203
# of all members will be omitted, etc.
180
205
OPTIMIZE_OUTPUT_FOR_C = NO
182
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183
# sources only. Doxygen will then generate output that is more tailored for Java.
184
# For instance, namespaces will be presented as packages, qualified scopes
185
# will look different, etc.
207
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
208
# sources only. Doxygen will then generate output that is more tailored for
209
# Java. For instance, namespaces will be presented as packages, qualified
210
# scopes will look different, etc.
187
212
OPTIMIZE_OUTPUT_JAVA = NO
189
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
190
# include (a tag file for) the STL sources as input, then you should
191
# set this tag to YES in order to let doxygen match functions declarations and
192
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
193
# func(std::string) {}). This also make the inheritance and collaboration
214
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
215
# sources only. Doxygen will then generate output that is more tailored for
218
OPTIMIZE_FOR_FORTRAN = NO
220
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221
# sources. Doxygen will then generate output that is tailored for
224
OPTIMIZE_OUTPUT_VHDL = NO
226
# Doxygen selects the parser to use depending on the extension of the files it
227
# parses. With this tag you can assign which parser to use for a given extension.
228
# Doxygen has a built-in mapping, but you can override or extend it using this
229
# tag. The format is ext=language, where ext is a file extension, and language
230
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
231
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
232
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
233
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
234
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
238
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239
# to include (a tag file for) the STL sources as input, then you should
240
# set this tag to YES in order to let doxygen match functions declarations and
241
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242
# func(std::string) {}). This also makes the inheritance and collaboration
194
243
# diagrams that involve STL classes more complete and accurate.
196
# BUILTIN_STL_SUPPORT = NO
198
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
199
# tag is set to YES, then doxygen will reuse the documentation of the first
200
# member in the group (if any) for the other members of the group. By default
245
BUILTIN_STL_SUPPORT = NO
247
# If you use Microsoft's C++/CLI language, you should set this option to YES to
248
# enable parsing support.
252
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
253
# Doxygen will parse them like normal C++ but will assume all classes use public
254
# instead of private inheritance when no explicit protection keyword is present.
258
# For Microsoft's IDL there are propget and propput attributes to indicate getter
259
# and setter methods for a property. Setting this option to YES (the default)
260
# will make doxygen replace the get and set methods by a property in the
261
# documentation. This will only work if the methods are indeed getting or
262
# setting a simple type. If this is not the case, or you want to show the
263
# methods anyway, you should set this option to NO.
265
IDL_PROPERTY_SUPPORT = YES
267
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
268
# tag is set to YES, then doxygen will reuse the documentation of the first
269
# member in the group (if any) for the other members of the group. By default
201
270
# all members of a group must be documented explicitly.
203
272
DISTRIBUTE_GROUP_DOC = NO
205
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206
# the same type (for instance a group of public functions) to be put as a
207
# subgroup of that type (e.g. under the Public Functions section). Set it to
208
# NO to prevent subgrouping. Alternatively, this can be done per class using
274
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
275
# the same type (for instance a group of public functions) to be put as a
276
# subgroup of that type (e.g. under the Public Functions section). Set it to
277
# NO to prevent subgrouping. Alternatively, this can be done per class using
209
278
# the \nosubgrouping command.
211
280
SUBGROUPING = YES
282
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
283
# unions are shown inside the group in which they are included (e.g. using
284
# @ingroup) instead of on a separate page (for HTML and Man pages) or
285
# section (for LaTeX and RTF).
287
INLINE_GROUPED_CLASSES = NO
289
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
290
# unions with only public data fields will be shown inline in the documentation
291
# of the scope in which they are defined (i.e. file, namespace, or group
292
# documentation), provided this scope is documented. If set to NO (the default),
293
# structs, classes, and unions are shown on a separate page (for HTML and Man
294
# pages) or section (for LaTeX and RTF).
296
INLINE_SIMPLE_STRUCTS = NO
298
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
299
# is documented as struct, union, or enum with the name of the typedef. So
300
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
301
# with name TypeT. When disabled the typedef will appear as a member of a file,
302
# namespace, or class. And the struct will be named TypeS. This can typically
303
# be useful for C code in case the coding convention dictates that all compound
304
# types are typedef'ed and only the typedef is referenced, never the tag name.
306
TYPEDEF_HIDES_STRUCT = NO
308
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
309
# determine which symbols to keep in memory and which to flush to disk.
310
# When the cache is full, less often used symbols will be written to disk.
311
# For small to medium size projects (<1000 input files) the default value is
312
# probably good enough. For larger projects a too small cache size can cause
313
# doxygen to be busy swapping symbols to and from disk most of the time
314
# causing a significant performance penalty.
315
# If the system has enough physical memory increasing the cache will improve the
316
# performance by keeping more symbols in memory. Note that the value works on
317
# a logarithmic scale so increasing the size by one will roughly double the
318
# memory usage. The cache size is given by this formula:
319
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
320
# corresponding to a cache size of 2^16 = 65536 symbols
322
SYMBOL_CACHE_SIZE = 0
213
324
#---------------------------------------------------------------------------
214
325
# Build related configuration options
215
326
#---------------------------------------------------------------------------
217
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218
# documentation are documented, even if no documentation was available.
219
# Private class members and static file members will be hidden unless
328
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
329
# documentation are documented, even if no documentation was available.
330
# Private class members and static file members will be hidden unless
220
331
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
222
333
EXTRACT_ALL = YES
224
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
335
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225
336
# will be included in the documentation.
227
338
EXTRACT_PRIVATE = NO
229
# If the EXTRACT_STATIC tag is set to YES all static members of a file
340
# If the EXTRACT_STATIC tag is set to YES all static members of a file
230
341
# will be included in the documentation.
232
343
EXTRACT_STATIC = NO
234
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235
# defined locally in source files will be included in the documentation.
345
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
346
# defined locally in source files will be included in the documentation.
236
347
# If set to NO only classes defined in header files are included.
238
349
EXTRACT_LOCAL_CLASSES = YES
240
# This flag is only useful for Objective-C code. When set to YES local
241
# methods, which are defined in the implementation section but not in
242
# the interface are included in the documentation.
351
# This flag is only useful for Objective-C code. When set to YES local
352
# methods, which are defined in the implementation section but not in
353
# the interface are included in the documentation.
243
354
# If set to NO (the default) only methods in the interface are included.
245
356
EXTRACT_LOCAL_METHODS = NO
247
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
248
# undocumented members of documented classes, files or namespaces.
249
# If set to NO (the default) these members will be included in the
250
# various overviews, but no documentation section is generated.
358
# If this flag is set to YES, the members of anonymous namespaces will be
359
# extracted and appear in the documentation as a namespace called
360
# 'anonymous_namespace{file}', where file will be replaced with the base
361
# name of the file that contains the anonymous namespace. By default
362
# anonymous namespaces are hidden.
364
EXTRACT_ANON_NSPACES = NO
366
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
367
# undocumented members of documented classes, files or namespaces.
368
# If set to NO (the default) these members will be included in the
369
# various overviews, but no documentation section is generated.
251
370
# This option has no effect if EXTRACT_ALL is enabled.
253
372
HIDE_UNDOC_MEMBERS = YES
255
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
256
# undocumented classes that are normally visible in the class hierarchy.
257
# If set to NO (the default) these classes will be included in the various
374
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
375
# undocumented classes that are normally visible in the class hierarchy.
376
# If set to NO (the default) these classes will be included in the various
258
377
# overviews. This option has no effect if EXTRACT_ALL is enabled.
260
379
HIDE_UNDOC_CLASSES = YES
262
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263
# friend (class|struct|union) declarations.
264
# If set to NO (the default) these declarations will be included in the
381
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
382
# friend (class|struct|union) declarations.
383
# If set to NO (the default) these declarations will be included in the
267
386
HIDE_FRIEND_COMPOUNDS = NO
269
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
270
# documentation blocks found inside the body of a function.
271
# If set to NO (the default) these blocks will be appended to the
388
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
389
# documentation blocks found inside the body of a function.
390
# If set to NO (the default) these blocks will be appended to the
272
391
# function's detailed documentation block.
274
393
HIDE_IN_BODY_DOCS = NO
276
# The INTERNAL_DOCS tag determines if documentation
277
# that is typed after a \internal command is included. If the tag is set
278
# to NO (the default) then the documentation will be excluded.
395
# The INTERNAL_DOCS tag determines if documentation
396
# that is typed after a \internal command is included. If the tag is set
397
# to NO (the default) then the documentation will be excluded.
279
398
# Set it to YES to include the internal documentation.
281
400
INTERNAL_DOCS = NO
283
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284
# file names in lower-case letters. If set to YES upper-case letters are also
285
# allowed. This is useful if you have classes or files whose names only differ
286
# in case and if your file system supports case sensitive file names. Windows
402
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
403
# file names in lower-case letters. If set to YES upper-case letters are also
404
# allowed. This is useful if you have classes or files whose names only differ
405
# in case and if your file system supports case sensitive file names. Windows
287
406
# and Mac users are advised to set this option to NO.
289
408
CASE_SENSE_NAMES = YES
291
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292
# will show members with their full class and namespace scopes in the
410
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
411
# will show members with their full class and namespace scopes in the
293
412
# documentation. If set to YES the scope will be hidden.
295
414
HIDE_SCOPE_NAMES = NO
297
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
298
# will put a list of the files that are included by a file in the documentation
416
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
417
# will put a list of the files that are included by a file in the documentation
301
420
SHOW_INCLUDE_FILES = YES
303
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
422
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
423
# will list include files with double quotes in the documentation
424
# rather than with sharp brackets.
426
FORCE_LOCAL_INCLUDES = NO
428
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304
429
# is inserted in the documentation for inline members.
306
431
INLINE_INFO = YES
308
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
309
# will sort the (detailed) documentation of file and class members
310
# alphabetically by member name. If set to NO the members will appear in
433
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
434
# will sort the (detailed) documentation of file and class members
435
# alphabetically by member name. If set to NO the members will appear in
311
436
# declaration order.
313
438
SORT_MEMBER_DOCS = YES
315
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
316
# brief documentation of file, namespace and class members alphabetically
317
# by member name. If set to NO (the default) the members will appear in
440
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
441
# brief documentation of file, namespace and class members alphabetically
442
# by member name. If set to NO (the default) the members will appear in
318
443
# declaration order.
320
445
SORT_BRIEF_DOCS = YES
322
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
323
# sorted by fully-qualified names, including namespaces. If set to
324
# NO (the default), the class list will be sorted only by class name,
325
# not including the namespace part.
447
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
448
# will sort the (brief and detailed) documentation of class members so that
449
# constructors and destructors are listed first. If set to NO (the default)
450
# the constructors will appear in the respective orders defined by
451
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
452
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
453
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
455
SORT_MEMBERS_CTORS_1ST = NO
457
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
458
# hierarchy of group names into alphabetical order. If set to NO (the default)
459
# the group names will appear in their defined order.
461
SORT_GROUP_NAMES = NO
463
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
464
# sorted by fully-qualified names, including namespaces. If set to
465
# NO (the default), the class list will be sorted only by class name,
466
# not including the namespace part.
326
467
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327
# Note: This option applies only to the class list, not to the
468
# Note: This option applies only to the class list, not to the
328
469
# alphabetical list.
330
471
SORT_BY_SCOPE_NAME = NO
332
# The GENERATE_TODOLIST tag can be used to enable (YES) or
333
# disable (NO) the todo list. This list is created by putting \todo
473
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
474
# do proper type resolution of all parameters of a function it will reject a
475
# match between the prototype and the implementation of a member function even
476
# if there is only one candidate or it is obvious which candidate to choose
477
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
478
# will still accept a match between prototype and implementation in such cases.
480
STRICT_PROTO_MATCHING = NO
482
# The GENERATE_TODOLIST tag can be used to enable (YES) or
483
# disable (NO) the todo list. This list is created by putting \todo
334
484
# commands in the documentation.
336
486
GENERATE_TODOLIST = YES
338
# The GENERATE_TESTLIST tag can be used to enable (YES) or
339
# disable (NO) the test list. This list is created by putting \test
488
# The GENERATE_TESTLIST tag can be used to enable (YES) or
489
# disable (NO) the test list. This list is created by putting \test
340
490
# commands in the documentation.
342
492
GENERATE_TESTLIST = YES
344
# The GENERATE_BUGLIST tag can be used to enable (YES) or
345
# disable (NO) the bug list. This list is created by putting \bug
494
# The GENERATE_BUGLIST tag can be used to enable (YES) or
495
# disable (NO) the bug list. This list is created by putting \bug
346
496
# commands in the documentation.
348
498
GENERATE_BUGLIST = YES
350
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351
# disable (NO) the deprecated list. This list is created by putting
500
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
501
# disable (NO) the deprecated list. This list is created by putting
352
502
# \deprecated commands in the documentation.
354
504
GENERATE_DEPRECATEDLIST= YES
356
# The ENABLED_SECTIONS tag can be used to enable conditional
506
# The ENABLED_SECTIONS tag can be used to enable conditional
357
507
# documentation sections, marked by \if sectionname ... \endif.
359
509
ENABLED_SECTIONS =
361
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
362
# the initial value of a variable or define consists of for it to appear in
363
# the documentation. If the initializer consists of more lines than specified
364
# here it will be hidden. Use a value of 0 to hide initializers completely.
365
# The appearance of the initializer of individual variables and defines in the
366
# documentation can be controlled using \showinitializer or \hideinitializer
511
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
512
# the initial value of a variable or macro consists of for it to appear in
513
# the documentation. If the initializer consists of more lines than specified
514
# here it will be hidden. Use a value of 0 to hide initializers completely.
515
# The appearance of the initializer of individual variables and macros in the
516
# documentation can be controlled using \showinitializer or \hideinitializer
367
517
# command in the documentation regardless of this setting.
369
519
MAX_INITIALIZER_LINES = 30
371
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372
# at the bottom of the documentation of classes and structs. If set to YES the
521
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
522
# at the bottom of the documentation of classes and structs. If set to YES the
373
523
# list will mention the files that were used to generate the documentation.
375
525
SHOW_USED_FILES = YES
377
# If the sources in your project are distributed over multiple directories
378
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379
# in the documentation. The default is YES.
527
# If the sources in your project are distributed over multiple directories
528
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
529
# in the documentation. The default is NO.
381
531
SHOW_DIRECTORIES = YES
383
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
384
# doxygen should invoke to get the current version for each file (typically from the
385
# version control system). Doxygen will invoke the program by executing (via
386
# popen()) the command <command> <input-file>, where <command> is the value of
387
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388
# provided by doxygen. Whatever the program writes to standard output
533
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
534
# This will remove the Files entry from the Quick Index and from the
535
# Folder Tree View (if specified). The default is YES.
539
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
541
# This will remove the Namespaces entry from the Quick Index
542
# and from the Folder Tree View (if specified). The default is YES.
544
SHOW_NAMESPACES = YES
546
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
547
# doxygen should invoke to get the current version for each file (typically from
548
# the version control system). Doxygen will invoke the program by executing (via
549
# popen()) the command <command> <input-file>, where <command> is the value of
550
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
551
# provided by doxygen. Whatever the program writes to standard output
389
552
# is used as the file version. See the manual for examples.
391
FILE_VERSION_FILTER =
554
FILE_VERSION_FILTER =
556
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
557
# by doxygen. The layout file controls the global structure of the generated
558
# output files in an output format independent way. The create the layout file
559
# that represents doxygen's defaults, run doxygen with the -l option.
560
# You can optionally specify a file name after the option, if omitted
561
# DoxygenLayout.xml will be used as the name of the layout file.
565
# The CITE_BIB_FILES tag can be used to specify one or more bib files
566
# containing the references data. This must be a list of .bib files. The
567
# .bib extension is automatically appended if omitted. Using this command
568
# requires the bibtex tool to be installed. See also
569
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
570
# of the bibliography can be controlled using LATEX_BIB_STYLE.
393
574
#---------------------------------------------------------------------------
394
575
# configuration options related to warning and progress messages
395
576
#---------------------------------------------------------------------------
397
# The QUIET tag can be used to turn on/off the messages that are generated
578
# The QUIET tag can be used to turn on/off the messages that are generated
398
579
# by doxygen. Possible values are YES and NO. If left blank NO is used.
402
# The WARNINGS tag can be used to turn on/off the warning messages that are
403
# generated by doxygen. Possible values are YES and NO. If left blank
583
# The WARNINGS tag can be used to turn on/off the warning messages that are
584
# generated by doxygen. Possible values are YES and NO. If left blank
408
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
409
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
589
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
590
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410
591
# automatically be disabled.
412
593
WARN_IF_UNDOCUMENTED = YES
414
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
415
# potential errors in the documentation, such as not documenting some
416
# parameters in a documented function, or documenting parameters that
595
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
596
# potential errors in the documentation, such as not documenting some
597
# parameters in a documented function, or documenting parameters that
417
598
# don't exist or using markup commands wrongly.
419
600
WARN_IF_DOC_ERROR = YES
421
# This WARN_NO_PARAMDOC option can be abled to get warnings for
422
# functions that are documented, but have no documentation for their parameters
423
# or return value. If set to NO (the default) doxygen will only warn about
424
# wrong or incomplete parameter documentation, but not about the absence of
602
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
603
# functions that are documented, but have no documentation for their parameters
604
# or return value. If set to NO (the default) doxygen will only warn about
605
# wrong or incomplete parameter documentation, but not about the absence of
427
608
WARN_NO_PARAMDOC = NO
429
# The WARN_FORMAT tag determines the format of the warning messages that
430
# doxygen can produce. The string should contain the $file, $line, and $text
431
# tags, which will be replaced by the file and line number from which the
432
# warning originated and the warning text. Optionally the format may contain
433
# $version, which will be replaced by the version of the file (if it could
610
# The WARN_FORMAT tag determines the format of the warning messages that
611
# doxygen can produce. The string should contain the $file, $line, and $text
612
# tags, which will be replaced by the file and line number from which the
613
# warning originated and the warning text. Optionally the format may contain
614
# $version, which will be replaced by the version of the file (if it could
434
615
# be obtained via FILE_VERSION_FILTER)
436
617
WARN_FORMAT = @DOXY_WARN_FORMAT@
438
# The WARN_LOGFILE tag can be used to specify a file to which warning
439
# and error messages should be written. If left blank the output is written
619
# The WARN_LOGFILE tag can be used to specify a file to which warning
620
# and error messages should be written. If left blank the output is written
442
623
WARN_LOGFILE = Doc/doxy.log
612
833
# configuration options related to the alphabetical class index
613
834
#---------------------------------------------------------------------------
615
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
616
# of all compounds will be generated. Enable this if the project
836
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
837
# of all compounds will be generated. Enable this if the project
617
838
# contains a lot of classes, structs, unions or interfaces.
619
840
ALPHABETICAL_INDEX = YES
621
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
622
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
842
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
843
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
623
844
# in which this list will be split (can be a number in the range [1..20])
625
846
COLS_IN_ALPHA_INDEX = 2
627
# In case all classes in a project start with a common prefix, all
628
# classes will be put under the same header in the alphabetical index.
629
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
848
# In case all classes in a project start with a common prefix, all
849
# classes will be put under the same header in the alphabetical index.
850
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
630
851
# should be ignored while generating the index headers.
634
855
#---------------------------------------------------------------------------
635
856
# configuration options related to the HTML output
636
857
#---------------------------------------------------------------------------
638
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
859
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
639
860
# generate HTML output.
641
862
GENERATE_HTML = YES
643
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
644
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
864
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
865
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
645
866
# put in front of it. If left blank `html' will be used as the default path.
647
868
HTML_OUTPUT = html
649
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
650
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
870
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
871
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
651
872
# doxygen will generate files with .html extension.
653
874
HTML_FILE_EXTENSION = .html
655
# The HTML_HEADER tag can be used to specify a personal HTML header for
656
# each generated HTML page. If it is left blank doxygen will generate a
876
# The HTML_HEADER tag can be used to specify a personal HTML header for
877
# each generated HTML page. If it is left blank doxygen will generate a
878
# standard header. Note that when using a custom header you are responsible
879
# for the proper inclusion of any scripts and style sheets that doxygen
880
# needs, which is dependent on the configuration options used.
881
# It is adviced to generate a default header using "doxygen -w html
882
# header.html footer.html stylesheet.css YourConfigFile" and then modify
883
# that header. Note that the header is subject to change so you typically
884
# have to redo this when upgrading to a newer version of doxygen or when
885
# changing the value of configuration settings such as GENERATE_TREEVIEW!
658
887
HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
661
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
662
# each generated HTML page. If it is left blank doxygen will generate a
889
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
890
# each generated HTML page. If it is left blank doxygen will generate a
663
891
# standard footer.
665
893
HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
667
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
668
# style sheet that is used by each HTML page. It can be used to
669
# fine-tune the look of the HTML output. If the tag is left blank doxygen
670
# will generate a default style sheet. Note that doxygen will try to copy
671
# the style sheet file to the HTML output directory, so don't put your own
895
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
899
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
900
# style sheet that is used by each HTML page. It can be used to
901
# fine-tune the look of the HTML output. If the tag is left blank doxygen
902
# will generate a default style sheet. Note that doxygen will try to copy
903
# the style sheet file to the HTML output directory, so don't put your own
672
904
# stylesheet in the HTML output directory as well, or it will be erased!
674
906
HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
676
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
677
# files or namespaces will be aligned in HTML using tables. If set to
908
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
909
# other source files which should be copied to the HTML output directory. Note
910
# that these files will be copied to the base HTML output directory. Use the
911
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
912
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
913
# the files will be copied as-is; there are no commands or markers available.
917
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
918
# Doxygen will adjust the colors in the stylesheet and background images
919
# according to this color. Hue is specified as an angle on a colorwheel,
920
# see http://en.wikipedia.org/wiki/Hue for more information.
921
# For instance the value 0 represents red, 60 is yellow, 120 is green,
922
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
923
# The allowed range is 0 to 359.
925
HTML_COLORSTYLE_HUE = 220
927
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
928
# the colors in the HTML output. For a value of 0 the output will use
929
# grayscales only. A value of 255 will produce the most vivid colors.
931
HTML_COLORSTYLE_SAT = 100
933
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
934
# the luminance component of the colors in the HTML output. Values below
935
# 100 gradually make the output lighter, whereas values above 100 make
936
# the output darker. The value divided by 100 is the actual gamma applied,
937
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
938
# and 100 does not change the gamma.
940
HTML_COLORSTYLE_GAMMA = 80
942
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
943
# page will contain the date and time when the page was generated. Setting
944
# this to NO can help when comparing the output of multiple runs.
948
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
949
# files or namespaces will be aligned in HTML using tables. If set to
678
950
# NO a bullet list will be used.
680
952
HTML_ALIGN_MEMBERS = YES
682
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
683
# will be generated that can be used as input for tools like the
684
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
954
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
955
# documentation will contain sections that can be hidden and shown after the
956
# page has loaded. For this to work a browser that supports
957
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
958
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
960
HTML_DYNAMIC_SECTIONS = NO
962
# If the GENERATE_DOCSET tag is set to YES, additional index files
963
# will be generated that can be used as input for Apple's Xcode 3
964
# integrated development environment, introduced with OSX 10.5 (Leopard).
965
# To create a documentation set, doxygen will generate a Makefile in the
966
# HTML output directory. Running make will produce the docset in that
967
# directory and running "make install" will install the docset in
968
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
970
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
971
# for more information.
975
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
976
# feed. A documentation feed provides an umbrella under which multiple
977
# documentation sets from a single provider (such as a company or product suite)
980
DOCSET_FEEDNAME = "Doxygen generated docs"
982
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
983
# should uniquely identify the documentation set bundle. This should be a
984
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
985
# will append .docset to the name.
987
DOCSET_BUNDLE_ID = org.doxygen.Project
989
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
990
# the documentation publisher. This should be a reverse domain-name style
991
# string, e.g. com.mycompany.MyDocSet.documentation.
993
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
995
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
997
DOCSET_PUBLISHER_NAME = Publisher
999
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1000
# will be generated that can be used as input for tools like the
1001
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
685
1002
# of the generated HTML documentation.
687
1004
GENERATE_HTMLHELP = YES
689
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
690
# be used to specify the file name of the resulting .chm file. You
691
# can add a path in front of the file if the result should not be
1006
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1007
# be used to specify the file name of the resulting .chm file. You
1008
# can add a path in front of the file if the result should not be
692
1009
# written to the html output directory.
696
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
697
# be used to specify the location (absolute path including file name) of
698
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1013
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1014
# be used to specify the location (absolute path including file name) of
1015
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
699
1016
# the HTML help compiler on the generated index.hhp.
703
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
704
# controls if a separate .chi index file is generated (YES) or that
1020
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1021
# controls if a separate .chi index file is generated (YES) or that
705
1022
# it should be included in the master .chm file (NO).
707
1024
GENERATE_CHI = NO
709
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
710
# controls whether a binary table of contents is generated (YES) or a
1026
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1027
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1030
CHM_INDEX_ENCODING =
1032
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1033
# controls whether a binary table of contents is generated (YES) or a
711
1034
# normal table of contents (NO) in the .chm file.
715
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1038
# The TOC_EXPAND flag can be set to YES to add extra items for group members
716
1039
# to the contents of the HTML help documentation and to the tree view.
720
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
721
# top of each HTML page. The value NO (the default) enables the index and
1043
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1044
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1045
# that can be used as input for Qt's qhelpgenerator to generate a
1046
# Qt Compressed Help (.qch) of the generated HTML documentation.
1050
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1051
# be used to specify the file name of the resulting .qch file.
1052
# The path specified is relative to the HTML output folder.
1056
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1057
# Qt Help Project output. For more information please see
1058
# http://doc.trolltech.com/qthelpproject.html#namespace
1060
QHP_NAMESPACE = org.doxygen.Project
1062
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1063
# Qt Help Project output. For more information please see
1064
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1066
QHP_VIRTUAL_FOLDER = doc
1068
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1069
# add. For more information please see
1070
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1072
QHP_CUST_FILTER_NAME =
1074
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1075
# custom filter to add. For more information please see
1076
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1077
# Qt Help Project / Custom Filters</a>.
1079
QHP_CUST_FILTER_ATTRS =
1081
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1083
# filter section matches.
1084
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1085
# Qt Help Project / Filter Attributes</a>.
1087
QHP_SECT_FILTER_ATTRS =
1089
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1090
# be used to specify the location of Qt's qhelpgenerator.
1091
# If non-empty doxygen will try to run qhelpgenerator on the generated
1096
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1097
# will be generated, which together with the HTML files, form an Eclipse help
1098
# plugin. To install this plugin and make it available under the help contents
1099
# menu in Eclipse, the contents of the directory containing the HTML and XML
1100
# files needs to be copied into the plugins directory of eclipse. The name of
1101
# the directory within the plugins directory should be the same as
1102
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1105
GENERATE_ECLIPSEHELP = NO
1107
# A unique identifier for the eclipse help plugin. When installing the plugin
1108
# the directory name containing the HTML and XML files should also have
1111
ECLIPSE_DOC_ID = org.doxygen.Project
1113
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1114
# top of each HTML page. The value NO (the default) enables the index and
722
1115
# the value YES disables it.
724
1117
DISABLE_INDEX = NO
726
# This tag can be used to set the number of enum values (range [1..20])
727
# that doxygen will group on one line in the generated HTML documentation.
1119
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1120
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1121
# documentation. Note that a value of 0 will completely suppress the enum
1122
# values from appearing in the overview section.
729
1124
ENUM_VALUES_PER_LINE = 4
731
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
732
# generated containing a tree-like index structure (just like the one that
733
# is generated for HTML Help). For this to work a browser that supports
734
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
735
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
736
# probably better off using the HTML help feature.
1126
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1127
# structure should be generated to display hierarchical information.
1128
# If the tag value is set to YES, a side panel will be generated
1129
# containing a tree-like index structure (just like the one that
1130
# is generated for HTML Help). For this to work a browser that supports
1131
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1132
# Windows users are probably better off using the HTML help feature.
738
1134
GENERATE_TREEVIEW = NO
740
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
741
# used to set the initial width (in pixels) of the frame in which the tree
1136
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1137
# and Class Hierarchy pages using a tree view instead of an ordered list.
1139
USE_INLINE_TREES = NO
1141
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1142
# used to set the initial width (in pixels) of the frame in which the tree
744
1145
TREEVIEW_WIDTH = 250
1147
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1148
# links to external symbols imported via tag files in a separate window.
1150
EXT_LINKS_IN_WINDOW = NO
1152
# Use this tag to change the font size of Latex formulas included
1153
# as images in the HTML documentation. The default is 10. Note that
1154
# when you change the font size after a successful doxygen run you need
1155
# to manually remove any form_*.png images from the HTML output directory
1156
# to force them to be regenerated.
1158
FORMULA_FONTSIZE = 10
1160
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1161
# generated for formulas are transparent PNGs. Transparent PNGs are
1162
# not supported properly for IE 6.0, but are supported on all modern browsers.
1163
# Note that when changing this option you need to delete any form_*.png files
1164
# in the HTML output before the changes have effect.
1166
FORMULA_TRANSPARENT = YES
1168
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1169
# (see http://www.mathjax.org) which uses client side Javascript for the
1170
# rendering instead of using prerendered bitmaps. Use this if you do not
1171
# have LaTeX installed or if you want to formulas look prettier in the HTML
1172
# output. When enabled you also need to install MathJax separately and
1173
# configure the path to it using the MATHJAX_RELPATH option.
1177
# When MathJax is enabled you need to specify the location relative to the
1178
# HTML output directory using the MATHJAX_RELPATH option. The destination
1179
# directory should contain the MathJax.js script. For instance, if the mathjax
1180
# directory is located at the same level as the HTML output directory, then
1181
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1182
# mathjax.org site, so you can quickly see the result without installing
1183
# MathJax, but it is strongly recommended to install a local copy of MathJax
1184
# before deployment.
1186
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1188
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1189
# names that should be enabled during MathJax rendering.
1191
MATHJAX_EXTENSIONS =
1193
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1194
# for the HTML output. The underlying search engine uses javascript
1195
# and DHTML and should work on any modern browser. Note that when using
1196
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1197
# (GENERATE_DOCSET) there is already a search function so this one should
1198
# typically be disabled. For large projects the javascript based search engine
1199
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1203
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1204
# implemented using a PHP enabled web server instead of at the web client
1205
# using Javascript. Doxygen will generate the search PHP script and index
1206
# file to put on the web server. The advantage of the server
1207
# based approach is that it scales better to large projects and allows
1208
# full text search. The disadvantages are that it is more difficult to setup
1209
# and does not have live searching capabilities.
1211
SERVER_BASED_SEARCH = NO
746
1213
#---------------------------------------------------------------------------
747
1214
# configuration options related to the LaTeX output
748
1215
#---------------------------------------------------------------------------
750
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1217
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
751
1218
# generate Latex output.
753
1220
GENERATE_LATEX = NO
755
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
756
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1222
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1223
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
757
1224
# put in front of it. If left blank `latex' will be used as the default path.
759
1226
LATEX_OUTPUT = latex
761
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1228
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
762
1229
# invoked. If left blank `latex' will be used as the default command name.
764
#LATEX_CMD_NAME = latex
765
LATEX_CMD_NAME = @LATEX_COMPILER@
767
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
768
# generate index for LaTeX. If left blank `makeindex' will be used as the
1230
# Note that when enabling USE_PDFLATEX this option is only used for
1231
# generating bitmaps for formulas in the HTML output, but not in the
1232
# Makefile that is written to the output directory.
1234
LATEX_CMD_NAME = @LATEX_COMPILER@
1236
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1237
# generate index for LaTeX. If left blank `makeindex' will be used as the
769
1238
# default command name.
771
#MAKEINDEX_CMD_NAME = makeindex
772
1240
MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
774
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
775
# LaTeX documents. This may be useful for small projects and may help to
1242
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1243
# LaTeX documents. This may be useful for small projects and may help to
776
1244
# save some trees in general.
778
1246
COMPACT_LATEX = NO
780
# The PAPER_TYPE tag can be used to set the paper type that is used
781
# by the printer. Possible values are: a4, a4wide, letter, legal and
1248
# The PAPER_TYPE tag can be used to set the paper type that is used
1249
# by the printer. Possible values are: a4, letter, legal and
782
1250
# executive. If left blank a4wide will be used.
786
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1254
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
787
1255
# packages that should be included in the LaTeX output.
791
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
792
# the generated latex document. The header should contain everything until
793
# the first chapter. If it is left blank doxygen will generate a
1259
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1260
# the generated latex document. The header should contain everything until
1261
# the first chapter. If it is left blank doxygen will generate a
794
1262
# standard header. Notice: only use this tag if you know what you are doing!
798
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
799
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
800
# contain links (just like the HTML output) instead of page references
1266
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1267
# the generated latex document. The footer should contain everything after
1268
# the last chapter. If it is left blank doxygen will generate a
1269
# standard footer. Notice: only use this tag if you know what you are doing!
1273
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1274
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1275
# contain links (just like the HTML output) instead of page references
801
1276
# This makes the output suitable for online browsing using a pdf viewer.
803
1278
PDF_HYPERLINKS = YES
805
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
806
# plain latex in the generated Makefile. Set this option to YES to get a
1280
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1281
# plain latex in the generated Makefile. Set this option to YES to get a
807
1282
# higher quality PDF documentation.
809
1284
USE_PDFLATEX = YES
811
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
812
# command to the generated LaTeX files. This will instruct LaTeX to keep
813
# running if errors occur, instead of asking the user for help.
1286
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1287
# command to the generated LaTeX files. This will instruct LaTeX to keep
1288
# running if errors occur, instead of asking the user for help.
814
1289
# This option is also used when generating formulas in HTML.
816
1291
LATEX_BATCHMODE = YES
818
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
819
# include the index chapters (such as File Index, Compound Index, etc.)
1293
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1294
# include the index chapters (such as File Index, Compound Index, etc.)
820
1295
# in the output.
822
1297
LATEX_HIDE_INDICES = NO
1299
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1300
# source code with syntax highlighting in the LaTeX output.
1301
# Note that which sources are shown also depends on other settings
1302
# such as SOURCE_BROWSER.
1304
LATEX_SOURCE_CODE = NO
1306
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1307
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1308
# http://en.wikipedia.org/wiki/BibTeX for more info.
1310
LATEX_BIB_STYLE = plain
824
1312
#---------------------------------------------------------------------------
825
1313
# configuration options related to the RTF output
826
1314
#---------------------------------------------------------------------------
828
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
829
# The RTF output is optimized for Word 97 and may not look very pretty with
1316
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1317
# The RTF output is optimized for Word 97 and may not look very pretty with
830
1318
# other RTF readers or editors.
832
1320
GENERATE_RTF = NO
834
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
835
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1322
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1323
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
836
1324
# put in front of it. If left blank `rtf' will be used as the default path.
838
1326
RTF_OUTPUT = rtf
840
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
841
# RTF documents. This may be useful for small projects and may help to
1328
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1329
# RTF documents. This may be useful for small projects and may help to
842
1330
# save some trees in general.
844
1332
COMPACT_RTF = NO
846
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
847
# will contain hyperlink fields. The RTF file will
848
# contain links (just like the HTML output) instead of page references.
849
# This makes the output suitable for online browsing using WORD or other
850
# programs which support those fields.
1334
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1335
# will contain hyperlink fields. The RTF file will
1336
# contain links (just like the HTML output) instead of page references.
1337
# This makes the output suitable for online browsing using WORD or other
1338
# programs which support those fields.
851
1339
# Note: wordpad (write) and others do not support links.
853
1341
RTF_HYPERLINKS = NO
855
# Load stylesheet definitions from file. Syntax is similar to doxygen's
856
# config file, i.e. a series of assignments. You only have to provide
1343
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1344
# config file, i.e. a series of assignments. You only have to provide
857
1345
# replacements, missing definitions are set to their default value.
859
RTF_STYLESHEET_FILE =
1347
RTF_STYLESHEET_FILE =
861
# Set optional variables used in the generation of an rtf document.
1349
# Set optional variables used in the generation of an rtf document.
862
1350
# Syntax is similar to doxygen's config file.
864
RTF_EXTENSIONS_FILE =
1352
RTF_EXTENSIONS_FILE =
866
1354
#---------------------------------------------------------------------------
867
1355
# configuration options related to the man page output
868
1356
#---------------------------------------------------------------------------
870
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1358
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
871
1359
# generate man pages
873
1361
GENERATE_MAN = NO
875
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
876
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1363
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1364
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
877
1365
# put in front of it. If left blank `man' will be used as the default path.
879
1367
MAN_OUTPUT = man
881
# The MAN_EXTENSION tag determines the extension that is added to
1369
# The MAN_EXTENSION tag determines the extension that is added to
882
1370
# the generated man pages (default is the subroutine's section .3)
884
1372
MAN_EXTENSION = .3
886
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
887
# then it will generate one additional man file for each entity
888
# documented in the real man page(s). These additional files
889
# only source the real man page, but without them the man command
1374
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1375
# then it will generate one additional man file for each entity
1376
# documented in the real man page(s). These additional files
1377
# only source the real man page, but without them the man command
890
1378
# would be unable to find the correct page. The default is NO.
942
1430
# configuration options related to the Perl module output
943
1431
#---------------------------------------------------------------------------
945
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
946
# generate a Perl module file that captures the structure of
947
# the code including all documentation. Note that this
948
# feature is still experimental and incomplete at the
1433
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1434
# generate a Perl module file that captures the structure of
1435
# the code including all documentation. Note that this
1436
# feature is still experimental and incomplete at the
951
1439
GENERATE_PERLMOD = NO
953
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
954
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1441
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1442
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
955
1443
# to generate PDF and DVI output from the Perl module output.
957
1445
PERLMOD_LATEX = NO
959
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
960
# nicely formatted so it can be parsed by a human reader. This is useful
961
# if you want to understand what is going on. On the other hand, if this
962
# tag is set to NO the size of the Perl module output will be much smaller
1447
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1448
# nicely formatted so it can be parsed by a human reader.
1450
# if you want to understand what is going on.
1451
# On the other hand, if this
1452
# tag is set to NO the size of the Perl module output will be much smaller
963
1453
# and Perl will parse it just the same.
965
1455
PERLMOD_PRETTY = YES
967
# The names of the make variables in the generated doxyrules.make file
968
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
969
# This is useful so different doxyrules.make files included by the same
1457
# The names of the make variables in the generated doxyrules.make file
1458
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1459
# This is useful so different doxyrules.make files included by the same
970
1460
# Makefile don't overwrite each other's variables.
972
PERLMOD_MAKEVAR_PREFIX =
974
#---------------------------------------------------------------------------
975
# Configuration options related to the preprocessor
976
#---------------------------------------------------------------------------
978
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
979
# evaluate all C-preprocessor directives found in the sources and include
1462
PERLMOD_MAKEVAR_PREFIX =
1464
#---------------------------------------------------------------------------
1465
# Configuration options related to the preprocessor
1466
#---------------------------------------------------------------------------
1468
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1469
# evaluate all C-preprocessor directives found in the sources and include
982
1472
ENABLE_PREPROCESSING = YES
984
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
985
# names in the source code. If set to NO (the default) only conditional
986
# compilation will be performed. Macro expansion can be done in a controlled
1474
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1475
# names in the source code. If set to NO (the default) only conditional
1476
# compilation will be performed. Macro expansion can be done in a controlled
987
1477
# way by setting EXPAND_ONLY_PREDEF to YES.
989
1479
MACRO_EXPANSION = YES
991
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
992
# then the macro expansion is limited to the macros specified with the
1481
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1482
# then the macro expansion is limited to the macros specified with the
993
1483
# PREDEFINED and EXPAND_AS_DEFINED tags.
995
1485
EXPAND_ONLY_PREDEF = YES
997
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
998
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1487
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1488
# pointed to by INCLUDE_PATH will be searched when a #include is found.
1000
1490
SEARCH_INCLUDES = YES
1002
# The INCLUDE_PATH tag can be used to specify one or more directories that
1003
# contain include files that are not input files but should be processed by
1492
# The INCLUDE_PATH tag can be used to specify one or more directories that
1493
# contain include files that are not input files but should be processed by
1004
1494
# the preprocessor.
1007
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1008
# patterns (like *.h and *.hpp) to filter out the header-files in the
1009
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1498
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1499
# patterns (like *.h and *.hpp) to filter out the header-files in the
1500
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1012
INCLUDE_FILE_PATTERNS =
1503
INCLUDE_FILE_PATTERNS =
1014
# The PREDEFINED tag can be used to specify one or more macro names that
1015
# are defined before the preprocessor is started (similar to the -D option of
1016
# gcc). The argument of the tag is a list of macros of the form: name
1017
# or name=definition (no spaces). If the definition and the = are
1018
# omitted =1 is assumed. To prevent a macro definition from being
1019
# undefined via #undef or recursively expanded use the := operator
1505
# The PREDEFINED tag can be used to specify one or more macro names that
1506
# are defined before the preprocessor is started (similar to the -D option of
1507
# gcc). The argument of the tag is a list of macros of the form: name
1508
# or name=definition (no spaces). If the definition and the = are
1509
# omitted =1 is assumed. To prevent a macro definition from being
1510
# undefined via #undef or recursively expanded use the := operator
1020
1511
# instead of the = operator.
1024
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1025
# this tag can be used to specify a list of macro names that should be expanded.
1026
# The macro definition that is found in the sources will be used.
1027
# Use the PREDEFINED tag if you want to use a different macro definition.
1031
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1032
# doxygen's preprocessor will remove all function-like macros that are alone
1033
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1034
# function macros are typically used for boiler-plate code, and will confuse
1035
# the parser if not removed.
1515
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1516
# this tag can be used to specify a list of macro names that should be expanded.
1517
# The macro definition that is found in the sources will be used.
1518
# Use the PREDEFINED tag if you want to use a different macro definition that
1519
# overrules the definition found in the source code.
1523
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1524
# doxygen's preprocessor will remove all references to function-like macros
1525
# that are alone on a line, have an all uppercase name, and do not end with a
1526
# semicolon, because these will confuse the parser if not removed.
1037
1528
SKIP_FUNCTION_MACROS = YES
1039
1530
#---------------------------------------------------------------------------
1040
# Configuration::additions related to external references
1531
# Configuration::additions related to external references
1041
1532
#---------------------------------------------------------------------------
1043
# The TAGFILES option can be used to specify one or more tagfiles.
1044
# Optionally an initial location of the external documentation
1045
# can be added for each tagfile. The format of a tag file without
1046
# this location is as follows:
1047
# TAGFILES = file1 file2 ...
1048
# Adding location for the tag files is done as follows:
1049
# TAGFILES = file1=loc1 "file2 = loc2" ...
1050
# where "loc1" and "loc2" can be relative or absolute paths or
1051
# URLs. If a location is present for each tag, the installdox tool
1534
# The TAGFILES option can be used to specify one or more tagfiles.
1535
# Optionally an initial location of the external documentation
1536
# can be added for each tagfile. The format of a tag file without
1537
# this location is as follows:
1539
# TAGFILES = file1 file2 ...
1540
# Adding location for the tag files is done as follows:
1542
# TAGFILES = file1=loc1 "file2 = loc2" ...
1543
# where "loc1" and "loc2" can be relative or absolute paths or
1544
# URLs. If a location is present for each tag, the installdox tool
1052
1545
# does not have to be run to correct the links.
1053
1546
# Note that each tag file must have a unique name
1054
1547
# (where the name does NOT include the path)
1055
# If a tag file is not located in the directory in which doxygen
1548
# If a tag file is not located in the directory in which doxygen
1056
1549
# is run, you must also specify the path to the tagfile here.
1060
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1553
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1061
1554
# a tag file that is based on the input files it reads.
1063
1556
GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
1065
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1066
# in the class index. If set to NO only the inherited external classes
1558
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1559
# in the class index. If set to NO only the inherited external classes
1067
1560
# will be listed.
1069
1562
ALLEXTERNALS = YES
1071
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1072
# in the modules index. If set to NO, only the current project's groups will
1564
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1565
# in the modules index. If set to NO, only the current project's groups will
1075
1568
EXTERNAL_GROUPS = YES
1077
# The PERL_PATH should be the absolute path and name of the perl script
1570
# The PERL_PATH should be the absolute path and name of the perl script
1078
1571
# interpreter (i.e. the result of `which perl').
1080
1573
PERL_PATH = /usr/bin/perl
1082
1575
#---------------------------------------------------------------------------
1083
# Configuration options related to the dot tool
1576
# Configuration options related to the dot tool
1084
1577
#---------------------------------------------------------------------------
1086
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1087
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1088
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1089
# this option is superseded by the HAVE_DOT option below. This is only a
1090
# fallback. It is recommended to install and use dot, since it yields more
1579
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1580
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1581
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1582
# this option also works with HAVE_DOT disabled, but it is recommended to
1583
# install and use dot, since it yields more powerful graphs.
1093
1585
CLASS_DIAGRAMS = YES
1095
# If set to YES, the inheritance and collaboration graphs will hide
1096
# inheritance and usage relations if the target is undocumented
1587
# You can define message sequence charts within doxygen comments using the \msc
1588
# command. Doxygen will then run the mscgen tool (see
1589
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1590
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1591
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1592
# default search path.
1596
# If set to YES, the inheritance and collaboration graphs will hide
1597
# inheritance and usage relations if the target is undocumented
1097
1598
# or is not a class.
1099
1600
HIDE_UNDOC_RELATIONS = YES
1101
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1102
# available from the path. This tool is part of Graphviz, a graph visualization
1103
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1602
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1603
# available from the path. This tool is part of Graphviz, a graph visualization
1604
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1104
1605
# have no effect if this option is set to NO (the default)
1106
1607
HAVE_DOT = @DOXYGEN_DOT_FOUND@
1108
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1109
# will generate a graph for each documented class showing the direct and
1110
# indirect inheritance relations. Setting this tag to YES will force the
1609
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1610
# allowed to run in parallel. When set to 0 (the default) doxygen will
1611
# base this on the number of processors available in the system. You can set it
1612
# explicitly to a value larger than 0 to get control over the balance
1613
# between CPU load and processing speed.
1617
# By default doxygen will use the Helvetica font for all dot files that
1618
# doxygen generates. When you want a differently looking font you can specify
1619
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1620
# the font, which can be done by putting it in a standard location or by setting
1621
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1622
# directory containing the font.
1624
DOT_FONTNAME = Helvetica
1626
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1627
# The default size is 10pt.
1631
# By default doxygen will tell dot to use the Helvetica font.
1632
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1633
# set the path where dot can find it.
1637
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1638
# will generate a graph for each documented class showing the direct and
1639
# indirect inheritance relations. Setting this tag to YES will force the
1111
1640
# the CLASS_DIAGRAMS tag to NO.
1113
1642
CLASS_GRAPH = YES
1115
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1116
# will generate a graph for each documented class showing the direct and
1117
# indirect implementation dependencies (inheritance, containment, and
1644
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1645
# will generate a graph for each documented class showing the direct and
1646
# indirect implementation dependencies (inheritance, containment, and
1118
1647
# class references variables) of the class with other documented classes.
1120
1649
COLLABORATION_GRAPH = YES
1122
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1651
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1123
1652
# will generate a graph for groups, showing the direct groups dependencies
1125
1654
GROUP_GRAPHS = YES
1127
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1128
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1656
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1657
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1134
# If set to YES, the inheritance and collaboration graphs will show the
1662
# If set to YES, the inheritance and collaboration graphs will show the
1135
1663
# relations between templates and their instances.
1137
1665
TEMPLATE_RELATIONS = YES
1139
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1140
# tags are set to YES then doxygen will generate a graph for each documented
1141
# file showing the direct and indirect include dependencies of the file with
1667
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1668
# tags are set to YES then doxygen will generate a graph for each documented
1669
# file showing the direct and indirect include dependencies of the file with
1142
1670
# other documented files.
1144
1672
INCLUDE_GRAPH = YES
1146
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1147
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1148
# documented header file showing the documented files that directly or
1674
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1675
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1676
# documented header file showing the documented files that directly or
1149
1677
# indirectly include this file.
1151
1679
INCLUDED_BY_GRAPH = YES
1153
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1154
# generate a call dependency graph for every global function or class method.
1155
# Note that enabling this option will significantly increase the time of a run.
1156
# So in most cases it will be better to enable call graphs for selected
1157
# functions only using the \callgraph command.
1681
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1682
# doxygen will generate a call dependency graph for every global function
1683
# or class method. Note that enabling this option will significantly increase
1684
# the time of a run. So in most cases it will be better to enable call graphs
1685
# for selected functions only using the \callgraph command.
1159
1687
CALL_GRAPH = NO
1161
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1162
# will graphical hierarchy of all classes instead of a textual one.
1689
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1690
# doxygen will generate a caller dependency graph for every global function
1691
# or class method. Note that enabling this option will significantly increase
1692
# the time of a run. So in most cases it will be better to enable caller
1693
# graphs for selected functions only using the \callergraph command.
1697
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1698
# will generate a graphical hierarchy of all classes instead of a textual one.
1164
1700
GRAPHICAL_HIERARCHY = YES
1166
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1167
# then doxygen will show the dependencies a directory has on other directories
1702
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1703
# then doxygen will show the dependencies a directory has on other directories
1168
1704
# in a graphical way. The dependency relations are determined by the #include
1169
1705
# relations between the files in the directories.
1171
1707
DIRECTORY_GRAPH = YES
1173
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1174
# generated by dot. Possible values are png, jpg, or gif
1175
# If left blank png will be used.
1709
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1710
# generated by dot. Possible values are svg, png, jpg, or gif.
1711
# If left blank png will be used. If you choose svg you need to set
1712
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1713
# visible in IE 9+ (other browsers do not have this requirement).
1177
1715
DOT_IMAGE_FORMAT = png
1179
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1717
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1718
# enable generation of interactive SVG images that allow zooming and panning.
1719
# Note that this requires a modern browser other than Internet Explorer.
1720
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1721
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1722
# visible. Older versions of IE do not have SVG support.
1724
INTERACTIVE_SVG = NO
1726
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1180
1727
# found. If left blank, it is assumed the dot tool can be found in the path.
1182
1729
DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
1184
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1185
# contain dot files that are included in the documentation (see the
1731
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1732
# contain dot files that are included in the documentation (see the
1186
1733
# \dotfile command).
1190
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1191
# background. This is disabled by default, which results in a white background.
1192
# Warning: Depending on the platform used, enabling this option may lead to
1193
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1737
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1738
# contain msc files that are included in the documentation (see the
1739
# \mscfile command).
1743
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1744
# nodes that will be shown in the graph. If the number of nodes in a graph
1745
# becomes larger than this value, doxygen will truncate the graph, which is
1746
# visualized by representing a node as a red box. Note that doxygen if the
1747
# number of direct children of the root node in a graph is already larger than
1748
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1749
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1751
DOT_GRAPH_MAX_NODES = 50
1753
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1754
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1755
# from the root by following a path via at most 3 edges will be shown. Nodes
1756
# that lay further from the root node will be omitted. Note that setting this
1757
# option to 1 or 2 may greatly reduce the computation time needed for large
1758
# code bases. Also note that the size of a graph can be further restricted by
1759
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1761
MAX_DOT_GRAPH_DEPTH = 0
1763
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1764
# background. This is disabled by default, because dot on Windows does not
1765
# seem to support this out of the box. Warning: Depending on the platform used,
1766
# enabling this option may lead to badly anti-aliased labels on the edges of
1767
# a graph (i.e. they become hard to read).
1196
1769
DOT_TRANSPARENT = NO
1198
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1199
# files in one run (i.e. multiple -o and -T options on the command line). This
1200
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1771
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1772
# files in one run (i.e. multiple -o and -T options on the command line). This
1773
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1201
1774
# support this, this feature is disabled by default.
1203
# DOT_MULTI_TARGETS = NO
1204
1776
DOT_MULTI_TARGETS = YES
1206
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1207
# generate a legend page explaining the meaning of the various boxes and
1778
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1779
# generate a legend page explaining the meaning of the various boxes and
1208
1780
# arrows in the dot generated graphs.
1210
1782
GENERATE_LEGEND = YES
1212
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1213
# remove the intermediate dot files that are used to generate
1784
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1785
# remove the intermediate dot files that are used to generate
1214
1786
# the various graphs.
1216
1788
DOT_CLEANUP = YES
1218
#---------------------------------------------------------------------------
1219
# Configuration::additions related to the search engine
1220
#---------------------------------------------------------------------------
1222
# The SEARCHENGINE tag specifies whether or not a search engine should be
1223
# used. If set to NO the values of all tags below this one will be ignored.
1225
# JW SEARCHENGINE = NO