Subversion Repositories public iLand

Rev

Rev 779 | Rev 1104 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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