Fixed loosing almost all auras at first melee attack after login by partially reverti...
[getmangos.git] / doc / Doxyfile.in
blob599a79534f6b9f7a58eded22d9f3649ed922f979
1 # Doxyfile 1.5.3
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 that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21 # 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           = @PACKAGE@
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       = ./
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, Finnish, French, German, Greek, Hungarian,
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE        = English
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC      = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
76 REPEAT_BRIEF           = YES
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
88 ABBREVIATE_BRIEF       =
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
92 # description.
94 ALWAYS_DETAILED_SEC    = NO
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
99 # operators of the base classes will not be shown.
101 INLINE_INHERITED_MEMB  = NO
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
105 # to NO the shortest path that makes the file name unique will be used.
107 FULL_PATH_NAMES        = NO
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
114 # path to strip.
116 STRIP_FROM_PATH        = @top_srcdir@/
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
123 # are normally passed to the compiler using the -I flag.
125 STRIP_FROM_INC_PATH    =
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
131 SHORT_NAMES            = NO
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like regular Qt-style comments
137 # (thus requiring an explicit @brief command for a brief description.)
139 JAVADOC_AUTOBRIEF      = YES
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142 # interpret the first line (until the first dot) of a Qt-style
143 # comment as the brief description. If set to NO, the comments
144 # will behave just like regular Qt-style comments (thus requiring
145 # an explicit \brief command for a brief description.)
147 QT_AUTOBRIEF           = NO
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151 # comments) as a brief description. This used to be the default behaviour.
152 # The new default is to treat a multi-line C++ comment block as a detailed
153 # description. Set this tag to YES if you prefer the old behaviour instead.
155 MULTILINE_CPP_IS_BRIEF = NO
157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
158 # will output the detailed description near the top, like JavaDoc.
159 # If set to NO, the detailed description appears after the member
160 # documentation.
162 DETAILS_AT_TOP         = NO
164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165 # member inherits the documentation from any documented member that it
166 # re-implements.
168 INHERIT_DOCS           = YES
170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171 # a new page for each member. If set to NO, the documentation of a member will
172 # be part of the file/class/namespace that contains it.
174 SEPARATE_MEMBER_PAGES  = NO
176 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
177 # Doxygen uses this value to replace tabs by spaces in code fragments.
179 TAB_SIZE               = 4
181 # This tag can be used to specify a number of aliases that acts
182 # as commands in the documentation. An alias has the form "name=value".
183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
184 # put the command \sideeffect (or @sideeffect) in the documentation, which
185 # will result in a user-defined paragraph with heading "Side Effects:".
186 # You can put \n's in the value part of an alias to insert newlines.
188 ALIASES                = "memo=\par Note:\n " \
189                          "draft=\xrefitem draft \"Draft\" \"Draft List\"  This API may be changed in the future versions and was introduced in " \
190                          "stable=\xrefitem stable \"Stable\" \"Stable List\" " \
191                          "deprecated=\xrefitem deprecated \"Deprecated\" \"Deprecated List\" " \
192                          "obsolete=\xrefitem obsolete \"Obsolete\" \"Obsolete List\" " \
193                          "system=\xrefitem system \"System\" \"System List\" \n Do not use unless you know what you are doing. " \
194                          "internal=\xrefitem internal \"Internal\"  \"Internal List\"  Do not use. This API is for interal use only. "
196 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
197 # sources only. Doxygen will then generate output that is more tailored for C.
198 # For instance, some of the names that are used will be different. The list
199 # of all members will be omitted, etc.
201 OPTIMIZE_OUTPUT_FOR_C  = YES
203 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
204 # sources only. Doxygen will then generate output that is more tailored for Java.
205 # For instance, namespaces will be presented as packages, qualified scopes
206 # will look different, etc.
208 OPTIMIZE_OUTPUT_JAVA   = NO
210 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
211 # include (a tag file for) the STL sources as input, then you should
212 # set this tag to YES in order to let doxygen match functions declarations and
213 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
214 # func(std::string) {}). This also make the inheritance and collaboration
215 # diagrams that involve STL classes more complete and accurate.
217 BUILTIN_STL_SUPPORT    = NO
219 # If you use Microsoft's C++/CLI language, you should set this option to YES to
220 # enable parsing support.
222 CPP_CLI_SUPPORT        = NO
224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
225 # tag is set to YES, then doxygen will reuse the documentation of the first
226 # member in the group (if any) for the other members of the group. By default
227 # all members of a group must be documented explicitly.
229 DISTRIBUTE_GROUP_DOC   = NO
231 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
232 # the same type (for instance a group of public functions) to be put as a
233 # subgroup of that type (e.g. under the Public Functions section). Set it to
234 # NO to prevent subgrouping. Alternatively, this can be done per class using
235 # the \nosubgrouping command.
237 SUBGROUPING            = YES
239 #---------------------------------------------------------------------------
240 # Build related configuration options
241 #---------------------------------------------------------------------------
243 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
244 # documentation are documented, even if no documentation was available.
245 # Private class members and static file members will be hidden unless
246 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
248 EXTRACT_ALL            = NO
250 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
251 # will be included in the documentation.
253 EXTRACT_PRIVATE        = NO
255 # If the EXTRACT_STATIC tag is set to YES all static members of a file
256 # will be included in the documentation.
258 EXTRACT_STATIC         = NO
260 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
261 # defined locally in source files will be included in the documentation.
262 # If set to NO only classes defined in header files are included.
264 EXTRACT_LOCAL_CLASSES  = YES
266 # This flag is only useful for Objective-C code. When set to YES local
267 # methods, which are defined in the implementation section but not in
268 # the interface are included in the documentation.
269 # If set to NO (the default) only methods in the interface are included.
271 EXTRACT_LOCAL_METHODS  = YES
273 # If this flag is set to YES, the members of anonymous namespaces will be extracted
274 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
275 # where file will be replaced with the base name of the file that contains the anonymous
276 # namespace. By default anonymous namespace are hidden.
278 EXTRACT_ANON_NSPACES   = NO
280 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
281 # undocumented members of documented classes, files or namespaces.
282 # If set to NO (the default) these members will be included in the
283 # various overviews, but no documentation section is generated.
284 # This option has no effect if EXTRACT_ALL is enabled.
286 HIDE_UNDOC_MEMBERS     = NO
288 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
289 # undocumented classes that are normally visible in the class hierarchy.
290 # If set to NO (the default) these classes will be included in the various
291 # overviews. This option has no effect if EXTRACT_ALL is enabled.
293 HIDE_UNDOC_CLASSES     = NO
295 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
296 # friend (class|struct|union) declarations.
297 # If set to NO (the default) these declarations will be included in the
298 # documentation.
300 HIDE_FRIEND_COMPOUNDS  = NO
302 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
303 # documentation blocks found inside the body of a function.
304 # If set to NO (the default) these blocks will be appended to the
305 # function's detailed documentation block.
307 HIDE_IN_BODY_DOCS      = NO
309 # The INTERNAL_DOCS tag determines if documentation
310 # that is typed after a \internal command is included. If the tag is set
311 # to NO (the default) then the documentation will be excluded.
312 # Set it to YES to include the internal documentation.
314 INTERNAL_DOCS          = YES
316 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
317 # file names in lower-case letters. If set to YES upper-case letters are also
318 # allowed. This is useful if you have classes or files whose names only differ
319 # in case and if your file system supports case sensitive file names. Windows
320 # and Mac users are advised to set this option to NO.
322 CASE_SENSE_NAMES       = YES
324 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
325 # will show members with their full class and namespace scopes in the
326 # documentation. If set to YES the scope will be hidden.
328 HIDE_SCOPE_NAMES       = NO
330 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
331 # will put a list of the files that are included by a file in the documentation
332 # of that file.
334 SHOW_INCLUDE_FILES     = YES
336 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
337 # is inserted in the documentation for inline members.
339 INLINE_INFO            = YES
341 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
342 # will sort the (detailed) documentation of file and class members
343 # alphabetically by member name. If set to NO the members will appear in
344 # declaration order.
346 SORT_MEMBER_DOCS       = YES
348 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
349 # brief documentation of file, namespace and class members alphabetically
350 # by member name. If set to NO (the default) the members will appear in
351 # declaration order.
353 SORT_BRIEF_DOCS        = NO
355 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
356 # sorted by fully-qualified names, including namespaces. If set to
357 # NO (the default), the class list will be sorted only by class name,
358 # not including the namespace part.
359 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
360 # Note: This option applies only to the class list, not to the
361 # alphabetical list.
363 SORT_BY_SCOPE_NAME     = NO
365 # The GENERATE_TODOLIST tag can be used to enable (YES) or
366 # disable (NO) the todo list. This list is created by putting \todo
367 # commands in the documentation.
369 GENERATE_TODOLIST      = YES
371 # The GENERATE_TESTLIST tag can be used to enable (YES) or
372 # disable (NO) the test list. This list is created by putting \test
373 # commands in the documentation.
375 GENERATE_TESTLIST      = YES
377 # The GENERATE_BUGLIST tag can be used to enable (YES) or
378 # disable (NO) the bug list. This list is created by putting \bug
379 # commands in the documentation.
381 GENERATE_BUGLIST       = YES
383 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
384 # disable (NO) the deprecated list. This list is created by putting
385 # \deprecated commands in the documentation.
387 GENERATE_DEPRECATEDLIST= YES
389 # The ENABLED_SECTIONS tag can be used to enable conditional
390 # documentation sections, marked by \if sectionname ... \endif.
392 ENABLED_SECTIONS       =
394 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
395 # the initial value of a variable or define consists of for it to appear in
396 # the documentation. If the initializer consists of more lines than specified
397 # here it will be hidden. Use a value of 0 to hide initializers completely.
398 # The appearance of the initializer of individual variables and defines in the
399 # documentation can be controlled using \showinitializer or \hideinitializer
400 # command in the documentation regardless of this setting.
402 MAX_INITIALIZER_LINES  = 30
404 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
405 # at the bottom of the documentation of classes and structs. If set to YES the
406 # list will mention the files that were used to generate the documentation.
408 SHOW_USED_FILES        = YES
410 # If the sources in your project are distributed over multiple directories
411 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
412 # in the documentation. The default is NO.
414 SHOW_DIRECTORIES       = NO
416 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
417 # doxygen should invoke to get the current version for each file (typically from the
418 # version control system). Doxygen will invoke the program by executing (via
419 # popen()) the command <command> <input-file>, where <command> is the value of
420 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
421 # provided by doxygen. Whatever the program writes to standard output
422 # is used as the file version. See the manual for examples.
424 FILE_VERSION_FILTER    =
426 #---------------------------------------------------------------------------
427 # configuration options related to warning and progress messages
428 #---------------------------------------------------------------------------
430 # The QUIET tag can be used to turn on/off the messages that are generated
431 # by doxygen. Possible values are YES and NO. If left blank NO is used.
433 QUIET                  = NO
435 # The WARNINGS tag can be used to turn on/off the warning messages that are
436 # generated by doxygen. Possible values are YES and NO. If left blank
437 # NO is used.
439 WARNINGS               = YES
441 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
442 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
443 # automatically be disabled.
445 WARN_IF_UNDOCUMENTED   = YES
447 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
448 # potential errors in the documentation, such as not documenting some
449 # parameters in a documented function, or documenting parameters that
450 # don't exist or using markup commands wrongly.
452 WARN_IF_DOC_ERROR      = YES
454 # This WARN_NO_PARAMDOC option can be abled to get warnings for
455 # functions that are documented, but have no documentation for their parameters
456 # or return value. If set to NO (the default) doxygen will only warn about
457 # wrong or incomplete parameter documentation, but not about the absence of
458 # documentation.
460 WARN_NO_PARAMDOC       = NO
462 # The WARN_FORMAT tag determines the format of the warning messages that
463 # doxygen can produce. The string should contain the $file, $line, and $text
464 # tags, which will be replaced by the file and line number from which the
465 # warning originated and the warning text. Optionally the format may contain
466 # $version, which will be replaced by the version of the file (if it could
467 # be obtained via FILE_VERSION_FILTER)
469 WARN_FORMAT            = "$file:$line: $text "
471 # The WARN_LOGFILE tag can be used to specify a file to which warning
472 # and error messages should be written. If left blank the output is written
473 # to stderr.
475 WARN_LOGFILE           =
477 #---------------------------------------------------------------------------
478 # configuration options related to the input files
479 #---------------------------------------------------------------------------
481 # The INPUT tag can be used to specify the files and/or directories that contain
482 # documented source files. You may enter file names like "myfile.cpp" or
483 # directories like "/usr/src/myproject". Separate the files or directories
484 # with spaces.
486 INPUT                  = @top_srcdir@/src/shared/ \
487                          @top_srcdir@/src/shared/Auth/ \
488                          @top_srcdir@/src/shared/Database/ \
489                          @top_srcdir@/src/game/ \
490                          @top_srcdir@/src/realmd/ \
491                          @top_srcdir@/src/mangosd/ \
492                          DocStructure.dox
494 # This tag can be used to specify the character encoding of the source files that
495 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
496 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
497 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
499 INPUT_ENCODING         = UTF-8
501 # If the value of the INPUT tag contains directories, you can use the
502 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
503 # and *.h) to filter out the source-files in the directories. If left
504 # blank the following patterns are tested:
505 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
506 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
508 FILE_PATTERNS          = *.cpp \
509                          *.h \
510                          *.hpp
512 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
513 # should be searched for input files as well. Possible values are YES and NO.
514 # If left blank NO is used.
516 RECURSIVE              = NO
518 # The EXCLUDE tag can be used to specify files and/or directories that should
519 # excluded from the INPUT source files. This way you can easily exclude a
520 # subdirectory from a directory tree whose root is specified with the INPUT tag.
522 EXCLUDE                =
524 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
525 # directories that are symbolic links (a Unix filesystem feature) are excluded
526 # from the input.
528 EXCLUDE_SYMLINKS       = NO
530 # If the value of the INPUT tag contains directories, you can use the
531 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
532 # certain files from those directories. Note that the wildcards are matched
533 # against the file with absolute path, so to exclude all test directories
534 # for example use the pattern */test/*
536 EXCLUDE_PATTERNS       = config*.h
538 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
539 # (namespaces, classes, functions, etc.) that should be excluded from the output.
540 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
541 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
543 EXCLUDE_SYMBOLS        =
545 # The EXAMPLE_PATH tag can be used to specify one or more files or
546 # directories that contain example code fragments that are included (see
547 # the \include command).
549 EXAMPLE_PATH           =
551 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
552 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
553 # and *.h) to filter out the source-files in the directories. If left
554 # blank all files are included.
556 EXAMPLE_PATTERNS       =
558 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
559 # searched for input files to be used with the \include or \dontinclude
560 # commands irrespective of the value of the RECURSIVE tag.
561 # Possible values are YES and NO. If left blank NO is used.
563 EXAMPLE_RECURSIVE      = NO
565 # The IMAGE_PATH tag can be used to specify one or more files or
566 # directories that contain image that are included in the documentation (see
567 # the \image command).
569 IMAGE_PATH             =
571 # The INPUT_FILTER tag can be used to specify a program that doxygen should
572 # invoke to filter for each input file. Doxygen will invoke the filter program
573 # by executing (via popen()) the command <filter> <input-file>, where <filter>
574 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
575 # input file. Doxygen will then use the output that the filter program writes
576 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
577 # ignored.
579 INPUT_FILTER           =
581 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
582 # basis.  Doxygen will compare the file name with each pattern and apply the
583 # filter if there is a match.  The filters are a list of the form:
584 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
585 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
586 # is applied to all files.
588 FILTER_PATTERNS        =
590 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
591 # INPUT_FILTER) will be used to filter the input files when producing source
592 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
594 FILTER_SOURCE_FILES    = NO
596 #---------------------------------------------------------------------------
597 # configuration options related to source browsing
598 #---------------------------------------------------------------------------
600 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
601 # be generated. Documented entities will be cross-referenced with these sources.
602 # Note: To get rid of all source code in the generated output, make sure also
603 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
604 # then you must also enable this option. If you don't then doxygen will produce
605 # a warning and turn it on anyway
607 SOURCE_BROWSER         = YES
609 # Setting the INLINE_SOURCES tag to YES will include the body
610 # of functions and classes directly in the documentation.
612 INLINE_SOURCES         = NO
614 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
615 # doxygen to hide any special comment blocks from generated source code
616 # fragments. Normal C and C++ comments will always remain visible.
618 STRIP_CODE_COMMENTS    = YES
620 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
621 # then for each documented function all documented
622 # functions referencing it will be listed.
624 REFERENCED_BY_RELATION = YES
626 # If the REFERENCES_RELATION tag is set to YES (the default)
627 # then for each documented function all documented entities
628 # called/used by that function will be listed.
630 REFERENCES_RELATION    = YES
632 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
633 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
634 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
635 # link to the source code.  Otherwise they will link to the documentstion.
637 REFERENCES_LINK_SOURCE = YES
639 # If the USE_HTAGS tag is set to YES then the references to source code
640 # will point to the HTML generated by the htags(1) tool instead of doxygen
641 # built-in source browser. The htags tool is part of GNU's global source
642 # tagging system (see http://www.gnu.org/software/global/global.html). You
643 # will need version 4.8.6 or higher.
645 USE_HTAGS              = NO
647 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
648 # will generate a verbatim copy of the header file for each class for
649 # which an include is specified. Set to NO to disable this.
651 VERBATIM_HEADERS       = YES
653 #---------------------------------------------------------------------------
654 # configuration options related to the alphabetical class index
655 #---------------------------------------------------------------------------
657 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
658 # of all compounds will be generated. Enable this if the project
659 # contains a lot of classes, structs, unions or interfaces.
661 ALPHABETICAL_INDEX     = YES
663 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
664 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
665 # in which this list will be split (can be a number in the range [1..20])
667 COLS_IN_ALPHA_INDEX    = 5
669 # In case all classes in a project start with a common prefix, all
670 # classes will be put under the same header in the alphabetical index.
671 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
672 # should be ignored while generating the index headers.
674 IGNORE_PREFIX          =
676 #---------------------------------------------------------------------------
677 # configuration options related to the HTML output
678 #---------------------------------------------------------------------------
680 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
681 # generate HTML output.
683 GENERATE_HTML          = YES
685 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
686 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
687 # put in front of it. If left blank `html' will be used as the default path.
689 HTML_OUTPUT            = html
691 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
692 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
693 # doxygen will generate files with .html extension.
695 HTML_FILE_EXTENSION    = .html
697 # The HTML_HEADER tag can be used to specify a personal HTML header for
698 # each generated HTML page. If it is left blank doxygen will generate a
699 # standard header.
701 HTML_HEADER            =
703 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
704 # each generated HTML page. If it is left blank doxygen will generate a
705 # standard footer.
707 HTML_FOOTER            =
709 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
710 # style sheet that is used by each HTML page. It can be used to
711 # fine-tune the look of the HTML output. If the tag is left blank doxygen
712 # will generate a default style sheet. Note that doxygen will try to copy
713 # the style sheet file to the HTML output directory, so don't put your own
714 # stylesheet in the HTML output directory as well, or it will be erased!
716 HTML_STYLESHEET        =
718 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
719 # files or namespaces will be aligned in HTML using tables. If set to
720 # NO a bullet list will be used.
722 HTML_ALIGN_MEMBERS     = YES
724 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
725 # will be generated that can be used as input for tools like the
726 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
727 # of the generated HTML documentation.
729 GENERATE_HTMLHELP      = NO
731 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
732 # documentation will contain sections that can be hidden and shown after the
733 # page has loaded. For this to work a browser that supports
734 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
735 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
737 HTML_DYNAMIC_SECTIONS  = NO
739 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
740 # be used to specify the file name of the resulting .chm file. You
741 # can add a path in front of the file if the result should not be
742 # written to the html output directory.
744 CHM_FILE               =
746 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
747 # be used to specify the location (absolute path including file name) of
748 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
749 # the HTML help compiler on the generated index.hhp.
751 HHC_LOCATION           =
753 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
754 # controls if a separate .chi index file is generated (YES) or that
755 # it should be included in the master .chm file (NO).
757 GENERATE_CHI           = NO
759 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
760 # controls whether a binary table of contents is generated (YES) or a
761 # normal table of contents (NO) in the .chm file.
763 BINARY_TOC             = NO
765 # The TOC_EXPAND flag can be set to YES to add extra items for group members
766 # to the contents of the HTML help documentation and to the tree view.
768 TOC_EXPAND             = NO
770 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
771 # top of each HTML page. The value NO (the default) enables the index and
772 # the value YES disables it.
774 DISABLE_INDEX          = NO
776 # This tag can be used to set the number of enum values (range [1..20])
777 # that doxygen will group on one line in the generated HTML documentation.
779 ENUM_VALUES_PER_LINE   = 4
781 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
782 # generated containing a tree-like index structure (just like the one that
783 # is generated for HTML Help). For this to work a browser that supports
784 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
785 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
786 # probably better off using the HTML help feature.
788 GENERATE_TREEVIEW      = NO
790 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
791 # used to set the initial width (in pixels) of the frame in which the tree
792 # is shown.
794 TREEVIEW_WIDTH         = 250
796 #---------------------------------------------------------------------------
797 # configuration options related to the LaTeX output
798 #---------------------------------------------------------------------------
800 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
801 # generate Latex output.
803 GENERATE_LATEX         = NO
805 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
806 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
807 # put in front of it. If left blank `latex' will be used as the default path.
809 LATEX_OUTPUT           = latex
811 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
812 # invoked. If left blank `latex' will be used as the default command name.
814 LATEX_CMD_NAME         = latex
816 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
817 # generate index for LaTeX. If left blank `makeindex' will be used as the
818 # default command name.
820 MAKEINDEX_CMD_NAME     = makeindex
822 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
823 # LaTeX documents. This may be useful for small projects and may help to
824 # save some trees in general.
826 COMPACT_LATEX          = NO
828 # The PAPER_TYPE tag can be used to set the paper type that is used
829 # by the printer. Possible values are: a4, a4wide, letter, legal and
830 # executive. If left blank a4wide will be used.
832 PAPER_TYPE             = a4wide
834 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
835 # packages that should be included in the LaTeX output.
837 EXTRA_PACKAGES         =
839 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
840 # the generated latex document. The header should contain everything until
841 # the first chapter. If it is left blank doxygen will generate a
842 # standard header. Notice: only use this tag if you know what you are doing!
844 LATEX_HEADER           =
846 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
847 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
848 # contain links (just like the HTML output) instead of page references
849 # This makes the output suitable for online browsing using a pdf viewer.
851 PDF_HYPERLINKS         = NO
853 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
854 # plain latex in the generated Makefile. Set this option to YES to get a
855 # higher quality PDF documentation.
857 USE_PDFLATEX           = NO
859 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
860 # command to the generated LaTeX files. This will instruct LaTeX to keep
861 # running if errors occur, instead of asking the user for help.
862 # This option is also used when generating formulas in HTML.
864 LATEX_BATCHMODE        = NO
866 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
867 # include the index chapters (such as File Index, Compound Index, etc.)
868 # in the output.
870 LATEX_HIDE_INDICES     = NO
872 #---------------------------------------------------------------------------
873 # configuration options related to the RTF output
874 #---------------------------------------------------------------------------
876 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
877 # The RTF output is optimized for Word 97 and may not look very pretty with
878 # other RTF readers or editors.
880 GENERATE_RTF           = NO
882 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
883 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
884 # put in front of it. If left blank `rtf' will be used as the default path.
886 RTF_OUTPUT             = rtf
888 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
889 # RTF documents. This may be useful for small projects and may help to
890 # save some trees in general.
892 COMPACT_RTF            = NO
894 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
895 # will contain hyperlink fields. The RTF file will
896 # contain links (just like the HTML output) instead of page references.
897 # This makes the output suitable for online browsing using WORD or other
898 # programs which support those fields.
899 # Note: wordpad (write) and others do not support links.
901 RTF_HYPERLINKS         = NO
903 # Load stylesheet definitions from file. Syntax is similar to doxygen's
904 # config file, i.e. a series of assignments. You only have to provide
905 # replacements, missing definitions are set to their default value.
907 RTF_STYLESHEET_FILE    =
909 # Set optional variables used in the generation of an rtf document.
910 # Syntax is similar to doxygen's config file.
912 RTF_EXTENSIONS_FILE    =
914 #---------------------------------------------------------------------------
915 # configuration options related to the man page output
916 #---------------------------------------------------------------------------
918 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
919 # generate man pages
921 GENERATE_MAN           = NO
923 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
924 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
925 # put in front of it. If left blank `man' will be used as the default path.
927 MAN_OUTPUT             = man
929 # The MAN_EXTENSION tag determines the extension that is added to
930 # the generated man pages (default is the subroutine's section .3)
932 MAN_EXTENSION          = .3
934 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
935 # then it will generate one additional man file for each entity
936 # documented in the real man page(s). These additional files
937 # only source the real man page, but without them the man command
938 # would be unable to find the correct page. The default is NO.
940 MAN_LINKS              = NO
942 #---------------------------------------------------------------------------
943 # configuration options related to the XML output
944 #---------------------------------------------------------------------------
946 # If the GENERATE_XML tag is set to YES Doxygen will
947 # generate an XML file that captures the structure of
948 # the code including all documentation.
950 GENERATE_XML           = NO
952 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
953 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
954 # put in front of it. If left blank `xml' will be used as the default path.
956 XML_OUTPUT             = xml
958 # The XML_SCHEMA tag can be used to specify an XML schema,
959 # which can be used by a validating XML parser to check the
960 # syntax of the XML files.
962 XML_SCHEMA             =
964 # The XML_DTD tag can be used to specify an XML DTD,
965 # which can be used by a validating XML parser to check the
966 # syntax of the XML files.
968 XML_DTD                =
970 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
971 # dump the program listings (including syntax highlighting
972 # and cross-referencing information) to the XML output. Note that
973 # enabling this will significantly increase the size of the XML output.
975 XML_PROGRAMLISTING     = YES
977 #---------------------------------------------------------------------------
978 # configuration options for the AutoGen Definitions output
979 #---------------------------------------------------------------------------
981 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
982 # generate an AutoGen Definitions (see autogen.sf.net) file
983 # that captures the structure of the code including all
984 # documentation. Note that this feature is still experimental
985 # and incomplete at the moment.
987 GENERATE_AUTOGEN_DEF   = NO
989 #---------------------------------------------------------------------------
990 # configuration options related to the Perl module output
991 #---------------------------------------------------------------------------
993 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
994 # generate a Perl module file that captures the structure of
995 # the code including all documentation. Note that this
996 # feature is still experimental and incomplete at the
997 # moment.
999 GENERATE_PERLMOD       = NO
1001 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1002 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1003 # to generate PDF and DVI output from the Perl module output.
1005 PERLMOD_LATEX          = YES
1007 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1008 # nicely formatted so it can be parsed by a human reader.  This is useful
1009 # if you want to understand what is going on.  On the other hand, if this
1010 # tag is set to NO the size of the Perl module output will be much smaller
1011 # and Perl will parse it just the same.
1013 PERLMOD_PRETTY         = YES
1015 # The names of the make variables in the generated doxyrules.make file
1016 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1017 # This is useful so different doxyrules.make files included by the same
1018 # Makefile don't overwrite each other's variables.
1020 PERLMOD_MAKEVAR_PREFIX =
1022 #---------------------------------------------------------------------------
1023 # Configuration options related to the preprocessor
1024 #---------------------------------------------------------------------------
1026 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1027 # evaluate all C-preprocessor directives found in the sources and include
1028 # files.
1030 ENABLE_PREPROCESSING   = YES
1032 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1033 # names in the source code. If set to NO (the default) only conditional
1034 # compilation will be performed. Macro expansion can be done in a controlled
1035 # way by setting EXPAND_ONLY_PREDEF to YES.
1037 MACRO_EXPANSION        = YES
1039 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1040 # then the macro expansion is limited to the macros specified with the
1041 # PREDEFINED and EXPAND_AS_DEFINED tags.
1043 EXPAND_ONLY_PREDEF     = YES
1045 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1046 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1048 SEARCH_INCLUDES        = YES
1050 # The INCLUDE_PATH tag can be used to specify one or more directories that
1051 # contain include files that are not input files but should be processed by
1052 # the preprocessor.
1054 INCLUDE_PATH           =
1056 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1057 # patterns (like *.h and *.hpp) to filter out the header-files in the
1058 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1059 # be used.
1061 INCLUDE_FILE_PATTERNS  =
1063 # The PREDEFINED tag can be used to specify one or more macro names that
1064 # are defined before the preprocessor is started (similar to the -D option of
1065 # gcc). The argument of the tag is a list of macros of the form: name
1066 # or name=definition (no spaces). If the definition and the = are
1067 # omitted =1 is assumed. To prevent a macro definition from being
1068 # undefined via #undef or recursively expanded use the := operator
1069 # instead of the = operator.
1071 PREDEFINED             = U_EXPORT2 \
1072                          U_STABLE \
1073                          U_DRAFT \
1074                          U_INTERNAL \
1075                          U_SYSTEM \
1076                          U_DEPRECATED \
1077                          U_OBSOLETE
1079 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1080 # this tag can be used to specify a list of macro names that should be expanded.
1081 # The macro definition that is found in the sources will be used.
1082 # Use the PREDEFINED tag if you want to use a different macro definition.
1084 EXPAND_AS_DEFINED      =
1086 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1087 # doxygen's preprocessor will remove all function-like macros that are alone
1088 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1089 # function macros are typically used for boiler-plate code, and will confuse
1090 # the parser if not removed.
1092 SKIP_FUNCTION_MACROS   = YES
1094 #---------------------------------------------------------------------------
1095 # Configuration::additions related to external references
1096 #---------------------------------------------------------------------------
1098 # The TAGFILES option can be used to specify one or more tagfiles.
1099 # Optionally an initial location of the external documentation
1100 # can be added for each tagfile. The format of a tag file without
1101 # this location is as follows:
1102 #   TAGFILES = file1 file2 ...
1103 # Adding location for the tag files is done as follows:
1104 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1105 # where "loc1" and "loc2" can be relative or absolute paths or
1106 # URLs. If a location is present for each tag, the installdox tool
1107 # does not have to be run to correct the links.
1108 # Note that each tag file must have a unique name
1109 # (where the name does NOT include the path)
1110 # If a tag file is not located in the directory in which doxygen
1111 # is run, you must also specify the path to the tagfile here.
1113 TAGFILES               =
1115 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1116 # a tag file that is based on the input files it reads.
1118 GENERATE_TAGFILE       = "@srcdir@/html/mangos-ng-docs.tag "
1120 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1121 # in the class index. If set to NO only the inherited external classes
1122 # will be listed.
1124 ALLEXTERNALS           = NO
1126 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1127 # in the modules index. If set to NO, only the current project's groups will
1128 # be listed.
1130 EXTERNAL_GROUPS        = YES
1132 # The PERL_PATH should be the absolute path and name of the perl script
1133 # interpreter (i.e. the result of `which perl').
1135 PERL_PATH              = /usr/bin/perl
1137 #---------------------------------------------------------------------------
1138 # Configuration options related to the dot tool
1139 #---------------------------------------------------------------------------
1141 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1142 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1143 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1144 # this option is superseded by the HAVE_DOT option below. This is only a
1145 # fallback. It is recommended to install and use dot, since it yields more
1146 # powerful graphs.
1148 CLASS_DIAGRAMS         = YES
1150 # You can define message sequence charts within doxygen comments using the \msc
1151 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1152 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1153 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1154 # be found in the default search path.
1156 MSCGEN_PATH            =
1158 # If set to YES, the inheritance and collaboration graphs will hide
1159 # inheritance and usage relations if the target is undocumented
1160 # or is not a class.
1162 HIDE_UNDOC_RELATIONS   = YES
1164 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1165 # available from the path. This tool is part of Graphviz, a graph visualization
1166 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1167 # have no effect if this option is set to NO (the default)
1169 HAVE_DOT               = NO
1171 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1172 # will generate a graph for each documented class showing the direct and
1173 # indirect inheritance relations. Setting this tag to YES will force the
1174 # the CLASS_DIAGRAMS tag to NO.
1176 CLASS_GRAPH            = YES
1178 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1179 # will generate a graph for each documented class showing the direct and
1180 # indirect implementation dependencies (inheritance, containment, and
1181 # class references variables) of the class with other documented classes.
1183 COLLABORATION_GRAPH    = YES
1185 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1186 # will generate a graph for groups, showing the direct groups dependencies
1188 GROUP_GRAPHS           = YES
1190 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1191 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1192 # Language.
1194 UML_LOOK               = NO
1196 # If set to YES, the inheritance and collaboration graphs will show the
1197 # relations between templates and their instances.
1199 TEMPLATE_RELATIONS     = NO
1201 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1202 # tags are set to YES then doxygen will generate a graph for each documented
1203 # file showing the direct and indirect include dependencies of the file with
1204 # other documented files.
1206 INCLUDE_GRAPH          = YES
1208 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1209 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1210 # documented header file showing the documented files that directly or
1211 # indirectly include this file.
1213 INCLUDED_BY_GRAPH      = YES
1215 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1216 # generate a call dependency graph for every global function or class method.
1217 # Note that enabling this option will significantly increase the time of a run.
1218 # So in most cases it will be better to enable call graphs for selected
1219 # functions only using the \callgraph command.
1221 CALL_GRAPH             = NO
1223 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1224 # generate a caller dependency graph for every global function or class method.
1225 # Note that enabling this option will significantly increase the time of a run.
1226 # So in most cases it will be better to enable caller graphs for selected
1227 # functions only using the \callergraph command.
1229 CALLER_GRAPH           = NO
1231 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1232 # will graphical hierarchy of all classes instead of a textual one.
1234 GRAPHICAL_HIERARCHY    = YES
1236 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1237 # then doxygen will show the dependencies a directory has on other directories
1238 # in a graphical way. The dependency relations are determined by the #include
1239 # relations between the files in the directories.
1241 DIRECTORY_GRAPH        = YES
1243 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1244 # generated by dot. Possible values are png, jpg, or gif
1245 # If left blank png will be used.
1247 DOT_IMAGE_FORMAT       = png
1249 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1250 # found. If left blank, it is assumed the dot tool can be found in the path.
1252 DOT_PATH               =
1254 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1255 # contain dot files that are included in the documentation (see the
1256 # \dotfile command).
1258 DOTFILE_DIRS           =
1260 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1261 # nodes that will be shown in the graph. If the number of nodes in a graph
1262 # becomes larger than this value, doxygen will truncate the graph, which is
1263 # visualized by representing a node as a red box. Note that doxygen if the number
1264 # of direct children of the root node in a graph is already larger than
1265 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1266 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1268 DOT_GRAPH_MAX_NODES    = 50
1270 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1271 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1272 # from the root by following a path via at most 3 edges will be shown. Nodes
1273 # that lay further from the root node will be omitted. Note that setting this
1274 # option to 1 or 2 may greatly reduce the computation time needed for large
1275 # code bases. Also note that the size of a graph can be further restricted by
1276 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1278 MAX_DOT_GRAPH_DEPTH    = 0
1280 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1281 # background. This is disabled by default, which results in a white background.
1282 # Warning: Depending on the platform used, enabling this option may lead to
1283 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1284 # read).
1286 DOT_TRANSPARENT        = NO
1288 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1289 # files in one run (i.e. multiple -o and -T options on the command line). This
1290 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1291 # support this, this feature is disabled by default.
1293 DOT_MULTI_TARGETS      = NO
1295 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1296 # generate a legend page explaining the meaning of the various boxes and
1297 # arrows in the dot generated graphs.
1299 GENERATE_LEGEND        = YES
1301 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1302 # remove the intermediate dot files that are used to generate
1303 # the various graphs.
1305 DOT_CLEANUP            = YES
1307 #---------------------------------------------------------------------------
1308 # Configuration::additions related to the search engine
1309 #---------------------------------------------------------------------------
1311 # The SEARCHENGINE tag specifies whether or not a search engine should be
1312 # used. If set to NO the values of all tags below this one will be ignored.
1314 SEARCHENGINE           = YES