4 # This file describes the settings to be used by the documentation system
5 # doxygen (www.doxygen.org) for a project
7 # All text after a hash (#) is considered a comment and will be ignored
9 # TAG = value [value, ...]
10 # For lists items can also be appended using:
11 # TAG += value [value, ...]
12 # Values that contain spaces should be placed between quotes (" ")
14 #---------------------------------------------------------------------------
15 # Project related configuration options
16 #---------------------------------------------------------------------------
18 # This tag specifies the encoding used for all characters in the config file
19 # that follow. The default is UTF-8 which is also the encoding used for all
20 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
21 # iconv built into libc) for the transcoding. See
22 # http://www.gnu.org/software/libiconv for the list of possible encodings.
24 DOXYFILE_ENCODING = UTF-8
26 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
27 # by quotes) that should identify the project.
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
33 # if some version control system is used.
35 PROJECT_NUMBER = @PACKAGE_VERSION@
37 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
38 # base path where the generated documentation will be put.
39 # If a relative path is entered, it will be relative to the location
40 # where doxygen was started. If left blank the current directory will be used.
42 OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
44 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
45 # 4096 sub-directories (in 2 levels) under the output directory of each output
46 # format and will distribute the generated files over these directories.
47 # Enabling this option can be useful when feeding doxygen a huge amount of
48 # source files, where putting all generated files in the same directory would
49 # otherwise cause performance problems for the file system.
53 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
54 # documentation generated by doxygen is written. Doxygen will use this
55 # information to generate all constant output in the proper language.
56 # The default language is English, other supported languages are:
57 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
58 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
59 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
60 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
61 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
62 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
64 OUTPUT_LANGUAGE = English
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
71 BRIEF_MEMBER_DESC = YES
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description.
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 # brief descriptions will be completely suppressed.
80 # This tag implements a quasi-intelligent brief description abbreviator
81 # that is used to form the text in various listings. Each string
82 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is
84 # used as the annotated text. Otherwise, the brief description is used as-is.
85 # If left blank, the following values are used ("$name" is automatically
86 # replaced with the name of the entity): "The $name class" "The $name widget"
87 # "The $name file" "is" "provides" "specifies" "contains"
88 # "represents" "a" "an" "the"
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93 # Doxygen will generate a detailed section even if there is only a brief
96 ALWAYS_DETAILED_SEC = NO
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # inherited members of a class in the documentation of that class as if those
100 # members were ordinary class members. Constructors, destructors and assignment
101 # operators of the base classes will not be shown.
103 INLINE_INHERITED_MEMB = NO
105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106 # path before files name in the file list and in the header files. If set
107 # to NO the shortest path that makes the file name unique will be used.
111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112 # can be used to strip a user-defined part of the path. Stripping is
113 # only done if one of the specified strings matches the left-hand part of
114 # the path. The tag can be used to show relative paths in the file list.
115 # If left blank the directory from which doxygen is run is used as the
118 STRIP_FROM_PATH = ../..
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the path mentioned in the documentation of a class, which tells
122 # the reader which header file to include in order to use a class.
123 # If left blank only the name of the header file containing the class
124 # definition is used. Otherwise one should specify the include paths that
125 # are normally passed to the compiler using the -I flag.
127 STRIP_FROM_INC_PATH =
129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130 # (but less readable) file names. This can be useful is your file systems
131 # doesn't support long names like on DOS, Mac, or CD-ROM.
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # will interpret the first line (until the first dot) of a JavaDoc-style
137 # comment as the brief description. If set to NO, the JavaDoc
138 # comments will behave just like regular Qt-style comments
139 # (thus requiring an explicit @brief command for a brief description.)
141 JAVADOC_AUTOBRIEF = NO
143 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
144 # interpret the first line (until the first dot) of a Qt-style
145 # comment as the brief description. If set to NO, the comments
146 # will behave just like regular Qt-style comments (thus requiring
147 # an explicit \brief command for a brief description.)
151 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
152 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
153 # comments) as a brief description. This used to be the default behaviour.
154 # The new default is to treat a multi-line C++ comment block as a detailed
155 # description. Set this tag to YES if you prefer the old behaviour instead.
157 MULTILINE_CPP_IS_BRIEF = NO
159 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
160 # member inherits the documentation from any documented member that it
165 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
166 # a new page for each member. If set to NO, the documentation of a member will
167 # be part of the file/class/namespace that contains it.
169 SEPARATE_MEMBER_PAGES = NO
171 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
172 # Doxygen uses this value to replace tabs by spaces in code fragments.
176 # This tag can be used to specify a number of aliases that acts
177 # as commands in the documentation. An alias has the form "name=value".
178 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
179 # put the command \sideeffect (or @sideeffect) in the documentation, which
180 # will result in a user-defined paragraph with heading "Side Effects:".
181 # You can put \n's in the value part of an alias to insert newlines.
185 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
186 # sources only. Doxygen will then generate output that is more tailored for C.
187 # For instance, some of the names that are used will be different. The list
188 # of all members will be omitted, etc.
190 OPTIMIZE_OUTPUT_FOR_C = NO
192 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
193 # sources only. Doxygen will then generate output that is more tailored for
194 # Java. For instance, namespaces will be presented as packages, qualified
195 # scopes will look different, etc.
197 OPTIMIZE_OUTPUT_JAVA = NO
199 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
200 # sources only. Doxygen will then generate output that is more tailored for
203 OPTIMIZE_FOR_FORTRAN = NO
205 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
206 # sources. Doxygen will then generate output that is tailored for
209 OPTIMIZE_OUTPUT_VHDL = NO
211 # Doxygen selects the parser to use depending on the extension of the files it
212 # parses. With this tag you can assign which parser to use for a given extension.
213 # Doxygen has a built-in mapping, but you can override or extend it using this
214 # tag. The format is ext=language, where ext is a file extension, and language
215 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
216 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
217 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
218 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
219 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
223 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
224 # to include (a tag file for) the STL sources as input, then you should
225 # set this tag to YES in order to let doxygen match functions declarations and
226 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
227 # func(std::string) {}). This also make the inheritance and collaboration
228 # diagrams that involve STL classes more complete and accurate.
230 BUILTIN_STL_SUPPORT = NO
232 # If you use Microsoft's C++/CLI language, you should set this option to YES to
233 # enable parsing support.
237 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
238 # Doxygen will parse them like normal C++ but will assume all classes use public
239 # instead of private inheritance when no explicit protection keyword is present.
243 # For Microsoft's IDL there are propget and propput attributes to indicate getter
244 # and setter methods for a property. Setting this option to YES (the default)
245 # will make doxygen to replace the get and set methods by a property in the
246 # documentation. This will only work if the methods are indeed getting or
247 # setting a simple type. If this is not the case, or you want to show the
248 # methods anyway, you should set this option to NO.
250 IDL_PROPERTY_SUPPORT = YES
252 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
253 # tag is set to YES, then doxygen will reuse the documentation of the first
254 # member in the group (if any) for the other members of the group. By default
255 # all members of a group must be documented explicitly.
257 DISTRIBUTE_GROUP_DOC = NO
259 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
260 # the same type (for instance a group of public functions) to be put as a
261 # subgroup of that type (e.g. under the Public Functions section). Set it to
262 # NO to prevent subgrouping. Alternatively, this can be done per class using
263 # the \nosubgrouping command.
267 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
268 # is documented as struct, union, or enum with the name of the typedef. So
269 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
270 # with name TypeT. When disabled the typedef will appear as a member of a file,
271 # namespace, or class. And the struct will be named TypeS. This can typically
272 # be useful for C code in case the coding convention dictates that all compound
273 # types are typedef'ed and only the typedef is referenced, never the tag name.
275 TYPEDEF_HIDES_STRUCT = NO
277 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
278 # determine which symbols to keep in memory and which to flush to disk.
279 # When the cache is full, less often used symbols will be written to disk.
280 # For small to medium size projects (<1000 input files) the default value is
281 # probably good enough. For larger projects a too small cache size can cause
282 # doxygen to be busy swapping symbols to and from disk most of the time
283 # causing a significant performance penalty.
284 # If the system has enough physical memory increasing the cache will improve the
285 # performance by keeping more symbols in memory. Note that the value works on
286 # a logarithmic scale so increasing the size by one will roughly double the
287 # memory usage. The cache size is given by this formula:
288 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
289 # corresponding to a cache size of 2^16 = 65536 symbols
291 SYMBOL_CACHE_SIZE = 0
293 #---------------------------------------------------------------------------
294 # Build related configuration options
295 #---------------------------------------------------------------------------
297 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298 # documentation are documented, even if no documentation was available.
299 # Private class members and static file members will be hidden unless
300 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
304 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305 # will be included in the documentation.
309 # If the EXTRACT_STATIC tag is set to YES all static members of a file
310 # will be included in the documentation.
314 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
315 # defined locally in source files will be included in the documentation.
316 # If set to NO only classes defined in header files are included.
318 EXTRACT_LOCAL_CLASSES = YES
320 # This flag is only useful for Objective-C code. When set to YES local
321 # methods, which are defined in the implementation section but not in
322 # the interface are included in the documentation.
323 # If set to NO (the default) only methods in the interface are included.
325 EXTRACT_LOCAL_METHODS = NO
327 # If this flag is set to YES, the members of anonymous namespaces will be
328 # extracted and appear in the documentation as a namespace called
329 # 'anonymous_namespace{file}', where file will be replaced with the base
330 # name of the file that contains the anonymous namespace. By default
331 # anonymous namespace are hidden.
333 EXTRACT_ANON_NSPACES = NO
335 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
336 # undocumented members of documented classes, files or namespaces.
337 # If set to NO (the default) these members will be included in the
338 # various overviews, but no documentation section is generated.
339 # This option has no effect if EXTRACT_ALL is enabled.
341 HIDE_UNDOC_MEMBERS = NO
343 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
344 # undocumented classes that are normally visible in the class hierarchy.
345 # If set to NO (the default) these classes will be included in the various
346 # overviews. This option has no effect if EXTRACT_ALL is enabled.
348 HIDE_UNDOC_CLASSES = NO
350 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
351 # friend (class|struct|union) declarations.
352 # If set to NO (the default) these declarations will be included in the
355 HIDE_FRIEND_COMPOUNDS = NO
357 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
358 # documentation blocks found inside the body of a function.
359 # If set to NO (the default) these blocks will be appended to the
360 # function's detailed documentation block.
362 HIDE_IN_BODY_DOCS = NO
364 # The INTERNAL_DOCS tag determines if documentation
365 # that is typed after a \internal command is included. If the tag is set
366 # to NO (the default) then the documentation will be excluded.
367 # Set it to YES to include the internal documentation.
371 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
372 # file names in lower-case letters. If set to YES upper-case letters are also
373 # allowed. This is useful if you have classes or files whose names only differ
374 # in case and if your file system supports case sensitive file names. Windows
375 # and Mac users are advised to set this option to NO.
377 CASE_SENSE_NAMES = YES
379 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
380 # will show members with their full class and namespace scopes in the
381 # documentation. If set to YES the scope will be hidden.
383 HIDE_SCOPE_NAMES = NO
385 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
386 # will put a list of the files that are included by a file in the documentation
389 SHOW_INCLUDE_FILES = YES
391 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
392 # will list include files with double quotes in the documentation
393 # rather than with sharp brackets.
395 FORCE_LOCAL_INCLUDES = NO
397 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
398 # is inserted in the documentation for inline members.
402 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
403 # will sort the (detailed) documentation of file and class members
404 # alphabetically by member name. If set to NO the members will appear in
407 SORT_MEMBER_DOCS = YES
409 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
410 # brief documentation of file, namespace and class members alphabetically
411 # by member name. If set to NO (the default) the members will appear in
416 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
417 # will sort the (brief and detailed) documentation of class members so that
418 # constructors and destructors are listed first. If set to NO (the default)
419 # the constructors will appear in the respective orders defined by
420 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
421 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
422 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
424 SORT_MEMBERS_CTORS_1ST = NO
426 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
427 # hierarchy of group names into alphabetical order. If set to NO (the default)
428 # the group names will appear in their defined order.
430 SORT_GROUP_NAMES = NO
432 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
433 # sorted by fully-qualified names, including namespaces. If set to
434 # NO (the default), the class list will be sorted only by class name,
435 # not including the namespace part.
436 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
437 # Note: This option applies only to the class list, not to the
440 SORT_BY_SCOPE_NAME = NO
442 # The GENERATE_TODOLIST tag can be used to enable (YES) or
443 # disable (NO) the todo list. This list is created by putting \todo
444 # commands in the documentation.
446 GENERATE_TODOLIST = YES
448 # The GENERATE_TESTLIST tag can be used to enable (YES) or
449 # disable (NO) the test list. This list is created by putting \test
450 # commands in the documentation.
452 GENERATE_TESTLIST = YES
454 # The GENERATE_BUGLIST tag can be used to enable (YES) or
455 # disable (NO) the bug list. This list is created by putting \bug
456 # commands in the documentation.
458 GENERATE_BUGLIST = YES
460 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
461 # disable (NO) the deprecated list. This list is created by putting
462 # \deprecated commands in the documentation.
464 GENERATE_DEPRECATEDLIST= YES
466 # The ENABLED_SECTIONS tag can be used to enable conditional
467 # documentation sections, marked by \if sectionname ... \endif.
471 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
472 # the initial value of a variable or define consists of for it to appear in
473 # the documentation. If the initializer consists of more lines than specified
474 # here it will be hidden. Use a value of 0 to hide initializers completely.
475 # The appearance of the initializer of individual variables and defines in the
476 # documentation can be controlled using \showinitializer or \hideinitializer
477 # command in the documentation regardless of this setting.
479 MAX_INITIALIZER_LINES = 30
481 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
482 # at the bottom of the documentation of classes and structs. If set to YES the
483 # list will mention the files that were used to generate the documentation.
485 SHOW_USED_FILES = YES
487 # If the sources in your project are distributed over multiple directories
488 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
489 # in the documentation. The default is NO.
491 SHOW_DIRECTORIES = YES
493 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
494 # This will remove the Files entry from the Quick Index and from the
495 # Folder Tree View (if specified). The default is YES.
499 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
501 # This will remove the Namespaces entry from the Quick Index
502 # and from the Folder Tree View (if specified). The default is YES.
504 SHOW_NAMESPACES = YES
506 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
507 # doxygen should invoke to get the current version for each file (typically from
508 # the version control system). Doxygen will invoke the program by executing (via
509 # popen()) the command <command> <input-file>, where <command> is the value of
510 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
511 # provided by doxygen. Whatever the program writes to standard output
512 # is used as the file version. See the manual for examples.
514 FILE_VERSION_FILTER =
516 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
517 # by doxygen. The layout file controls the global structure of the generated
518 # output files in an output format independent way. The create the layout file
519 # that represents doxygen's defaults, run doxygen with the -l option.
520 # You can optionally specify a file name after the option, if omitted
521 # DoxygenLayout.xml will be used as the name of the layout file.
525 #---------------------------------------------------------------------------
526 # configuration options related to warning and progress messages
527 #---------------------------------------------------------------------------
529 # The QUIET tag can be used to turn on/off the messages that are generated
530 # by doxygen. Possible values are YES and NO. If left blank NO is used.
534 # The WARNINGS tag can be used to turn on/off the warning messages that are
535 # generated by doxygen. Possible values are YES and NO. If left blank
540 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
541 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
542 # automatically be disabled.
544 WARN_IF_UNDOCUMENTED = NO
546 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
547 # potential errors in the documentation, such as not documenting some
548 # parameters in a documented function, or documenting parameters that
549 # don't exist or using markup commands wrongly.
551 WARN_IF_DOC_ERROR = YES
553 # This WARN_NO_PARAMDOC option can be abled to get warnings for
554 # functions that are documented, but have no documentation for their parameters
555 # or return value. If set to NO (the default) doxygen will only warn about
556 # wrong or incomplete parameter documentation, but not about the absence of
559 WARN_NO_PARAMDOC = NO
561 # The WARN_FORMAT tag determines the format of the warning messages that
562 # doxygen can produce. The string should contain the $file, $line, and $text
563 # tags, which will be replaced by the file and line number from which the
564 # warning originated and the warning text. Optionally the format may contain
565 # $version, which will be replaced by the version of the file (if it could
566 # be obtained via FILE_VERSION_FILTER)
570 # The WARN_LOGFILE tag can be used to specify a file to which warning
571 # and error messages should be written. If left blank the output is written
576 #---------------------------------------------------------------------------
577 # configuration options related to the input files
578 #---------------------------------------------------------------------------
580 # The INPUT tag can be used to specify the files and/or directories that contain
581 # documented source files. You may enter file names like "myfile.cpp" or
582 # directories like "/usr/src/myproject". Separate the files or directories
585 INPUT = @abs_top_srcdir@/include \
586 @abs_top_srcdir@/lib \
587 @abs_top_srcdir@/docs/doxygen.intro
589 # This tag can be used to specify the character encoding of the source files
590 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
591 # also the default input encoding. Doxygen uses libiconv (or the iconv built
592 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
593 # the list of possible encodings.
595 INPUT_ENCODING = UTF-8
597 # If the value of the INPUT tag contains directories, you can use the
598 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
599 # and *.h) to filter out the source-files in the directories. If left
600 # blank the following patterns are tested:
601 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
602 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
606 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
607 # should be searched for input files as well. Possible values are YES and NO.
608 # If left blank NO is used.
612 # The EXCLUDE tag can be used to specify files and/or directories that should
613 # excluded from the INPUT source files. This way you can easily exclude a
614 # subdirectory from a directory tree whose root is specified with the INPUT tag.
618 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
619 # directories that are symbolic links (a Unix filesystem feature) are excluded
622 EXCLUDE_SYMLINKS = NO
624 # If the value of the INPUT tag contains directories, you can use the
625 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
626 # certain files from those directories. Note that the wildcards are matched
627 # against the file with absolute path, so to exclude all test directories
628 # for example use the pattern */test/*
632 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
633 # (namespaces, classes, functions, etc.) that should be excluded from the
634 # output. The symbol name can be a fully qualified name, a word, or if the
635 # wildcard * is used, a substring. Examples: ANamespace, AClass,
636 # AClass::ANamespace, ANamespace::*Test
640 # The EXAMPLE_PATH tag can be used to specify one or more files or
641 # directories that contain example code fragments that are included (see
642 # the \include command).
644 EXAMPLE_PATH = @abs_top_srcdir@/examples
646 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
647 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
648 # and *.h) to filter out the source-files in the directories. If left
649 # blank all files are included.
653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
654 # searched for input files to be used with the \include or \dontinclude
655 # commands irrespective of the value of the RECURSIVE tag.
656 # Possible values are YES and NO. If left blank NO is used.
658 EXAMPLE_RECURSIVE = YES
660 # The IMAGE_PATH tag can be used to specify one or more files or
661 # directories that contain image that are included in the documentation (see
662 # the \image command).
664 IMAGE_PATH = @abs_top_srcdir@/docs/img
666 # The INPUT_FILTER tag can be used to specify a program that doxygen should
667 # invoke to filter for each input file. Doxygen will invoke the filter program
668 # by executing (via popen()) the command <filter> <input-file>, where <filter>
669 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
670 # input file. Doxygen will then use the output that the filter program writes
671 # to standard output.
672 # If FILTER_PATTERNS is specified, this tag will be
677 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
679 # Doxygen will compare the file name with each pattern and apply the
680 # filter if there is a match.
681 # The filters are a list of the form:
682 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
683 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
684 # is applied to all files.
688 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
689 # INPUT_FILTER) will be used to filter the input files when producing source
690 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
692 FILTER_SOURCE_FILES = NO
694 #---------------------------------------------------------------------------
695 # configuration options related to source browsing
696 #---------------------------------------------------------------------------
698 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
699 # be generated. Documented entities will be cross-referenced with these sources.
700 # Note: To get rid of all source code in the generated output, make sure also
701 # VERBATIM_HEADERS is set to NO.
705 # Setting the INLINE_SOURCES tag to YES will include the body
706 # of functions and classes directly in the documentation.
710 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
711 # doxygen to hide any special comment blocks from generated source code
712 # fragments. Normal C and C++ comments will always remain visible.
714 STRIP_CODE_COMMENTS = NO
716 # If the REFERENCED_BY_RELATION tag is set to YES
717 # then for each documented function all documented
718 # functions referencing it will be listed.
720 REFERENCED_BY_RELATION = YES
722 # If the REFERENCES_RELATION tag is set to YES
723 # then for each documented function all documented entities
724 # called/used by that function will be listed.
726 REFERENCES_RELATION = YES
728 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
729 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
730 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
731 # link to the source code.
732 # Otherwise they will link to the documentation.
734 REFERENCES_LINK_SOURCE = YES
736 # If the USE_HTAGS tag is set to YES then the references to source code
737 # will point to the HTML generated by the htags(1) tool instead of doxygen
738 # built-in source browser. The htags tool is part of GNU's global source
739 # tagging system (see http://www.gnu.org/software/global/global.html). You
740 # will need version 4.8.6 or higher.
744 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
745 # will generate a verbatim copy of the header file for each class for
746 # which an include is specified. Set to NO to disable this.
748 VERBATIM_HEADERS = YES
750 #---------------------------------------------------------------------------
751 # configuration options related to the alphabetical class index
752 #---------------------------------------------------------------------------
754 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
755 # of all compounds will be generated. Enable this if the project
756 # contains a lot of classes, structs, unions or interfaces.
758 ALPHABETICAL_INDEX = YES
760 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
761 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
762 # in which this list will be split (can be a number in the range [1..20])
764 COLS_IN_ALPHA_INDEX = 4
766 # In case all classes in a project start with a common prefix, all
767 # classes will be put under the same header in the alphabetical index.
768 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
769 # should be ignored while generating the index headers.
771 IGNORE_PREFIX = llvm::
773 #---------------------------------------------------------------------------
774 # configuration options related to the HTML output
775 #---------------------------------------------------------------------------
777 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
778 # generate HTML output.
782 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
783 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
784 # put in front of it. If left blank `html' will be used as the default path.
788 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
789 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
790 # doxygen will generate files with .html extension.
792 HTML_FILE_EXTENSION = .html
794 # The HTML_HEADER tag can be used to specify a personal HTML header for
795 # each generated HTML page. If it is left blank doxygen will generate a
798 HTML_HEADER = @abs_top_srcdir@/docs/doxygen.header
800 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
801 # each generated HTML page. If it is left blank doxygen will generate a
804 HTML_FOOTER = @abs_top_srcdir@/docs/doxygen.footer
806 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
807 # style sheet that is used by each HTML page. It can be used to
808 # fine-tune the look of the HTML output. If the tag is left blank doxygen
809 # will generate a default style sheet. Note that doxygen will try to copy
810 # the style sheet file to the HTML output directory, so don't put your own
811 # stylesheet in the HTML output directory as well, or it will be erased!
813 HTML_STYLESHEET = @abs_top_srcdir@/docs/doxygen.css
815 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
816 # Doxygen will adjust the colors in the stylesheet and background images
817 # according to this color. Hue is specified as an angle on a colorwheel,
818 # see http://en.wikipedia.org/wiki/Hue for more information.
819 # For instance the value 0 represents red, 60 is yellow, 120 is green,
820 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
821 # The allowed range is 0 to 359.
823 HTML_COLORSTYLE_HUE = 220
825 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
826 # the colors in the HTML output. For a value of 0 the output will use
827 # grayscales only. A value of 255 will produce the most vivid colors.
829 HTML_COLORSTYLE_SAT = 100
831 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
832 # the luminance component of the colors in the HTML output. Values below
833 # 100 gradually make the output lighter, whereas values above 100 make
834 # the output darker. The value divided by 100 is the actual gamma applied,
835 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
836 # and 100 does not change the gamma.
838 HTML_COLORSTYLE_GAMMA = 80
840 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
841 # page will contain the date and time when the page was generated. Setting
842 # this to NO can help when comparing the output of multiple runs.
846 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
847 # files or namespaces will be aligned in HTML using tables. If set to
848 # NO a bullet list will be used.
850 HTML_ALIGN_MEMBERS = YES
852 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
853 # documentation will contain sections that can be hidden and shown after the
854 # page has loaded. For this to work a browser that supports
855 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
856 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
858 HTML_DYNAMIC_SECTIONS = NO
860 # If the GENERATE_DOCSET tag is set to YES, additional index files
861 # will be generated that can be used as input for Apple's Xcode 3
862 # integrated development environment, introduced with OSX 10.5 (Leopard).
863 # To create a documentation set, doxygen will generate a Makefile in the
864 # HTML output directory. Running make will produce the docset in that
865 # directory and running "make install" will install the docset in
866 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
868 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
869 # for more information.
873 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
874 # feed. A documentation feed provides an umbrella under which multiple
875 # documentation sets from a single provider (such as a company or product suite)
878 DOCSET_FEEDNAME = "Doxygen generated docs"
880 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
881 # should uniquely identify the documentation set bundle. This should be a
882 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
883 # will append .docset to the name.
885 DOCSET_BUNDLE_ID = org.doxygen.Project
887 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
888 # the documentation publisher. This should be a reverse domain-name style
889 # string, e.g. com.mycompany.MyDocSet.documentation.
891 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
893 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
895 DOCSET_PUBLISHER_NAME = Publisher
897 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
898 # will be generated that can be used as input for tools like the
899 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
900 # of the generated HTML documentation.
902 GENERATE_HTMLHELP = NO
904 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
905 # be used to specify the file name of the resulting .chm file. You
906 # can add a path in front of the file if the result should not be
907 # written to the html output directory.
911 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
912 # be used to specify the location (absolute path including file name) of
913 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
914 # the HTML help compiler on the generated index.hhp.
918 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
919 # controls if a separate .chi index file is generated (YES) or that
920 # it should be included in the master .chm file (NO).
924 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
925 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
930 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
931 # controls whether a binary table of contents is generated (YES) or a
932 # normal table of contents (NO) in the .chm file.
936 # The TOC_EXPAND flag can be set to YES to add extra items for group members
937 # to the contents of the HTML help documentation and to the tree view.
941 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
942 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
943 # that can be used as input for Qt's qhelpgenerator to generate a
944 # Qt Compressed Help (.qch) of the generated HTML documentation.
948 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
949 # be used to specify the file name of the resulting .qch file.
950 # The path specified is relative to the HTML output folder.
954 # The QHP_NAMESPACE tag specifies the namespace to use when generating
955 # Qt Help Project output. For more information please see
956 # http://doc.trolltech.com/qthelpproject.html#namespace
958 QHP_NAMESPACE = org.doxygen.Project
960 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
961 # Qt Help Project output. For more information please see
962 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
964 QHP_VIRTUAL_FOLDER = doc
966 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
967 # add. For more information please see
968 # http://doc.trolltech.com/qthelpproject.html#custom-filters
970 QHP_CUST_FILTER_NAME =
972 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
973 # custom filter to add. For more information please see
974 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
975 # Qt Help Project / Custom Filters</a>.
977 QHP_CUST_FILTER_ATTRS =
979 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
981 # filter section matches.
982 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
983 # Qt Help Project / Filter Attributes</a>.
985 QHP_SECT_FILTER_ATTRS =
987 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
988 # be used to specify the location of Qt's qhelpgenerator.
989 # If non-empty doxygen will try to run qhelpgenerator on the generated
994 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
995 # will be generated, which together with the HTML files, form an Eclipse help
996 # plugin. To install this plugin and make it available under the help contents
997 # menu in Eclipse, the contents of the directory containing the HTML and XML
998 # files needs to be copied into the plugins directory of eclipse. The name of
999 # the directory within the plugins directory should be the same as
1000 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1003 GENERATE_ECLIPSEHELP = NO
1005 # A unique identifier for the eclipse help plugin. When installing the plugin
1006 # the directory name containing the HTML and XML files should also have
1009 ECLIPSE_DOC_ID = org.doxygen.Project
1011 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1012 # top of each HTML page. The value NO (the default) enables the index and
1013 # the value YES disables it.
1017 # This tag can be used to set the number of enum values (range [1..20])
1018 # that doxygen will group on one line in the generated HTML documentation.
1020 ENUM_VALUES_PER_LINE = 4
1022 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1023 # structure should be generated to display hierarchical information.
1024 # If the tag value is set to YES, a side panel will be generated
1025 # containing a tree-like index structure (just like the one that
1026 # is generated for HTML Help). For this to work a browser that supports
1027 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1028 # Windows users are probably better off using the HTML help feature.
1030 GENERATE_TREEVIEW = NO
1032 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1033 # and Class Hierarchy pages using a tree view instead of an ordered list.
1035 USE_INLINE_TREES = NO
1037 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1038 # used to set the initial width (in pixels) of the frame in which the tree
1041 TREEVIEW_WIDTH = 250
1043 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1044 # links to external symbols imported via tag files in a separate window.
1046 EXT_LINKS_IN_WINDOW = NO
1048 # Use this tag to change the font size of Latex formulas included
1049 # as images in the HTML documentation. The default is 10. Note that
1050 # when you change the font size after a successful doxygen run you need
1051 # to manually remove any form_*.png images from the HTML output directory
1052 # to force them to be regenerated.
1054 FORMULA_FONTSIZE = 10
1056 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1057 # generated for formulas are transparent PNGs. Transparent PNGs are
1058 # not supported properly for IE 6.0, but are supported on all modern browsers.
1059 # Note that when changing this option you need to delete any form_*.png files
1060 # in the HTML output before the changes have effect.
1062 FORMULA_TRANSPARENT = YES
1064 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1065 # for the HTML output. The underlying search engine uses javascript
1066 # and DHTML and should work on any modern browser. Note that when using
1067 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1068 # (GENERATE_DOCSET) there is already a search function so this one should
1069 # typically be disabled. For large projects the javascript based search engine
1070 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1072 SEARCHENGINE = @enable_searchengine@
1074 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1075 # implemented using a PHP enabled web server instead of at the web client
1076 # using Javascript. Doxygen will generate the search PHP script and index
1077 # file to put on the web server. The advantage of the server
1078 # based approach is that it scales better to large projects and allows
1079 # full text search. The disadvances is that it is more difficult to setup
1080 # and does not have live searching capabilities.
1082 SERVER_BASED_SEARCH = @enable_server_based_search@
1084 SEARCHENGINE_URL = @searchengine_url@
1086 EXTERNAL_SEARCH = @enable_external_search@
1088 EXTERNAL_SEARCH_ID = llvm
1090 EXTRA_SEARCH_MAPPINGS = @extra_search_mappings@
1092 #---------------------------------------------------------------------------
1093 # configuration options related to the LaTeX output
1094 #---------------------------------------------------------------------------
1096 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1097 # generate Latex output.
1101 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1102 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1103 # put in front of it. If left blank `latex' will be used as the default path.
1107 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1108 # invoked. If left blank `latex' will be used as the default command name.
1109 # Note that when enabling USE_PDFLATEX this option is only used for
1110 # generating bitmaps for formulas in the HTML output, but not in the
1111 # Makefile that is written to the output directory.
1113 LATEX_CMD_NAME = latex
1115 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1116 # generate index for LaTeX. If left blank `makeindex' will be used as the
1117 # default command name.
1119 MAKEINDEX_CMD_NAME = makeindex
1121 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1122 # LaTeX documents. This may be useful for small projects and may help to
1123 # save some trees in general.
1127 # The PAPER_TYPE tag can be used to set the paper type that is used
1128 # by the printer. Possible values are: a4, a4wide, letter, legal and
1129 # executive. If left blank a4wide will be used.
1133 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1134 # packages that should be included in the LaTeX output.
1138 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1139 # the generated latex document. The header should contain everything until
1140 # the first chapter. If it is left blank doxygen will generate a
1141 # standard header. Notice: only use this tag if you know what you are doing!
1145 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1146 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1147 # contain links (just like the HTML output) instead of page references
1148 # This makes the output suitable for online browsing using a pdf viewer.
1152 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1153 # plain latex in the generated Makefile. Set this option to YES to get a
1154 # higher quality PDF documentation.
1158 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1159 # command to the generated LaTeX files. This will instruct LaTeX to keep
1160 # running if errors occur, instead of asking the user for help.
1161 # This option is also used when generating formulas in HTML.
1163 LATEX_BATCHMODE = NO
1165 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1166 # include the index chapters (such as File Index, Compound Index, etc.)
1169 LATEX_HIDE_INDICES = NO
1171 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1172 # source code with syntax highlighting in the LaTeX output.
1173 # Note that which sources are shown also depends on other settings
1174 # such as SOURCE_BROWSER.
1176 LATEX_SOURCE_CODE = NO
1178 #---------------------------------------------------------------------------
1179 # configuration options related to the RTF output
1180 #---------------------------------------------------------------------------
1182 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1183 # The RTF output is optimized for Word 97 and may not look very pretty with
1184 # other RTF readers or editors.
1188 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1189 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1190 # put in front of it. If left blank `rtf' will be used as the default path.
1194 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1195 # RTF documents. This may be useful for small projects and may help to
1196 # save some trees in general.
1200 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1201 # will contain hyperlink fields. The RTF file will
1202 # contain links (just like the HTML output) instead of page references.
1203 # This makes the output suitable for online browsing using WORD or other
1204 # programs which support those fields.
1205 # Note: wordpad (write) and others do not support links.
1209 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1210 # config file, i.e. a series of assignments. You only have to provide
1211 # replacements, missing definitions are set to their default value.
1213 RTF_STYLESHEET_FILE =
1215 # Set optional variables used in the generation of an rtf document.
1216 # Syntax is similar to doxygen's config file.
1218 RTF_EXTENSIONS_FILE =
1220 #---------------------------------------------------------------------------
1221 # configuration options related to the man page output
1222 #---------------------------------------------------------------------------
1224 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1225 # generate man pages
1229 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1230 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1231 # put in front of it. If left blank `man' will be used as the default path.
1235 # The MAN_EXTENSION tag determines the extension that is added to
1236 # the generated man pages (default is the subroutine's section .3)
1240 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1241 # then it will generate one additional man file for each entity
1242 # documented in the real man page(s). These additional files
1243 # only source the real man page, but without them the man command
1244 # would be unable to find the correct page. The default is NO.
1248 #---------------------------------------------------------------------------
1249 # configuration options related to the XML output
1250 #---------------------------------------------------------------------------
1252 # If the GENERATE_XML tag is set to YES Doxygen will
1253 # generate an XML file that captures the structure of
1254 # the code including all documentation.
1258 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1259 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1260 # put in front of it. If left blank `xml' will be used as the default path.
1264 # The XML_SCHEMA tag can be used to specify an XML schema,
1265 # which can be used by a validating XML parser to check the
1266 # syntax of the XML files.
1270 # The XML_DTD tag can be used to specify an XML DTD,
1271 # which can be used by a validating XML parser to check the
1272 # syntax of the XML files.
1276 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1277 # dump the program listings (including syntax highlighting
1278 # and cross-referencing information) to the XML output. Note that
1279 # enabling this will significantly increase the size of the XML output.
1281 XML_PROGRAMLISTING = YES
1283 #---------------------------------------------------------------------------
1284 # configuration options for the AutoGen Definitions output
1285 #---------------------------------------------------------------------------
1287 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1288 # generate an AutoGen Definitions (see autogen.sf.net) file
1289 # that captures the structure of the code including all
1290 # documentation. Note that this feature is still experimental
1291 # and incomplete at the moment.
1293 GENERATE_AUTOGEN_DEF = NO
1295 #---------------------------------------------------------------------------
1296 # configuration options related to the Perl module output
1297 #---------------------------------------------------------------------------
1299 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1300 # generate a Perl module file that captures the structure of
1301 # the code including all documentation. Note that this
1302 # feature is still experimental and incomplete at the
1305 GENERATE_PERLMOD = NO
1307 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1308 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1309 # to generate PDF and DVI output from the Perl module output.
1313 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1314 # nicely formatted so it can be parsed by a human reader.
1316 # if you want to understand what is going on.
1317 # On the other hand, if this
1318 # tag is set to NO the size of the Perl module output will be much smaller
1319 # and Perl will parse it just the same.
1321 PERLMOD_PRETTY = YES
1323 # The names of the make variables in the generated doxyrules.make file
1324 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1325 # This is useful so different doxyrules.make files included by the same
1326 # Makefile don't overwrite each other's variables.
1328 PERLMOD_MAKEVAR_PREFIX =
1330 #---------------------------------------------------------------------------
1331 # Configuration options related to the preprocessor
1332 #---------------------------------------------------------------------------
1334 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1335 # evaluate all C-preprocessor directives found in the sources and include
1338 ENABLE_PREPROCESSING = YES
1340 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1341 # names in the source code. If set to NO (the default) only conditional
1342 # compilation will be performed. Macro expansion can be done in a controlled
1343 # way by setting EXPAND_ONLY_PREDEF to YES.
1345 MACRO_EXPANSION = NO
1347 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1348 # then the macro expansion is limited to the macros specified with the
1349 # PREDEFINED and EXPAND_AS_DEFINED tags.
1351 EXPAND_ONLY_PREDEF = NO
1353 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1354 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1356 SEARCH_INCLUDES = YES
1358 # The INCLUDE_PATH tag can be used to specify one or more directories that
1359 # contain include files that are not input files but should be processed by
1362 INCLUDE_PATH = ../include
1364 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1365 # patterns (like *.h and *.hpp) to filter out the header-files in the
1366 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1369 INCLUDE_FILE_PATTERNS =
1371 # The PREDEFINED tag can be used to specify one or more macro names that
1372 # are defined before the preprocessor is started (similar to the -D option of
1373 # gcc). The argument of the tag is a list of macros of the form: name
1374 # or name=definition (no spaces). If the definition and the = are
1375 # omitted =1 is assumed. To prevent a macro definition from being
1376 # undefined via #undef or recursively expanded use the := operator
1377 # instead of the = operator.
1381 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1382 # this tag can be used to specify a list of macro names that should be expanded.
1383 # The macro definition that is found in the sources will be used.
1384 # Use the PREDEFINED tag if you want to use a different macro definition.
1388 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1389 # doxygen's preprocessor will remove all function-like macros that are alone
1390 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1391 # function macros are typically used for boiler-plate code, and will confuse
1392 # the parser if not removed.
1394 SKIP_FUNCTION_MACROS = YES
1396 #---------------------------------------------------------------------------
1397 # Configuration::additions related to external references
1398 #---------------------------------------------------------------------------
1400 # The TAGFILES option can be used to specify one or more tagfiles.
1401 # Optionally an initial location of the external documentation
1402 # can be added for each tagfile. The format of a tag file without
1403 # this location is as follows:
1405 # TAGFILES = file1 file2 ...
1406 # Adding location for the tag files is done as follows:
1408 # TAGFILES = file1=loc1 "file2 = loc2" ...
1409 # where "loc1" and "loc2" can be relative or absolute paths or
1410 # URLs. If a location is present for each tag, the installdox tool
1411 # does not have to be run to correct the links.
1412 # Note that each tag file must have a unique name
1413 # (where the name does NOT include the path)
1414 # If a tag file is not located in the directory in which doxygen
1415 # is run, you must also specify the path to the tagfile here.
1419 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1420 # a tag file that is based on the input files it reads.
1424 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1425 # in the class index. If set to NO only the inherited external classes
1430 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1431 # in the modules index. If set to NO, only the current project's groups will
1434 EXTERNAL_GROUPS = YES
1436 # The PERL_PATH should be the absolute path and name of the perl script
1437 # interpreter (i.e. the result of `which perl').
1441 #---------------------------------------------------------------------------
1442 # Configuration options related to the dot tool
1443 #---------------------------------------------------------------------------
1445 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1446 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1447 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1448 # this option is superseded by the HAVE_DOT option below. This is only a
1449 # fallback. It is recommended to install and use dot, since it yields more
1452 CLASS_DIAGRAMS = YES
1454 # You can define message sequence charts within doxygen comments using the \msc
1455 # command. Doxygen will then run the mscgen tool (see
1456 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1457 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1458 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1459 # default search path.
1463 # If set to YES, the inheritance and collaboration graphs will hide
1464 # inheritance and usage relations if the target is undocumented
1465 # or is not a class.
1467 HIDE_UNDOC_RELATIONS = NO
1469 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1470 # available from the path. This tool is part of Graphviz, a graph visualization
1471 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1472 # have no effect if this option is set to NO (the default)
1476 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1477 # allowed to run in parallel. When set to 0 (the default) doxygen will
1478 # base this on the number of processors available in the system. You can set it
1479 # explicitly to a value larger than 0 to get control over the balance
1480 # between CPU load and processing speed.
1484 # By default doxygen will write a font called FreeSans.ttf to the output
1485 # directory and reference it in all dot files that doxygen generates. This
1486 # font does not include all possible unicode characters however, so when you need
1487 # these (or just want a differently looking font) you can specify the font name
1488 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1489 # which can be done by putting it in a standard location or by setting the
1490 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1491 # containing the font.
1493 DOT_FONTNAME = FreeSans
1495 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1496 # The default size is 10pt.
1500 # By default doxygen will tell dot to use the output directory to look for the
1501 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1502 # different font using DOT_FONTNAME you can set the path where dot
1503 # can find it using this tag.
1507 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1508 # will generate a graph for each documented class showing the direct and
1509 # indirect inheritance relations. Setting this tag to YES will force the
1510 # the CLASS_DIAGRAMS tag to NO.
1514 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1515 # will generate a graph for each documented class showing the direct and
1516 # indirect implementation dependencies (inheritance, containment, and
1517 # class references variables) of the class with other documented classes.
1519 COLLABORATION_GRAPH = YES
1521 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1522 # will generate a graph for groups, showing the direct groups dependencies
1526 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1527 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1532 # If set to YES, the inheritance and collaboration graphs will show the
1533 # relations between templates and their instances.
1535 TEMPLATE_RELATIONS = YES
1537 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1538 # tags are set to YES then doxygen will generate a graph for each documented
1539 # file showing the direct and indirect include dependencies of the file with
1540 # other documented files.
1544 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1545 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1546 # documented header file showing the documented files that directly or
1547 # indirectly include this file.
1549 INCLUDED_BY_GRAPH = YES
1551 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1552 # doxygen will generate a call dependency graph for every global function
1553 # or class method. Note that enabling this option will significantly increase
1554 # the time of a run. So in most cases it will be better to enable call graphs
1555 # for selected functions only using the \callgraph command.
1559 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1560 # doxygen will generate a caller dependency graph for every global function
1561 # or class method. Note that enabling this option will significantly increase
1562 # the time of a run. So in most cases it will be better to enable caller
1563 # graphs for selected functions only using the \callergraph command.
1567 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1568 # will graphical hierarchy of all classes instead of a textual one.
1570 GRAPHICAL_HIERARCHY = YES
1572 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1573 # then doxygen will show the dependencies a directory has on other directories
1574 # in a graphical way. The dependency relations are determined by the #include
1575 # relations between the files in the directories.
1577 DIRECTORY_GRAPH = YES
1579 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1580 # generated by dot. Possible values are png, jpg, or gif
1581 # If left blank png will be used.
1583 DOT_IMAGE_FORMAT = png
1585 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1586 # found. If left blank, it is assumed the dot tool can be found in the path.
1590 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1591 # contain dot files that are included in the documentation (see the
1592 # \dotfile command).
1596 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1597 # nodes that will be shown in the graph. If the number of nodes in a graph
1598 # becomes larger than this value, doxygen will truncate the graph, which is
1599 # visualized by representing a node as a red box. Note that doxygen if the
1600 # number of direct children of the root node in a graph is already larger than
1601 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1602 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1604 DOT_GRAPH_MAX_NODES = 50
1606 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1607 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1608 # from the root by following a path via at most 3 edges will be shown. Nodes
1609 # that lay further from the root node will be omitted. Note that setting this
1610 # option to 1 or 2 may greatly reduce the computation time needed for large
1611 # code bases. Also note that the size of a graph can be further restricted by
1612 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1614 MAX_DOT_GRAPH_DEPTH = 0
1616 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1617 # background. This is disabled by default, because dot on Windows does not
1618 # seem to support this out of the box. Warning: Depending on the platform used,
1619 # enabling this option may lead to badly anti-aliased labels on the edges of
1620 # a graph (i.e. they become hard to read).
1622 DOT_TRANSPARENT = YES
1624 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1625 # files in one run (i.e. multiple -o and -T options on the command line). This
1626 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1627 # support this, this feature is disabled by default.
1629 DOT_MULTI_TARGETS = NO
1631 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1632 # generate a legend page explaining the meaning of the various boxes and
1633 # arrows in the dot generated graphs.
1635 GENERATE_LEGEND = YES
1637 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1638 # remove the intermediate dot files that are used to generate
1639 # the various graphs.