~csiro-asl/small/release-1.0

« back to all changes in this revision

Viewing changes to Doxyfile.in

  • Committer: Brett Grandbois
  • Date: 2011-07-28 05:12:33 UTC
  • Revision ID: brett.grandbois@csiro.au-20110728051233-nnn1edmhlznrd39t
remove the old internal packaging configuration and make it more generic
for general distribution

Show diffs side-by-side

added added

removed removed

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