get rid of annoying makeversion.py, install.py
[divverent/netradiant.git] / Doxyfile
1 # Doxyfile 1.3.6
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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18 # by quotes) that should identify the project.
19
20 PROJECT_NAME           = GtkRadiant
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23 # This could be handy for archiving the generated documentation or 
24 # if some version control system is used.
25
26 PROJECT_NUMBER         = 1.5.0
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29 # base path where the generated documentation will be put. 
30 # If a relative path is entered, it will be relative to the location 
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY       = doxygen-out
34
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
36 # documentation generated by doxygen is written. Doxygen will use this 
37 # information to generate all constant output in the proper language. 
38 # The default language is English, other supported languages are: 
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
41 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
44 OUTPUT_LANGUAGE        = English
45
46 # This tag can be used to specify the encoding used in the generated output. 
47 # The encoding is not always determined by the language that is chosen, 
48 # but also whether or not the output is meant for Windows or non-Windows users. 
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
50 # forces the Windows encoding (this is the default for the Windows binary), 
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for 
52 # all platforms other than Windows).
53
54 USE_WINDOWS_ENCODING   = YES
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
57 # include brief member descriptions after the members that are listed in 
58 # the file and class documentation (similar to JavaDoc). 
59 # Set to NO to disable this.
60
61 BRIEF_MEMBER_DESC      = YES
62
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
64 # the brief description of a member or function before the detailed description. 
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
66 # brief descriptions will be completely suppressed.
67
68 REPEAT_BRIEF           = YES
69
70 # This tag implements a quasi-intelligent brief description abbreviator 
71 # that is used to form the text in various listings. Each string 
72 # in this list, if found as the leading text of the brief description, will be 
73 # stripped from the text and the result after processing the whole list, is used 
74 # as the annotated text. Otherwise, the brief description is used as-is. If left 
75 # blank, the following values are used ("$name" is automatically replaced with the 
76 # name of the entity): "The $name class" "The $name widget" "The $name file" 
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
79 ABBREVIATE_BRIEF       = 
80
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
82 # Doxygen will generate a detailed section even if there is only a brief 
83 # description.
84
85 ALWAYS_DETAILED_SEC    = NO
86
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
88 # members of a class in the documentation of that class as if those members were 
89 # ordinary class members. Constructors, destructors and assignment operators of 
90 # the base classes will not be shown.
91
92 INLINE_INHERITED_MEMB  = NO
93
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
95 # path before files name in the file list and in the header files. If set 
96 # to NO the shortest path that makes the file name unique will be used.
97
98 FULL_PATH_NAMES        = NO
99
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
101 # can be used to strip a user-defined part of the path. Stripping is 
102 # only done if one of the specified strings matches the left-hand part of 
103 # the path. It is allowed to use relative paths in the argument list. 
104 # If left blank the directory from which doxygen is run is used as the 
105 # path to strip.
106
107 STRIP_FROM_PATH        = 
108
109 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
110 # (but less readable) file names. This can be useful is your file systems 
111 # doesn't support long names like on DOS, Mac, or CD-ROM.
112
113 SHORT_NAMES            = NO
114
115 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
116 # will interpret the first line (until the first dot) of a JavaDoc-style 
117 # comment as the brief description. If set to NO, the JavaDoc 
118 # comments will behave just like the Qt-style comments (thus requiring an 
119 # explicit @brief command for a brief description.
120
121 JAVADOC_AUTOBRIEF      = NO
122
123 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
124 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
125 # comments) as a brief description. This used to be the default behaviour. 
126 # The new default is to treat a multi-line C++ comment block as a detailed 
127 # description. Set this tag to YES if you prefer the old behaviour instead.
128
129 MULTILINE_CPP_IS_BRIEF = NO
130
131 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
132 # will output the detailed description near the top, like JavaDoc.
133 # If set to NO, the detailed description appears after the member 
134 # documentation.
135
136 DETAILS_AT_TOP         = NO
137
138 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
139 # member inherits the documentation from any documented member that it 
140 # re-implements.
141
142 INHERIT_DOCS           = YES
143
144 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
145 # tag is set to YES, then doxygen will reuse the documentation of the first 
146 # member in the group (if any) for the other members of the group. By default 
147 # all members of a group must be documented explicitly.
148
149 DISTRIBUTE_GROUP_DOC   = NO
150
151 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
152 # Doxygen uses this value to replace tabs by spaces in code fragments.
153
154 TAB_SIZE               = 2
155
156 # This tag can be used to specify a number of aliases that acts 
157 # as commands in the documentation. An alias has the form "name=value". 
158 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
159 # put the command \sideeffect (or @sideeffect) in the documentation, which 
160 # will result in a user-defined paragraph with heading "Side Effects:". 
161 # You can put \n's in the value part of an alias to insert newlines.
162
163 ALIASES                = 
164
165 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
166 # only. Doxygen will then generate output that is more tailored for C. 
167 # For instance, some of the names that are used will be different. The list 
168 # of all members will be omitted, etc.
169
170 OPTIMIZE_OUTPUT_FOR_C  = NO
171
172 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
173 # only. Doxygen will then generate output that is more tailored for Java. 
174 # For instance, namespaces will be presented as packages, qualified scopes 
175 # will look different, etc.
176
177 OPTIMIZE_OUTPUT_JAVA   = NO
178
179 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
180 # the same type (for instance a group of public functions) to be put as a 
181 # subgroup of that type (e.g. under the Public Functions section). Set it to 
182 # NO to prevent subgrouping. Alternatively, this can be done per class using 
183 # the \nosubgrouping command.
184
185 SUBGROUPING            = YES
186
187 #---------------------------------------------------------------------------
188 # Build related configuration options
189 #---------------------------------------------------------------------------
190
191 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
192 # documentation are documented, even if no documentation was available. 
193 # Private class members and static file members will be hidden unless 
194 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
195
196 EXTRACT_ALL            = NO
197
198 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
199 # will be included in the documentation.
200
201 EXTRACT_PRIVATE        = NO
202
203 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
204 # will be included in the documentation.
205
206 EXTRACT_STATIC         = YES
207
208 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
209 # defined locally in source files will be included in the documentation. 
210 # If set to NO only classes defined in header files are included.
211
212 EXTRACT_LOCAL_CLASSES  = YES
213
214 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
215 # undocumented members of documented classes, files or namespaces. 
216 # If set to NO (the default) these members will be included in the 
217 # various overviews, but no documentation section is generated. 
218 # This option has no effect if EXTRACT_ALL is enabled.
219
220 HIDE_UNDOC_MEMBERS     = NO
221
222 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
223 # undocumented classes that are normally visible in the class hierarchy. 
224 # If set to NO (the default) these classes will be included in the various 
225 # overviews. This option has no effect if EXTRACT_ALL is enabled.
226
227 HIDE_UNDOC_CLASSES     = NO
228
229 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
230 # friend (class|struct|union) declarations. 
231 # If set to NO (the default) these declarations will be included in the 
232 # documentation.
233
234 HIDE_FRIEND_COMPOUNDS  = NO
235
236 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
237 # documentation blocks found inside the body of a function. 
238 # If set to NO (the default) these blocks will be appended to the 
239 # function's detailed documentation block.
240
241 HIDE_IN_BODY_DOCS      = NO
242
243 # The INTERNAL_DOCS tag determines if documentation 
244 # that is typed after a \internal command is included. If the tag is set 
245 # to NO (the default) then the documentation will be excluded. 
246 # Set it to YES to include the internal documentation.
247
248 INTERNAL_DOCS          = NO
249
250 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
251 # file names in lower-case letters. If set to YES upper-case letters are also 
252 # allowed. This is useful if you have classes or files whose names only differ 
253 # in case and if your file system supports case sensitive file names. Windows 
254 # users are advised to set this option to NO.
255
256 CASE_SENSE_NAMES       = YES
257
258 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
259 # will show members with their full class and namespace scopes in the 
260 # documentation. If set to YES the scope will be hidden.
261
262 HIDE_SCOPE_NAMES       = NO
263
264 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
265 # will put a list of the files that are included by a file in the documentation 
266 # of that file.
267
268 SHOW_INCLUDE_FILES     = YES
269
270 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
271 # is inserted in the documentation for inline members.
272
273 INLINE_INFO            = YES
274
275 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
276 # will sort the (detailed) documentation of file and class members 
277 # alphabetically by member name. If set to NO the members will appear in 
278 # declaration order.
279
280 SORT_MEMBER_DOCS       = YES
281
282 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
283 # brief documentation of file, namespace and class members alphabetically 
284 # by member name. If set to NO (the default) the members will appear in 
285 # declaration order.
286
287 SORT_BRIEF_DOCS        = NO
288
289 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
290 # sorted by fully-qualified names, including namespaces. If set to 
291 # NO (the default), the class list will be sorted only by class name, 
292 # not including the namespace part. 
293 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
294 # Note: This option applies only to the class list, not to the 
295 # alphabetical list.
296
297 SORT_BY_SCOPE_NAME     = NO
298
299 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
300 # disable (NO) the todo list. This list is created by putting \todo 
301 # commands in the documentation.
302
303 GENERATE_TODOLIST      = YES
304
305 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
306 # disable (NO) the test list. This list is created by putting \test 
307 # commands in the documentation.
308
309 GENERATE_TESTLIST      = YES
310
311 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
312 # disable (NO) the bug list. This list is created by putting \bug 
313 # commands in the documentation.
314
315 GENERATE_BUGLIST       = YES
316
317 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
318 # disable (NO) the deprecated list. This list is created by putting 
319 # \deprecated commands in the documentation.
320
321 GENERATE_DEPRECATEDLIST= YES
322
323 # The ENABLED_SECTIONS tag can be used to enable conditional 
324 # documentation sections, marked by \if sectionname ... \endif.
325
326 ENABLED_SECTIONS       = 
327
328 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
329 # the initial value of a variable or define consists of for it to appear in 
330 # the documentation. If the initializer consists of more lines than specified 
331 # here it will be hidden. Use a value of 0 to hide initializers completely. 
332 # The appearance of the initializer of individual variables and defines in the 
333 # documentation can be controlled using \showinitializer or \hideinitializer 
334 # command in the documentation regardless of this setting.
335
336 MAX_INITIALIZER_LINES  = 30
337
338 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
339 # at the bottom of the documentation of classes and structs. If set to YES the 
340 # list will mention the files that were used to generate the documentation.
341
342 SHOW_USED_FILES        = YES
343
344 #---------------------------------------------------------------------------
345 # configuration options related to warning and progress messages
346 #---------------------------------------------------------------------------
347
348 # The QUIET tag can be used to turn on/off the messages that are generated 
349 # by doxygen. Possible values are YES and NO. If left blank NO is used.
350
351 QUIET                  = NO
352
353 # The WARNINGS tag can be used to turn on/off the warning messages that are 
354 # generated by doxygen. Possible values are YES and NO. If left blank 
355 # NO is used.
356
357 WARNINGS               = YES
358
359 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
360 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
361 # automatically be disabled.
362
363 WARN_IF_UNDOCUMENTED   = NO
364
365 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
366 # potential errors in the documentation, such as not documenting some 
367 # parameters in a documented function, or documenting parameters that 
368 # don't exist or using markup commands wrongly.
369
370 WARN_IF_DOC_ERROR      = YES
371
372 # The WARN_FORMAT tag determines the format of the warning messages that 
373 # doxygen can produce. The string should contain the $file, $line, and $text 
374 # tags, which will be replaced by the file and line number from which the 
375 # warning originated and the warning text.
376
377 WARN_FORMAT            = "$file:$line: $text"
378
379 # The WARN_LOGFILE tag can be used to specify a file to which warning 
380 # and error messages should be written. If left blank the output is written 
381 # to stderr.
382
383 WARN_LOGFILE           = 
384
385 #---------------------------------------------------------------------------
386 # configuration options related to the input files
387 #---------------------------------------------------------------------------
388
389 # The INPUT tag can be used to specify the files and/or directories that contain 
390 # documented source files. You may enter file names like "myfile.cpp" or 
391 # directories like "/usr/src/myproject". Separate the files or directories 
392 # with spaces.
393
394 INPUT                  = radiant/ plugins/ libs/ include/
395
396 # If the value of the INPUT tag contains directories, you can use the 
397 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
398 # and *.h) to filter out the source-files in the directories. If left 
399 # blank the following patterns are tested: 
400 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
401 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
402
403 FILE_PATTERNS          = 
404
405 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
406 # should be searched for input files as well. Possible values are YES and NO. 
407 # If left blank NO is used.
408
409 RECURSIVE              = YES
410
411 # The EXCLUDE tag can be used to specify files and/or directories that should 
412 # excluded from the INPUT source files. This way you can easily exclude a 
413 # subdirectory from a directory tree whose root is specified with the INPUT tag.
414
415 EXCLUDE                = 
416
417 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
418 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
419
420 EXCLUDE_SYMLINKS       = NO
421
422 # If the value of the INPUT tag contains directories, you can use the 
423 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
424 # certain files from those directories.
425
426 EXCLUDE_PATTERNS       = */.svn/*
427
428 # The EXAMPLE_PATH tag can be used to specify one or more files or 
429 # directories that contain example code fragments that are included (see 
430 # the \include command).
431
432 EXAMPLE_PATH           = radiant/ plugins/ libs/ include/
433
434 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
435 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
436 # and *.h) to filter out the source-files in the directories. If left 
437 # blank all files are included.
438
439 EXAMPLE_PATTERNS       = 
440
441 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
442 # searched for input files to be used with the \include or \dontinclude 
443 # commands irrespective of the value of the RECURSIVE tag. 
444 # Possible values are YES and NO. If left blank NO is used.
445
446 EXAMPLE_RECURSIVE      = NO
447
448 # The IMAGE_PATH tag can be used to specify one or more files or 
449 # directories that contain image that are included in the documentation (see 
450 # the \image command).
451
452 IMAGE_PATH             = 
453
454 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
455 # invoke to filter for each input file. Doxygen will invoke the filter program 
456 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
457 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
458 # input file. Doxygen will then use the output that the filter program writes 
459 # to standard output.
460
461 INPUT_FILTER           = 
462
463 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
464 # INPUT_FILTER) will be used to filter the input files when producing source 
465 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
466
467 FILTER_SOURCE_FILES    = NO
468
469 #---------------------------------------------------------------------------
470 # configuration options related to source browsing
471 #---------------------------------------------------------------------------
472
473 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
474 # be generated. Documented entities will be cross-referenced with these sources. 
475 # Note: To get rid of all source code in the generated output, make sure also 
476 # VERBATIM_HEADERS is set to NO.
477
478 SOURCE_BROWSER         = NO
479
480 # Setting the INLINE_SOURCES tag to YES will include the body 
481 # of functions and classes directly in the documentation.
482
483 INLINE_SOURCES         = NO
484
485 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
486 # doxygen to hide any special comment blocks from generated source code 
487 # fragments. Normal C and C++ comments will always remain visible.
488
489 STRIP_CODE_COMMENTS    = YES
490
491 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
492 # then for each documented function all documented 
493 # functions referencing it will be listed.
494
495 REFERENCED_BY_RELATION = YES
496
497 # If the REFERENCES_RELATION tag is set to YES (the default) 
498 # then for each documented function all documented entities 
499 # called/used by that function will be listed.
500
501 REFERENCES_RELATION    = YES
502
503 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
504 # will generate a verbatim copy of the header file for each class for 
505 # which an include is specified. Set to NO to disable this.
506
507 VERBATIM_HEADERS       = YES
508
509 #---------------------------------------------------------------------------
510 # configuration options related to the alphabetical class index
511 #---------------------------------------------------------------------------
512
513 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
514 # of all compounds will be generated. Enable this if the project 
515 # contains a lot of classes, structs, unions or interfaces.
516
517 ALPHABETICAL_INDEX     = NO
518
519 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
520 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
521 # in which this list will be split (can be a number in the range [1..20])
522
523 COLS_IN_ALPHA_INDEX    = 5
524
525 # In case all classes in a project start with a common prefix, all 
526 # classes will be put under the same header in the alphabetical index. 
527 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
528 # should be ignored while generating the index headers.
529
530 IGNORE_PREFIX          = 
531
532 #---------------------------------------------------------------------------
533 # configuration options related to the HTML output
534 #---------------------------------------------------------------------------
535
536 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
537 # generate HTML output.
538
539 GENERATE_HTML          = YES
540
541 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
542 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
543 # put in front of it. If left blank `html' will be used as the default path.
544
545 HTML_OUTPUT            = html
546
547 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
548 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
549 # doxygen will generate files with .html extension.
550
551 HTML_FILE_EXTENSION    = .html
552
553 # The HTML_HEADER tag can be used to specify a personal HTML header for 
554 # each generated HTML page. If it is left blank doxygen will generate a 
555 # standard header.
556
557 HTML_HEADER            = 
558
559 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
560 # each generated HTML page. If it is left blank doxygen will generate a 
561 # standard footer.
562
563 HTML_FOOTER            = 
564
565 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
566 # style sheet that is used by each HTML page. It can be used to 
567 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
568 # will generate a default style sheet. Note that doxygen will try to copy 
569 # the style sheet file to the HTML output directory, so don't put your own 
570 # stylesheet in the HTML output directory as well, or it will be erased!
571
572 HTML_STYLESHEET        = 
573
574 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
575 # files or namespaces will be aligned in HTML using tables. If set to 
576 # NO a bullet list will be used.
577
578 HTML_ALIGN_MEMBERS     = YES
579
580 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
581 # will be generated that can be used as input for tools like the 
582 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
583 # of the generated HTML documentation.
584
585 GENERATE_HTMLHELP      = NO
586
587 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
588 # be used to specify the file name of the resulting .chm file. You 
589 # can add a path in front of the file if the result should not be 
590 # written to the html output directory.
591
592 CHM_FILE               = 
593
594 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
595 # be used to specify the location (absolute path including file name) of 
596 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
597 # the HTML help compiler on the generated index.hhp.
598
599 HHC_LOCATION           = 
600
601 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
602 # controls if a separate .chi index file is generated (YES) or that 
603 # it should be included in the master .chm file (NO).
604
605 GENERATE_CHI           = NO
606
607 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
608 # controls whether a binary table of contents is generated (YES) or a 
609 # normal table of contents (NO) in the .chm file.
610
611 BINARY_TOC             = NO
612
613 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
614 # to the contents of the HTML help documentation and to the tree view.
615
616 TOC_EXPAND             = NO
617
618 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
619 # top of each HTML page. The value NO (the default) enables the index and 
620 # the value YES disables it.
621
622 DISABLE_INDEX          = NO
623
624 # This tag can be used to set the number of enum values (range [1..20]) 
625 # that doxygen will group on one line in the generated HTML documentation.
626
627 ENUM_VALUES_PER_LINE   = 4
628
629 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
630 # generated containing a tree-like index structure (just like the one that 
631 # is generated for HTML Help). For this to work a browser that supports 
632 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
633 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
634 # probably better off using the HTML help feature.
635
636 GENERATE_TREEVIEW      = NO
637
638 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
639 # used to set the initial width (in pixels) of the frame in which the tree 
640 # is shown.
641
642 TREEVIEW_WIDTH         = 250
643
644 #---------------------------------------------------------------------------
645 # configuration options related to the LaTeX output
646 #---------------------------------------------------------------------------
647
648 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
649 # generate Latex output.
650
651 GENERATE_LATEX         = YES
652
653 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
654 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
655 # put in front of it. If left blank `latex' will be used as the default path.
656
657 LATEX_OUTPUT           = latex
658
659 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
660 # invoked. If left blank `latex' will be used as the default command name.
661
662 LATEX_CMD_NAME         = latex
663
664 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
665 # generate index for LaTeX. If left blank `makeindex' will be used as the 
666 # default command name.
667
668 MAKEINDEX_CMD_NAME     = makeindex
669
670 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
671 # LaTeX documents. This may be useful for small projects and may help to 
672 # save some trees in general.
673
674 COMPACT_LATEX          = NO
675
676 # The PAPER_TYPE tag can be used to set the paper type that is used 
677 # by the printer. Possible values are: a4, a4wide, letter, legal and 
678 # executive. If left blank a4wide will be used.
679
680 PAPER_TYPE             = a4wide
681
682 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
683 # packages that should be included in the LaTeX output.
684
685 EXTRA_PACKAGES         = 
686
687 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
688 # the generated latex document. The header should contain everything until 
689 # the first chapter. If it is left blank doxygen will generate a 
690 # standard header. Notice: only use this tag if you know what you are doing!
691
692 LATEX_HEADER           = 
693
694 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
695 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
696 # contain links (just like the HTML output) instead of page references 
697 # This makes the output suitable for online browsing using a pdf viewer.
698
699 PDF_HYPERLINKS         = NO
700
701 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
702 # plain latex in the generated Makefile. Set this option to YES to get a 
703 # higher quality PDF documentation.
704
705 USE_PDFLATEX           = NO
706
707 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
708 # command to the generated LaTeX files. This will instruct LaTeX to keep 
709 # running if errors occur, instead of asking the user for help. 
710 # This option is also used when generating formulas in HTML.
711
712 LATEX_BATCHMODE        = NO
713
714 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
715 # include the index chapters (such as File Index, Compound Index, etc.) 
716 # in the output.
717
718 LATEX_HIDE_INDICES     = NO
719
720 #---------------------------------------------------------------------------
721 # configuration options related to the RTF output
722 #---------------------------------------------------------------------------
723
724 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
725 # The RTF output is optimized for Word 97 and may not look very pretty with 
726 # other RTF readers or editors.
727
728 GENERATE_RTF           = NO
729
730 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
731 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
732 # put in front of it. If left blank `rtf' will be used as the default path.
733
734 RTF_OUTPUT             = rtf
735
736 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
737 # RTF documents. This may be useful for small projects and may help to 
738 # save some trees in general.
739
740 COMPACT_RTF            = NO
741
742 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
743 # will contain hyperlink fields. The RTF file will 
744 # contain links (just like the HTML output) instead of page references. 
745 # This makes the output suitable for online browsing using WORD or other 
746 # programs which support those fields. 
747 # Note: wordpad (write) and others do not support links.
748
749 RTF_HYPERLINKS         = NO
750
751 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
752 # config file, i.e. a series of assignments. You only have to provide 
753 # replacements, missing definitions are set to their default value.
754
755 RTF_STYLESHEET_FILE    = 
756
757 # Set optional variables used in the generation of an rtf document. 
758 # Syntax is similar to doxygen's config file.
759
760 RTF_EXTENSIONS_FILE    = 
761
762 #---------------------------------------------------------------------------
763 # configuration options related to the man page output
764 #---------------------------------------------------------------------------
765
766 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
767 # generate man pages
768
769 GENERATE_MAN           = NO
770
771 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
772 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
773 # put in front of it. If left blank `man' will be used as the default path.
774
775 MAN_OUTPUT             = man
776
777 # The MAN_EXTENSION tag determines the extension that is added to 
778 # the generated man pages (default is the subroutine's section .3)
779
780 MAN_EXTENSION          = .3
781
782 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
783 # then it will generate one additional man file for each entity 
784 # documented in the real man page(s). These additional files 
785 # only source the real man page, but without them the man command 
786 # would be unable to find the correct page. The default is NO.
787
788 MAN_LINKS              = NO
789
790 #---------------------------------------------------------------------------
791 # configuration options related to the XML output
792 #---------------------------------------------------------------------------
793
794 # If the GENERATE_XML tag is set to YES Doxygen will 
795 # generate an XML file that captures the structure of 
796 # the code including all documentation.
797
798 GENERATE_XML           = YES
799
800 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
801 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
802 # put in front of it. If left blank `xml' will be used as the default path.
803
804 XML_OUTPUT             = doxygen-xml
805
806 # The XML_SCHEMA tag can be used to specify an XML schema, 
807 # which can be used by a validating XML parser to check the 
808 # syntax of the XML files.
809
810 XML_SCHEMA             = 
811
812 # The XML_DTD tag can be used to specify an XML DTD, 
813 # which can be used by a validating XML parser to check the 
814 # syntax of the XML files.
815
816 XML_DTD                = 
817
818 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
819 # dump the program listings (including syntax highlighting 
820 # and cross-referencing information) to the XML output. Note that 
821 # enabling this will significantly increase the size of the XML output.
822
823 XML_PROGRAMLISTING     = NO
824
825 #---------------------------------------------------------------------------
826 # configuration options for the AutoGen Definitions output
827 #---------------------------------------------------------------------------
828
829 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
830 # generate an AutoGen Definitions (see autogen.sf.net) file 
831 # that captures the structure of the code including all 
832 # documentation. Note that this feature is still experimental 
833 # and incomplete at the moment.
834
835 GENERATE_AUTOGEN_DEF   = NO
836
837 #---------------------------------------------------------------------------
838 # configuration options related to the Perl module output
839 #---------------------------------------------------------------------------
840
841 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
842 # generate a Perl module file that captures the structure of 
843 # the code including all documentation. Note that this 
844 # feature is still experimental and incomplete at the 
845 # moment.
846
847 GENERATE_PERLMOD       = NO
848
849 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
850 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
851 # to generate PDF and DVI output from the Perl module output.
852
853 PERLMOD_LATEX          = NO
854
855 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
856 # nicely formatted so it can be parsed by a human reader.  This is useful 
857 # if you want to understand what is going on.  On the other hand, if this 
858 # tag is set to NO the size of the Perl module output will be much smaller 
859 # and Perl will parse it just the same.
860
861 PERLMOD_PRETTY         = YES
862
863 # The names of the make variables in the generated doxyrules.make file 
864 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
865 # This is useful so different doxyrules.make files included by the same 
866 # Makefile don't overwrite each other's variables.
867
868 PERLMOD_MAKEVAR_PREFIX = 
869
870 #---------------------------------------------------------------------------
871 # Configuration options related to the preprocessor   
872 #---------------------------------------------------------------------------
873
874 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
875 # evaluate all C-preprocessor directives found in the sources and include 
876 # files.
877
878 ENABLE_PREPROCESSING   = YES
879
880 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
881 # names in the source code. If set to NO (the default) only conditional 
882 # compilation will be performed. Macro expansion can be done in a controlled 
883 # way by setting EXPAND_ONLY_PREDEF to YES.
884
885 MACRO_EXPANSION        = NO
886
887 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
888 # then the macro expansion is limited to the macros specified with the 
889 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
890
891 EXPAND_ONLY_PREDEF     = NO
892
893 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
894 # in the INCLUDE_PATH (see below) will be search if a #include is found.
895
896 SEARCH_INCLUDES        = YES
897
898 # The INCLUDE_PATH tag can be used to specify one or more directories that 
899 # contain include files that are not input files but should be processed by 
900 # the preprocessor.
901
902 INCLUDE_PATH           = 
903
904 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
905 # patterns (like *.h and *.hpp) to filter out the header-files in the 
906 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
907 # be used.
908
909 INCLUDE_FILE_PATTERNS  = 
910
911 # The PREDEFINED tag can be used to specify one or more macro names that 
912 # are defined before the preprocessor is started (similar to the -D option of 
913 # gcc). The argument of the tag is a list of macros of the form: name 
914 # or name=definition (no spaces). If the definition and the = are 
915 # omitted =1 is assumed.
916
917 PREDEFINED             = 
918
919 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
920 # this tag can be used to specify a list of macro names that should be expanded. 
921 # The macro definition that is found in the sources will be used. 
922 # Use the PREDEFINED tag if you want to use a different macro definition.
923
924 EXPAND_AS_DEFINED      = 
925
926 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
927 # doxygen's preprocessor will remove all function-like macros that are alone 
928 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
929 # function macros are typically used for boiler-plate code, and will confuse the 
930 # parser if not removed.
931
932 SKIP_FUNCTION_MACROS   = YES
933
934 #---------------------------------------------------------------------------
935 # Configuration::additions related to external references   
936 #---------------------------------------------------------------------------
937
938 # The TAGFILES option can be used to specify one or more tagfiles. 
939 # Optionally an initial location of the external documentation 
940 # can be added for each tagfile. The format of a tag file without 
941 # this location is as follows: 
942 #   TAGFILES = file1 file2 ... 
943 # Adding location for the tag files is done as follows: 
944 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
945 # where "loc1" and "loc2" can be relative or absolute paths or 
946 # URLs. If a location is present for each tag, the installdox tool 
947 # does not have to be run to correct the links.
948 # Note that each tag file must have a unique name
949 # (where the name does NOT include the path)
950 # If a tag file is not located in the directory in which doxygen 
951 # is run, you must also specify the path to the tagfile here.
952
953 TAGFILES               = 
954
955 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
956 # a tag file that is based on the input files it reads.
957
958 GENERATE_TAGFILE       = 
959
960 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
961 # in the class index. If set to NO only the inherited external classes 
962 # will be listed.
963
964 ALLEXTERNALS           = NO
965
966 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
967 # in the modules index. If set to NO, only the current project's groups will 
968 # be listed.
969
970 EXTERNAL_GROUPS        = YES
971
972 # The PERL_PATH should be the absolute path and name of the perl script 
973 # interpreter (i.e. the result of `which perl').
974
975 PERL_PATH              = /usr/bin/perl
976
977 #---------------------------------------------------------------------------
978 # Configuration options related to the dot tool   
979 #---------------------------------------------------------------------------
980
981 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
982 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
983 # super classes. Setting the tag to NO turns the diagrams off. Note that this 
984 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is 
985 # recommended to install and use dot, since it yields more powerful graphs.
986
987 CLASS_DIAGRAMS         = YES
988
989 # If set to YES, the inheritance and collaboration graphs will hide 
990 # inheritance and usage relations if the target is undocumented 
991 # or is not a class.
992
993 HIDE_UNDOC_RELATIONS   = YES
994
995 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
996 # available from the path. This tool is part of Graphviz, a graph visualization 
997 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
998 # have no effect if this option is set to NO (the default)
999
1000 HAVE_DOT               = YES
1001
1002 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1003 # will generate a graph for each documented class showing the direct and 
1004 # indirect inheritance relations. Setting this tag to YES will force the 
1005 # the CLASS_DIAGRAMS tag to NO.
1006
1007 CLASS_GRAPH            = YES
1008
1009 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1010 # will generate a graph for each documented class showing the direct and 
1011 # indirect implementation dependencies (inheritance, containment, and 
1012 # class references variables) of the class with other documented classes.
1013
1014 COLLABORATION_GRAPH    = YES
1015
1016 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1017 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1018 # Language.
1019
1020 UML_LOOK               = NO
1021
1022 # If set to YES, the inheritance and collaboration graphs will show the 
1023 # relations between templates and their instances.
1024
1025 TEMPLATE_RELATIONS     = YES
1026
1027 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1028 # tags are set to YES then doxygen will generate a graph for each documented 
1029 # file showing the direct and indirect include dependencies of the file with 
1030 # other documented files.
1031
1032 INCLUDE_GRAPH          = YES
1033
1034 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1035 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1036 # documented header file showing the documented files that directly or 
1037 # indirectly include this file.
1038
1039 INCLUDED_BY_GRAPH      = YES
1040
1041 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1042 # generate a call dependency graph for every global function or class method. 
1043 # Note that enabling this option will significantly increase the time of a run. 
1044 # So in most cases it will be better to enable call graphs for selected 
1045 # functions only using the \callgraph command.
1046
1047 CALL_GRAPH             = NO
1048
1049 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1050 # will graphical hierarchy of all classes instead of a textual one.
1051
1052 GRAPHICAL_HIERARCHY    = YES
1053
1054 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1055 # generated by dot. Possible values are png, jpg, or gif
1056 # If left blank png will be used.
1057
1058 DOT_IMAGE_FORMAT       = png
1059
1060 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1061 # found. If left blank, it is assumed the dot tool can be found on the path.
1062
1063 DOT_PATH               = 
1064
1065 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1066 # contain dot files that are included in the documentation (see the 
1067 # \dotfile command).
1068
1069 DOTFILE_DIRS           = 
1070
1071 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
1072 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1073 # this value, doxygen will try to truncate the graph, so that it fits within 
1074 # the specified constraint. Beware that most browsers cannot cope with very 
1075 # large images.
1076
1077 MAX_DOT_GRAPH_WIDTH    = 1024
1078
1079 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
1080 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1081 # this value, doxygen will try to truncate the graph, so that it fits within 
1082 # the specified constraint. Beware that most browsers cannot cope with very 
1083 # large images.
1084
1085 MAX_DOT_GRAPH_HEIGHT   = 1024
1086
1087 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1088 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1089 # from the root by following a path via at most 3 edges will be shown. Nodes that 
1090 # lay further from the root node will be omitted. Note that setting this option to 
1091 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
1092 # note that a graph may be further truncated if the graph's image dimensions are 
1093 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
1094 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1095
1096 MAX_DOT_GRAPH_DEPTH    = 0
1097
1098 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1099 # generate a legend page explaining the meaning of the various boxes and 
1100 # arrows in the dot generated graphs.
1101
1102 GENERATE_LEGEND        = YES
1103
1104 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1105 # remove the intermediate dot files that are used to generate 
1106 # the various graphs.
1107
1108 DOT_CLEANUP            = YES
1109
1110 #---------------------------------------------------------------------------
1111 # Configuration::additions related to the search engine   
1112 #---------------------------------------------------------------------------
1113
1114 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1115 # used. If set to NO the values of all tags below this one will be ignored.
1116
1117 SEARCHENGINE           = NO