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