Commit a073bec265adfbd840de8f78d26c2915047f46e5

Authored by Jordan Cheney
1 parent 8d42271f

Remove doxygen file and build instructions

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