Bump to 0.3.5.14-dev
[tor.git] / Doxyfile.in
blob4caf42109788afc04243abb015cb59d53f71d26b
1 # Doxyfile 1.5.6
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME           = tor
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
34 PROJECT_NUMBER         = @VERSION@
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY       = @top_builddir@/doc/doxygen
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
50 CREATE_SUBDIRS         = NO
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61 # and Ukrainian.
63 OUTPUT_LANGUAGE        = English
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
70 BRIEF_MEMBER_DESC      = NO
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
77 REPEAT_BRIEF           = YES
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
89 ABBREVIATE_BRIEF       =
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
93 # description.
95 ALWAYS_DETAILED_SEC    = NO
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
102 INLINE_INHERITED_MEMB  = NO
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
108 FULL_PATH_NAMES        = NO
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
117 STRIP_FROM_PATH        =
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
126 STRIP_FROM_INC_PATH    =
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
132 SHORT_NAMES            = NO
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
140 JAVADOC_AUTOBRIEF      = NO
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
148 QT_AUTOBRIEF           = NO
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
156 MULTILINE_CPP_IS_BRIEF = NO
158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
159 # will output the detailed description near the top, like JavaDoc.
160 # If set to NO, the detailed description appears after the member
161 # documentation.
163 # DETAILS_AT_TOP         = NO
165 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166 # member inherits the documentation from any documented member that it
167 # re-implements.
169 INHERIT_DOCS           = YES
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172 # a new page for each member. If set to NO, the documentation of a member will
173 # be part of the file/class/namespace that contains it.
175 SEPARATE_MEMBER_PAGES  = NO
177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 # Doxygen uses this value to replace tabs by spaces in code fragments.
180 TAB_SIZE               = 8
182 # This tag can be used to specify a number of aliases that acts
183 # as commands in the documentation. An alias has the form "name=value".
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # put the command \sideeffect (or @sideeffect) in the documentation, which
186 # will result in a user-defined paragraph with heading "Side Effects:".
187 # You can put \n's in the value part of an alias to insert newlines.
189 ALIASES                =
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192 # sources only. Doxygen will then generate output that is more tailored for C.
193 # For instance, some of the names that are used will be different. The list
194 # of all members will be omitted, etc.
196 OPTIMIZE_OUTPUT_FOR_C  = YES
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Java. For instance, namespaces will be presented as packages, qualified
201 # scopes will look different, etc.
203 OPTIMIZE_OUTPUT_JAVA   = NO
205 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206 # sources only. Doxygen will then generate output that is more tailored for
207 # Fortran.
209 OPTIMIZE_FOR_FORTRAN   = NO
211 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212 # sources. Doxygen will then generate output that is tailored for
213 # VHDL.
215 OPTIMIZE_OUTPUT_VHDL   = NO
217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218 # to include (a tag file for) the STL sources as input, then you should
219 # set this tag to YES in order to let doxygen match functions declarations and
220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221 # func(std::string) {}). This also make the inheritance and collaboration
222 # diagrams that involve STL classes more complete and accurate.
224 BUILTIN_STL_SUPPORT    = NO
226 # If you use Microsoft's C++/CLI language, you should set this option to YES to
227 # enable parsing support.
229 CPP_CLI_SUPPORT        = NO
231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232 # Doxygen will parse them like normal C++ but will assume all classes use public
233 # instead of private inheritance when no explicit protection keyword is present.
235 SIP_SUPPORT            = NO
237 # For Microsoft's IDL there are propget and propput attributes to indicate getter
238 # and setter methods for a property. Setting this option to YES (the default)
239 # will make doxygen to replace the get and set methods by a property in the
240 # documentation. This will only work if the methods are indeed getting or
241 # setting a simple type. If this is not the case, or you want to show the
242 # methods anyway, you should set this option to NO.
244 IDL_PROPERTY_SUPPORT   = NO
246 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247 # tag is set to YES, then doxygen will reuse the documentation of the first
248 # member in the group (if any) for the other members of the group. By default
249 # all members of a group must be documented explicitly.
251 DISTRIBUTE_GROUP_DOC   = NO
253 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254 # the same type (for instance a group of public functions) to be put as a
255 # subgroup of that type (e.g. under the Public Functions section). Set it to
256 # NO to prevent subgrouping. Alternatively, this can be done per class using
257 # the \nosubgrouping command.
259 SUBGROUPING            = YES
261 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262 # is documented as struct, union, or enum with the name of the typedef. So
263 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264 # with name TypeT. When disabled the typedef will appear as a member of a file,
265 # namespace, or class. And the struct will be named TypeS. This can typically
266 # be useful for C code in case the coding convention dictates that all compound
267 # types are typedef'ed and only the typedef is referenced, never the tag name.
269 TYPEDEF_HIDES_STRUCT   = NO
271 #---------------------------------------------------------------------------
272 # Build related configuration options
273 #---------------------------------------------------------------------------
275 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
276 # documentation are documented, even if no documentation was available.
277 # Private class members and static file members will be hidden unless
278 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
280 EXTRACT_ALL            = NO
282 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
283 # will be included in the documentation.
285 EXTRACT_PRIVATE        = NO
287 # If the EXTRACT_STATIC tag is set to YES all static members of a file
288 # will be included in the documentation.
290 EXTRACT_STATIC         = YES
292 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
293 # defined locally in source files will be included in the documentation.
294 # If set to NO only classes defined in header files are included.
296 EXTRACT_LOCAL_CLASSES  = YES
298 # This flag is only useful for Objective-C code. When set to YES local
299 # methods, which are defined in the implementation section but not in
300 # the interface are included in the documentation.
301 # If set to NO (the default) only methods in the interface are included.
303 EXTRACT_LOCAL_METHODS  = NO
305 # If this flag is set to YES, the members of anonymous namespaces will be
306 # extracted and appear in the documentation as a namespace called
307 # 'anonymous_namespace{file}', where file will be replaced with the base
308 # name of the file that contains the anonymous namespace. By default
309 # anonymous namespace are hidden.
311 EXTRACT_ANON_NSPACES   = NO
313 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
314 # undocumented members of documented classes, files or namespaces.
315 # If set to NO (the default) these members will be included in the
316 # various overviews, but no documentation section is generated.
317 # This option has no effect if EXTRACT_ALL is enabled.
319 HIDE_UNDOC_MEMBERS     = NO
321 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
322 # undocumented classes that are normally visible in the class hierarchy.
323 # If set to NO (the default) these classes will be included in the various
324 # overviews. This option has no effect if EXTRACT_ALL is enabled.
326 HIDE_UNDOC_CLASSES     = NO
328 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
329 # friend (class|struct|union) declarations.
330 # If set to NO (the default) these declarations will be included in the
331 # documentation.
333 HIDE_FRIEND_COMPOUNDS  = NO
335 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
336 # documentation blocks found inside the body of a function.
337 # If set to NO (the default) these blocks will be appended to the
338 # function's detailed documentation block.
340 HIDE_IN_BODY_DOCS      = NO
342 # The INTERNAL_DOCS tag determines if documentation
343 # that is typed after a \internal command is included. If the tag is set
344 # to NO (the default) then the documentation will be excluded.
345 # Set it to YES to include the internal documentation.
347 INTERNAL_DOCS          = NO
349 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
350 # file names in lower-case letters. If set to YES upper-case letters are also
351 # allowed. This is useful if you have classes or files whose names only differ
352 # in case and if your file system supports case sensitive file names. Windows
353 # and Mac users are advised to set this option to NO.
355 CASE_SENSE_NAMES       = YES
357 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
358 # will show members with their full class and namespace scopes in the
359 # documentation. If set to YES the scope will be hidden.
361 HIDE_SCOPE_NAMES       = NO
363 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
364 # will put a list of the files that are included by a file in the documentation
365 # of that file.
367 SHOW_INCLUDE_FILES     = YES
369 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
370 # is inserted in the documentation for inline members.
372 INLINE_INFO            = YES
374 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
375 # will sort the (detailed) documentation of file and class members
376 # alphabetically by member name. If set to NO the members will appear in
377 # declaration order.
379 SORT_MEMBER_DOCS       = YES
381 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382 # brief documentation of file, namespace and class members alphabetically
383 # by member name. If set to NO (the default) the members will appear in
384 # declaration order.
386 SORT_BRIEF_DOCS        = NO
388 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389 # hierarchy of group names into alphabetical order. If set to NO (the default)
390 # the group names will appear in their defined order.
392 SORT_GROUP_NAMES       = NO
394 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395 # sorted by fully-qualified names, including namespaces. If set to
396 # NO (the default), the class list will be sorted only by class name,
397 # not including the namespace part.
398 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399 # Note: This option applies only to the class list, not to the
400 # alphabetical list.
402 SORT_BY_SCOPE_NAME     = NO
404 # The GENERATE_TODOLIST tag can be used to enable (YES) or
405 # disable (NO) the todo list. This list is created by putting \todo
406 # commands in the documentation.
408 GENERATE_TODOLIST      = YES
410 # The GENERATE_TESTLIST tag can be used to enable (YES) or
411 # disable (NO) the test list. This list is created by putting \test
412 # commands in the documentation.
414 GENERATE_TESTLIST      = YES
416 # The GENERATE_BUGLIST tag can be used to enable (YES) or
417 # disable (NO) the bug list. This list is created by putting \bug
418 # commands in the documentation.
420 GENERATE_BUGLIST       = YES
422 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
423 # disable (NO) the deprecated list. This list is created by putting
424 # \deprecated commands in the documentation.
426 GENERATE_DEPRECATEDLIST= YES
428 # The ENABLED_SECTIONS tag can be used to enable conditional
429 # documentation sections, marked by \if sectionname ... \endif.
431 ENABLED_SECTIONS       =
433 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
434 # the initial value of a variable or define consists of for it to appear in
435 # the documentation. If the initializer consists of more lines than specified
436 # here it will be hidden. Use a value of 0 to hide initializers completely.
437 # The appearance of the initializer of individual variables and defines in the
438 # documentation can be controlled using \showinitializer or \hideinitializer
439 # command in the documentation regardless of this setting.
441 MAX_INITIALIZER_LINES  = 30
443 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
444 # at the bottom of the documentation of classes and structs. If set to YES the
445 # list will mention the files that were used to generate the documentation.
447 SHOW_USED_FILES        = YES
449 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
450 # This will remove the Files entry from the Quick Index and from the
451 # Folder Tree View (if specified). The default is YES.
453 SHOW_FILES             = YES
455 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
456 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
457 # and from the Folder Tree View (if specified). The default is YES.
459 SHOW_NAMESPACES        = YES
461 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
462 # doxygen should invoke to get the current version for each file (typically from
463 # the version control system). Doxygen will invoke the program by executing (via
464 # popen()) the command <command> <input-file>, where <command> is the value of
465 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
466 # provided by doxygen. Whatever the program writes to standard output
467 # is used as the file version. See the manual for examples.
469 FILE_VERSION_FILTER    =
471 #---------------------------------------------------------------------------
472 # configuration options related to warning and progress messages
473 #---------------------------------------------------------------------------
475 # The QUIET tag can be used to turn on/off the messages that are generated
476 # by doxygen. Possible values are YES and NO. If left blank NO is used.
478 QUIET                  = NO
480 # The WARNINGS tag can be used to turn on/off the warning messages that are
481 # generated by doxygen. Possible values are YES and NO. If left blank
482 # NO is used.
484 WARNINGS               = YES
486 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
487 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
488 # automatically be disabled.
490 WARN_IF_UNDOCUMENTED   = YES
492 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
493 # potential errors in the documentation, such as not documenting some
494 # parameters in a documented function, or documenting parameters that
495 # don't exist or using markup commands wrongly.
497 WARN_IF_DOC_ERROR      = YES
499 # This WARN_NO_PARAMDOC option can be abled to get warnings for
500 # functions that are documented, but have no documentation for their parameters
501 # or return value. If set to NO (the default) doxygen will only warn about
502 # wrong or incomplete parameter documentation, but not about the absence of
503 # documentation.
505 WARN_NO_PARAMDOC       = NO
507 # The WARN_FORMAT tag determines the format of the warning messages that
508 # doxygen can produce. The string should contain the $file, $line, and $text
509 # tags, which will be replaced by the file and line number from which the
510 # warning originated and the warning text. Optionally the format may contain
511 # $version, which will be replaced by the version of the file (if it could
512 # be obtained via FILE_VERSION_FILTER)
514 WARN_FORMAT            = "$file:$line: $text"
516 # The WARN_LOGFILE tag can be used to specify a file to which warning
517 # and error messages should be written. If left blank the output is written
518 # to stderr.
520 WARN_LOGFILE           =
522 #---------------------------------------------------------------------------
523 # configuration options related to the input files
524 #---------------------------------------------------------------------------
526 # The INPUT tag can be used to specify the files and/or directories that contain
527 # documented source files. You may enter file names like "myfile.cpp" or
528 # directories like "/usr/src/myproject". Separate the files or directories
529 # with spaces.
531 INPUT                  = @top_srcdir@/src/lib \
532                          @top_srcdir@/src/core \
533                          @top_srcdir@/src/feature \
534                          @top_srcdir@/src/app
536 # This tag can be used to specify the character encoding of the source files
537 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
538 # also the default input encoding. Doxygen uses libiconv (or the iconv built
539 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
540 # the list of possible encodings.
542 INPUT_ENCODING         = UTF-8
544 # If the value of the INPUT tag contains directories, you can use the
545 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
546 # and *.h) to filter out the source-files in the directories. If left
547 # blank the following patterns are tested:
548 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
549 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
551 FILE_PATTERNS          = *.c \
552                          *.h
554 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
555 # should be searched for input files as well. Possible values are YES and NO.
556 # If left blank NO is used.
558 RECURSIVE              = YES
560 # The EXCLUDE tag can be used to specify files and/or directories that should
561 # excluded from the INPUT source files. This way you can easily exclude a
562 # subdirectory from a directory tree whose root is specified with the INPUT tag.
564 EXCLUDE                = tree.h
566 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
567 # directories that are symbolic links (a Unix filesystem feature) are excluded
568 # from the input.
570 EXCLUDE_SYMLINKS       = NO
572 # If the value of the INPUT tag contains directories, you can use the
573 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
574 # certain files from those directories. Note that the wildcards are matched
575 # against the file with absolute path, so to exclude all test directories
576 # for example use the pattern */test/*
578 EXCLUDE_PATTERNS       =
580 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
581 # (namespaces, classes, functions, etc.) that should be excluded from the
582 # output. The symbol name can be a fully qualified name, a word, or if the
583 # wildcard * is used, a substring. Examples: ANamespace, AClass,
584 # AClass::ANamespace, ANamespace::*Test
586 EXCLUDE_SYMBOLS        =
588 # The EXAMPLE_PATH tag can be used to specify one or more files or
589 # directories that contain example code fragments that are included (see
590 # the \include command).
592 EXAMPLE_PATH           =
594 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
595 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
596 # and *.h) to filter out the source-files in the directories. If left
597 # blank all files are included.
599 EXAMPLE_PATTERNS       =
601 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
602 # searched for input files to be used with the \include or \dontinclude
603 # commands irrespective of the value of the RECURSIVE tag.
604 # Possible values are YES and NO. If left blank NO is used.
606 EXAMPLE_RECURSIVE      = NO
608 # The IMAGE_PATH tag can be used to specify one or more files or
609 # directories that contain image that are included in the documentation (see
610 # the \image command).
612 IMAGE_PATH             =
614 # The INPUT_FILTER tag can be used to specify a program that doxygen should
615 # invoke to filter for each input file. Doxygen will invoke the filter program
616 # by executing (via popen()) the command <filter> <input-file>, where <filter>
617 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
618 # input file. Doxygen will then use the output that the filter program writes
619 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
620 # ignored.
622 INPUT_FILTER           =
624 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
625 # basis.  Doxygen will compare the file name with each pattern and apply the
626 # filter if there is a match.  The filters are a list of the form:
627 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
628 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
629 # is applied to all files.
631 FILTER_PATTERNS        =
633 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
634 # INPUT_FILTER) will be used to filter the input files when producing source
635 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
637 FILTER_SOURCE_FILES    = NO
639 #---------------------------------------------------------------------------
640 # configuration options related to source browsing
641 #---------------------------------------------------------------------------
643 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
644 # be generated. Documented entities will be cross-referenced with these sources.
645 # Note: To get rid of all source code in the generated output, make sure also
646 # VERBATIM_HEADERS is set to NO.
648 SOURCE_BROWSER         = YES
650 # Setting the INLINE_SOURCES tag to YES will include the body
651 # of functions and classes directly in the documentation.
653 INLINE_SOURCES         = NO
655 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
656 # doxygen to hide any special comment blocks from generated source code
657 # fragments. Normal C and C++ comments will always remain visible.
659 STRIP_CODE_COMMENTS    = YES
661 # If the REFERENCED_BY_RELATION tag is set to YES
662 # then for each documented function all documented
663 # functions referencing it will be listed.
665 REFERENCED_BY_RELATION = YES
667 # If the REFERENCES_RELATION tag is set to YES
668 # then for each documented function all documented entities
669 # called/used by that function will be listed.
671 REFERENCES_RELATION    = YES
673 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
674 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
675 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
676 # link to the source code.  Otherwise they will link to the documentstion.
678 REFERENCES_LINK_SOURCE = YES
680 # If the USE_HTAGS tag is set to YES then the references to source code
681 # will point to the HTML generated by the htags(1) tool instead of doxygen
682 # built-in source browser. The htags tool is part of GNU's global source
683 # tagging system (see http://www.gnu.org/software/global/global.html). You
684 # will need version 4.8.6 or higher.
686 USE_HTAGS              = NO
688 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
689 # will generate a verbatim copy of the header file for each class for
690 # which an include is specified. Set to NO to disable this.
692 VERBATIM_HEADERS       = YES
694 #---------------------------------------------------------------------------
695 # configuration options related to the alphabetical class index
696 #---------------------------------------------------------------------------
698 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
699 # of all compounds will be generated. Enable this if the project
700 # contains a lot of classes, structs, unions or interfaces.
702 ALPHABETICAL_INDEX     = NO
704 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
705 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
706 # in which this list will be split (can be a number in the range [1..20])
708 COLS_IN_ALPHA_INDEX    = 5
710 # In case all classes in a project start with a common prefix, all
711 # classes will be put under the same header in the alphabetical index.
712 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
713 # should be ignored while generating the index headers.
715 IGNORE_PREFIX          =
717 #---------------------------------------------------------------------------
718 # configuration options related to the HTML output
719 #---------------------------------------------------------------------------
721 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
722 # generate HTML output.
724 GENERATE_HTML          = YES
726 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
727 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
728 # put in front of it. If left blank `html' will be used as the default path.
730 HTML_OUTPUT            = html
732 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
733 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
734 # doxygen will generate files with .html extension.
736 HTML_FILE_EXTENSION    = .html
738 # The HTML_HEADER tag can be used to specify a personal HTML header for
739 # each generated HTML page. If it is left blank doxygen will generate a
740 # standard header.
742 HTML_HEADER            =
744 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
745 # each generated HTML page. If it is left blank doxygen will generate a
746 # standard footer.
748 HTML_FOOTER            =
750 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
751 # style sheet that is used by each HTML page. It can be used to
752 # fine-tune the look of the HTML output. If the tag is left blank doxygen
753 # will generate a default style sheet. Note that doxygen will try to copy
754 # the style sheet file to the HTML output directory, so don't put your own
755 # stylesheet in the HTML output directory as well, or it will be erased!
757 HTML_STYLESHEET        =
759 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
760 # will be generated that can be used as input for tools like the
761 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
762 # of the generated HTML documentation.
764 GENERATE_HTMLHELP      = NO
766 # If the GENERATE_DOCSET tag is set to YES, additional index files
767 # will be generated that can be used as input for Apple's Xcode 3
768 # integrated development environment, introduced with OSX 10.5 (Leopard).
769 # To create a documentation set, doxygen will generate a Makefile in the
770 # HTML output directory. Running make will produce the docset in that
771 # directory and running "make install" will install the docset in
772 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
773 # it at startup.
775 GENERATE_DOCSET        = NO
777 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
778 # feed. A documentation feed provides an umbrella under which multiple
779 # documentation sets from a single provider (such as a company or product suite)
780 # can be grouped.
782 DOCSET_FEEDNAME        = "Doxygen generated docs for Tor"
784 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
785 # should uniquely identify the documentation set bundle. This should be a
786 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
787 # will append .docset to the name.
789 DOCSET_BUNDLE_ID       = org.torproject.Tor
791 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
792 # documentation will contain sections that can be hidden and shown after the
793 # page has loaded. For this to work a browser that supports
794 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
795 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
797 HTML_DYNAMIC_SECTIONS  = NO
799 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
800 # be used to specify the file name of the resulting .chm file. You
801 # can add a path in front of the file if the result should not be
802 # written to the html output directory.
804 CHM_FILE               =
806 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
807 # be used to specify the location (absolute path including file name) of
808 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
809 # the HTML help compiler on the generated index.hhp.
811 HHC_LOCATION           =
813 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
814 # controls if a separate .chi index file is generated (YES) or that
815 # it should be included in the master .chm file (NO).
817 GENERATE_CHI           = NO
819 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
820 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
821 # content.
823 CHM_INDEX_ENCODING     =
825 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
826 # controls whether a binary table of contents is generated (YES) or a
827 # normal table of contents (NO) in the .chm file.
829 BINARY_TOC             = NO
831 # The TOC_EXPAND flag can be set to YES to add extra items for group members
832 # to the contents of the HTML help documentation and to the tree view.
834 TOC_EXPAND             = NO
836 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
837 # top of each HTML page. The value NO (the default) enables the index and
838 # the value YES disables it.
840 DISABLE_INDEX          = NO
842 # This tag can be used to set the number of enum values (range [1..20])
843 # that doxygen will group on one line in the generated HTML documentation.
845 ENUM_VALUES_PER_LINE   = 4
847 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
848 # structure should be generated to display hierarchical information.
849 # If the tag value is set to FRAME, a side panel will be generated
850 # containing a tree-like index structure (just like the one that
851 # is generated for HTML Help). For this to work a browser that supports
852 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
853 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
854 # probably better off using the HTML help feature. Other possible values
855 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
856 # and Class Hiererachy pages using a tree view instead of an ordered list;
857 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
858 # disables this behavior completely. For backwards compatibility with previous
859 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
860 # respectively.
862 GENERATE_TREEVIEW      = NO
864 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
865 # used to set the initial width (in pixels) of the frame in which the tree
866 # is shown.
868 TREEVIEW_WIDTH         = 250
870 # Use this tag to change the font size of Latex formulas included
871 # as images in the HTML documentation. The default is 10. Note that
872 # when you change the font size after a successful doxygen run you need
873 # to manually remove any form_*.png images from the HTML output directory
874 # to force them to be regenerated.
876 FORMULA_FONTSIZE       = 10
878 #---------------------------------------------------------------------------
879 # configuration options related to the LaTeX output
880 #---------------------------------------------------------------------------
882 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
883 # generate Latex output.
885 GENERATE_LATEX         = YES
887 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
888 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
889 # put in front of it. If left blank `latex' will be used as the default path.
891 LATEX_OUTPUT           = latex
893 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
894 # invoked. If left blank `latex' will be used as the default command name.
896 LATEX_CMD_NAME         = latex
898 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
899 # generate index for LaTeX. If left blank `makeindex' will be used as the
900 # default command name.
902 MAKEINDEX_CMD_NAME     = makeindex
904 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
905 # LaTeX documents. This may be useful for small projects and may help to
906 # save some trees in general.
908 COMPACT_LATEX          = NO
910 # The PAPER_TYPE tag can be used to set the paper type that is used
911 # by the printer. Possible values are: a4, a4wide, letter, legal and
912 # executive. If left blank a4wide will be used.
914 PAPER_TYPE             = a4wide
916 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
917 # packages that should be included in the LaTeX output.
919 EXTRA_PACKAGES         =
921 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
922 # the generated latex document. The header should contain everything until
923 # the first chapter. If it is left blank doxygen will generate a
924 # standard header. Notice: only use this tag if you know what you are doing!
926 LATEX_HEADER           =
928 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
929 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
930 # contain links (just like the HTML output) instead of page references
931 # This makes the output suitable for online browsing using a pdf viewer.
933 PDF_HYPERLINKS         = NO
935 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
936 # plain latex in the generated Makefile. Set this option to YES to get a
937 # higher quality PDF documentation.
939 USE_PDFLATEX           = NO
941 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
942 # command to the generated LaTeX files. This will instruct LaTeX to keep
943 # running if errors occur, instead of asking the user for help.
944 # This option is also used when generating formulas in HTML.
946 LATEX_BATCHMODE        = NO
948 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
949 # include the index chapters (such as File Index, Compound Index, etc.)
950 # in the output.
952 LATEX_HIDE_INDICES     = NO
954 #---------------------------------------------------------------------------
955 # configuration options related to the RTF output
956 #---------------------------------------------------------------------------
958 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
959 # The RTF output is optimized for Word 97 and may not look very pretty with
960 # other RTF readers or editors.
962 GENERATE_RTF           = NO
964 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
965 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
966 # put in front of it. If left blank `rtf' will be used as the default path.
968 RTF_OUTPUT             = rtf
970 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
971 # RTF documents. This may be useful for small projects and may help to
972 # save some trees in general.
974 COMPACT_RTF            = NO
976 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
977 # will contain hyperlink fields. The RTF file will
978 # contain links (just like the HTML output) instead of page references.
979 # This makes the output suitable for online browsing using WORD or other
980 # programs which support those fields.
981 # Note: wordpad (write) and others do not support links.
983 RTF_HYPERLINKS         = NO
985 # Load stylesheet definitions from file. Syntax is similar to doxygen's
986 # config file, i.e. a series of assignments. You only have to provide
987 # replacements, missing definitions are set to their default value.
989 RTF_STYLESHEET_FILE    =
991 # Set optional variables used in the generation of an rtf document.
992 # Syntax is similar to doxygen's config file.
994 RTF_EXTENSIONS_FILE    =
996 #---------------------------------------------------------------------------
997 # configuration options related to the man page output
998 #---------------------------------------------------------------------------
1000 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1001 # generate man pages
1003 GENERATE_MAN           = NO
1005 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1006 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1007 # put in front of it. If left blank `man' will be used as the default path.
1009 MAN_OUTPUT             = man
1011 # The MAN_EXTENSION tag determines the extension that is added to
1012 # the generated man pages (default is the subroutine's section .3)
1014 MAN_EXTENSION          = .3
1016 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1017 # then it will generate one additional man file for each entity
1018 # documented in the real man page(s). These additional files
1019 # only source the real man page, but without them the man command
1020 # would be unable to find the correct page. The default is NO.
1022 MAN_LINKS              = NO
1024 #---------------------------------------------------------------------------
1025 # configuration options related to the XML output
1026 #---------------------------------------------------------------------------
1028 # If the GENERATE_XML tag is set to YES Doxygen will
1029 # generate an XML file that captures the structure of
1030 # the code including all documentation.
1032 GENERATE_XML           = NO
1034 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1035 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1036 # put in front of it. If left blank `xml' will be used as the default path.
1038 XML_OUTPUT             = xml
1040 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1041 # dump the program listings (including syntax highlighting
1042 # and cross-referencing information) to the XML output. Note that
1043 # enabling this will significantly increase the size of the XML output.
1045 XML_PROGRAMLISTING     = YES
1047 #---------------------------------------------------------------------------
1048 # configuration options for the AutoGen Definitions output
1049 #---------------------------------------------------------------------------
1051 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1052 # generate an AutoGen Definitions (see autogen.sf.net) file
1053 # that captures the structure of the code including all
1054 # documentation. Note that this feature is still experimental
1055 # and incomplete at the moment.
1057 GENERATE_AUTOGEN_DEF   = NO
1059 #---------------------------------------------------------------------------
1060 # configuration options related to the Perl module output
1061 #---------------------------------------------------------------------------
1063 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1064 # generate a Perl module file that captures the structure of
1065 # the code including all documentation. Note that this
1066 # feature is still experimental and incomplete at the
1067 # moment.
1069 GENERATE_PERLMOD       = NO
1071 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1072 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1073 # to generate PDF and DVI output from the Perl module output.
1075 PERLMOD_LATEX          = NO
1077 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1078 # nicely formatted so it can be parsed by a human reader.  This is useful
1079 # if you want to understand what is going on.  On the other hand, if this
1080 # tag is set to NO the size of the Perl module output will be much smaller
1081 # and Perl will parse it just the same.
1083 PERLMOD_PRETTY         = YES
1085 # The names of the make variables in the generated doxyrules.make file
1086 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1087 # This is useful so different doxyrules.make files included by the same
1088 # Makefile don't overwrite each other's variables.
1090 PERLMOD_MAKEVAR_PREFIX =
1092 #---------------------------------------------------------------------------
1093 # Configuration options related to the preprocessor
1094 #---------------------------------------------------------------------------
1096 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1097 # evaluate all C-preprocessor directives found in the sources and include
1098 # files.
1100 ENABLE_PREPROCESSING   = YES
1102 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1103 # names in the source code. If set to NO (the default) only conditional
1104 # compilation will be performed. Macro expansion can be done in a controlled
1105 # way by setting EXPAND_ONLY_PREDEF to YES.
1107 MACRO_EXPANSION        = NO
1109 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1110 # then the macro expansion is limited to the macros specified with the
1111 # PREDEFINED and EXPAND_AS_DEFINED tags.
1113 EXPAND_ONLY_PREDEF     = NO
1115 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1116 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1118 SEARCH_INCLUDES        = YES
1120 # The INCLUDE_PATH tag can be used to specify one or more directories that
1121 # contain include files that are not input files but should be processed by
1122 # the preprocessor.
1124 INCLUDE_PATH           =
1126 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1127 # patterns (like *.h and *.hpp) to filter out the header-files in the
1128 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1129 # be used.
1131 INCLUDE_FILE_PATTERNS  =
1133 # The PREDEFINED tag can be used to specify one or more macro names that
1134 # are defined before the preprocessor is started (similar to the -D option of
1135 # gcc). The argument of the tag is a list of macros of the form: name
1136 # or name=definition (no spaces). If the definition and the = are
1137 # omitted =1 is assumed. To prevent a macro definition from being
1138 # undefined via #undef or recursively expanded use the := operator
1139 # instead of the = operator.
1141 PREDEFINED             =
1143 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1144 # this tag can be used to specify a list of macro names that should be expanded.
1145 # The macro definition that is found in the sources will be used.
1146 # Use the PREDEFINED tag if you want to use a different macro definition.
1148 EXPAND_AS_DEFINED      =
1150 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1151 # doxygen's preprocessor will remove all function-like macros that are alone
1152 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1153 # function macros are typically used for boiler-plate code, and will confuse
1154 # the parser if not removed.
1156 SKIP_FUNCTION_MACROS   = YES
1158 #---------------------------------------------------------------------------
1159 # Configuration::additions related to external references
1160 #---------------------------------------------------------------------------
1162 # The TAGFILES option can be used to specify one or more tagfiles.
1163 # Optionally an initial location of the external documentation
1164 # can be added for each tagfile. The format of a tag file without
1165 # this location is as follows:
1166 #   TAGFILES = file1 file2 ...
1167 # Adding location for the tag files is done as follows:
1168 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1169 # where "loc1" and "loc2" can be relative or absolute paths or
1170 # URLs. If a location is present for each tag, the installdox tool
1171 # does not have to be run to correct the links.
1172 # Note that each tag file must have a unique name
1173 # (where the name does NOT include the path)
1174 # If a tag file is not located in the directory in which doxygen
1175 # is run, you must also specify the path to the tagfile here.
1177 TAGFILES               =
1179 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1180 # a tag file that is based on the input files it reads.
1182 GENERATE_TAGFILE       =
1184 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1185 # in the class index. If set to NO only the inherited external classes
1186 # will be listed.
1188 ALLEXTERNALS           = NO
1190 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1191 # in the modules index. If set to NO, only the current project's groups will
1192 # be listed.
1194 EXTERNAL_GROUPS        = YES
1196 # The PERL_PATH should be the absolute path and name of the perl script
1197 # interpreter (i.e. the result of `which perl').
1199 PERL_PATH              = /usr/bin/perl
1201 #---------------------------------------------------------------------------
1202 # Configuration options related to the dot tool
1203 #---------------------------------------------------------------------------
1205 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1206 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1207 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1208 # this option is superseded by the HAVE_DOT option below. This is only a
1209 # fallback. It is recommended to install and use dot, since it yields more
1210 # powerful graphs.
1212 CLASS_DIAGRAMS         = YES
1214 # You can define message sequence charts within doxygen comments using the \msc
1215 # command. Doxygen will then run the mscgen tool (see
1216 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1217 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1218 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1219 # default search path.
1221 MSCGEN_PATH            =
1223 # If set to YES, the inheritance and collaboration graphs will hide
1224 # inheritance and usage relations if the target is undocumented
1225 # or is not a class.
1227 HIDE_UNDOC_RELATIONS   = YES
1229 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1230 # available from the path. This tool is part of Graphviz, a graph visualization
1231 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1232 # have no effect if this option is set to NO (the default)
1234 HAVE_DOT               = NO
1236 # By default doxygen will write a font called FreeSans.ttf to the output
1237 # directory and reference it in all dot files that doxygen generates. This
1238 # font does not include all possible unicode characters however, so when you need
1239 # these (or just want a differently looking font) you can specify the font name
1240 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1241 # which can be done by putting it in a standard location or by setting the
1242 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1243 # containing the font.
1245 DOT_FONTNAME           =
1247 # By default doxygen will tell dot to use the output directory to look for the
1248 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1249 # different font using DOT_FONTNAME you can set the path where dot
1250 # can find it using this tag.
1252 DOT_FONTPATH           =
1254 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1255 # will generate a graph for each documented class showing the direct and
1256 # indirect inheritance relations. Setting this tag to YES will force the
1257 # the CLASS_DIAGRAMS tag to NO.
1259 CLASS_GRAPH            = YES
1261 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1262 # will generate a graph for each documented class showing the direct and
1263 # indirect implementation dependencies (inheritance, containment, and
1264 # class references variables) of the class with other documented classes.
1266 COLLABORATION_GRAPH    = YES
1268 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1269 # will generate a graph for groups, showing the direct groups dependencies
1271 GROUP_GRAPHS           = YES
1273 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1274 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1275 # Language.
1277 UML_LOOK               = NO
1279 # If set to YES, the inheritance and collaboration graphs will show the
1280 # relations between templates and their instances.
1282 TEMPLATE_RELATIONS     = YES
1284 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1285 # tags are set to YES then doxygen will generate a graph for each documented
1286 # file showing the direct and indirect include dependencies of the file with
1287 # other documented files.
1289 INCLUDE_GRAPH          = YES
1291 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1292 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1293 # documented header file showing the documented files that directly or
1294 # indirectly include this file.
1296 INCLUDED_BY_GRAPH      = YES
1298 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1299 # doxygen will generate a call dependency graph for every global function
1300 # or class method. Note that enabling this option will significantly increase
1301 # the time of a run. So in most cases it will be better to enable call graphs
1302 # for selected functions only using the \callgraph command.
1304 CALL_GRAPH             = NO
1306 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1307 # doxygen will generate a caller dependency graph for every global function
1308 # or class method. Note that enabling this option will significantly increase
1309 # the time of a run. So in most cases it will be better to enable caller
1310 # graphs for selected functions only using the \callergraph command.
1312 CALLER_GRAPH           = NO
1314 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1315 # will graphical hierarchy of all classes instead of a textual one.
1317 GRAPHICAL_HIERARCHY    = YES
1319 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1320 # then doxygen will show the dependencies a directory has on other directories
1321 # in a graphical way. The dependency relations are determined by the #include
1322 # relations between the files in the directories.
1324 DIRECTORY_GRAPH        = YES
1326 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1327 # generated by dot. Possible values are png, jpg, or gif
1328 # If left blank png will be used.
1330 DOT_IMAGE_FORMAT       = png
1332 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1333 # found. If left blank, it is assumed the dot tool can be found in the path.
1335 DOT_PATH               =
1337 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1338 # contain dot files that are included in the documentation (see the
1339 # \dotfile command).
1341 DOTFILE_DIRS           =
1343 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1344 # nodes that will be shown in the graph. If the number of nodes in a graph
1345 # becomes larger than this value, doxygen will truncate the graph, which is
1346 # visualized by representing a node as a red box. Note that doxygen if the
1347 # number of direct children of the root node in a graph is already larger than
1348 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1349 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1351 DOT_GRAPH_MAX_NODES    = 50
1353 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1354 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1355 # from the root by following a path via at most 3 edges will be shown. Nodes
1356 # that lay further from the root node will be omitted. Note that setting this
1357 # option to 1 or 2 may greatly reduce the computation time needed for large
1358 # code bases. Also note that the size of a graph can be further restricted by
1359 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1361 MAX_DOT_GRAPH_DEPTH    = 0
1363 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1364 # background. This is enabled by default, which results in a transparent
1365 # background. Warning: Depending on the platform used, enabling this option
1366 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1367 # become hard to read).
1369 DOT_TRANSPARENT        = NO
1371 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1372 # files in one run (i.e. multiple -o and -T options on the command line). This
1373 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1374 # support this, this feature is disabled by default.
1376 DOT_MULTI_TARGETS      = NO
1378 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1379 # generate a legend page explaining the meaning of the various boxes and
1380 # arrows in the dot generated graphs.
1382 GENERATE_LEGEND        = YES
1384 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1385 # remove the intermediate dot files that are used to generate
1386 # the various graphs.
1388 DOT_CLEANUP            = YES
1390 #---------------------------------------------------------------------------
1391 # Configuration::additions related to the search engine
1392 #---------------------------------------------------------------------------
1394 # The SEARCHENGINE tag specifies whether or not a search engine should be
1395 # used. If set to NO the values of all tags below this one will be ignored.
1397 SEARCHENGINE           = NO