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