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