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