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