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