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