cmake_infile.doxygen

Sun, 14 Feb 2021 11:30:19 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 14 Feb 2021 11:30:19 +0100
changeset 409
5d167af0eadb
parent 390
d345541018fa
child 462
1bcf7c8d4b47
permissions
-rw-r--r--

adds cxLinkedListDestroy prototype

     1 # Doxyfile 1.8.7
     3 # This file describes the settings to be used by the documentation system
     4 # doxygen (www.doxygen.org) for a project.
     5 #
     6 # All text after a double hash (##) is considered a comment and is placed in
     7 # front of the TAG it is preceding.
     8 #
     9 # All text after a single hash (#) is considered a comment and will be ignored.
    10 # The format is:
    11 # TAG = value [value, ...]
    12 # For lists, items can also be appended using:
    13 # TAG += value [value, ...]
    14 # Values that contain spaces should be placed between quotes (\" \").
    16 #---------------------------------------------------------------------------
    17 # Project related configuration options
    18 #---------------------------------------------------------------------------
    20 # This tag specifies the encoding used for all characters in the config file
    21 # that follow. The default is UTF-8 which is also the encoding used for all text
    22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
    23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
    24 # for the list of possible encodings.
    25 # The default value is: UTF-8.
    27 DOXYFILE_ENCODING      = UTF-8
    29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
    30 # double-quotes, unless you are using Doxywizard) that should identify the
    31 # project for which the documentation is generated. This name is used in the
    32 # title of most generated pages and in a few other places.
    33 # The default value is: My Project.
    35 PROJECT_NAME           = "ucx"
    37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
    38 # could be handy for archiving the generated documentation or if some version
    39 # control system is used.
    41 PROJECT_NUMBER         =
    43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
    44 # for a project that appears at the top of each page and should give viewer a
    45 # quick idea about the purpose of the project. Keep the description short.
    47 PROJECT_BRIEF          = "UAP Common Extensions"
    49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
    50 # the documentation. The maximum height of the logo should not exceed 55 pixels
    51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
    52 # to the output directory.
    54 PROJECT_LOGO           = @DOXY_PROJECT_LOGO@
    56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
    57 # into which the generated documentation will be written. If a relative path is
    58 # entered, it will be relative to the location where doxygen was started. If
    59 # left blank the current directory will be used.
    61 OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIRECTORY@
    63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
    64 # directories (in 2 levels) under the output directory of each output format and
    65 # will distribute the generated files over these directories. Enabling this
    66 # option can be useful when feeding doxygen a huge amount of source files, where
    67 # putting all generated files in the same directory would otherwise causes
    68 # performance problems for the file system.
    69 # The default value is: NO.
    71 CREATE_SUBDIRS         = NO
    73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
    74 # characters to appear in the names of generated files. If set to NO, non-ASCII
    75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
    76 # U+3044.
    77 # The default value is: NO.
    79 ALLOW_UNICODE_NAMES    = NO
    81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    82 # documentation generated by doxygen is written. Doxygen will use this
    83 # information to generate all constant output in the proper language.
    84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
    85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
    86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
    87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
    88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
    89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
    90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
    91 # Ukrainian and Vietnamese.
    92 # The default value is: English.
    94 OUTPUT_LANGUAGE        = English
    96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
    97 # descriptions after the members that are listed in the file and class
    98 # documentation (similar to Javadoc). Set to NO to disable this.
    99 # The default value is: YES.
   101 BRIEF_MEMBER_DESC      = YES
   103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
   104 # description of a member or function before the detailed description
   105 #
   106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
   107 # brief descriptions will be completely suppressed.
   108 # The default value is: YES.
   110 REPEAT_BRIEF           = YES
   112 # This tag implements a quasi-intelligent brief description abbreviator that is
   113 # used to form the text in various listings. Each string in this list, if found
   114 # as the leading text of the brief description, will be stripped from the text
   115 # and the result, after processing the whole list, is used as the annotated
   116 # text. Otherwise, the brief description is used as-is. If left blank, the
   117 # following values are used ($name is automatically replaced with the name of
   118 # the entity):The $name class, The $name widget, The $name file, is, provides,
   119 # specifies, contains, represents, a, an and the.
   121 ABBREVIATE_BRIEF       =
   123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
   124 # doxygen will generate a detailed section even if there is only a brief
   125 # description.
   126 # The default value is: NO.
   128 ALWAYS_DETAILED_SEC    = NO
   130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
   131 # inherited members of a class in the documentation of that class as if those
   132 # members were ordinary class members. Constructors, destructors and assignment
   133 # operators of the base classes will not be shown.
   134 # The default value is: NO.
   136 INLINE_INHERITED_MEMB  = NO
   138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
   139 # before files name in the file list and in the header files. If set to NO the
   140 # shortest path that makes the file name unique will be used
   141 # The default value is: YES.
   143 FULL_PATH_NAMES        = YES
   145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
   146 # Stripping is only done if one of the specified strings matches the left-hand
   147 # part of the path. The tag can be used to show relative paths in the file list.
   148 # If left blank the directory from which doxygen is run is used as the path to
   149 # strip.
   150 #
   151 # Note that you can specify absolute paths here, but also relative paths, which
   152 # will be relative from the directory where doxygen is started.
   153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
   155 STRIP_FROM_PATH        =
   157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
   158 # path mentioned in the documentation of a class, which tells the reader which
   159 # header file to include in order to use a class. If left blank only the name of
   160 # the header file containing the class definition is used. Otherwise one should
   161 # specify the list of include paths that are normally passed to the compiler
   162 # using the -I flag.
   164 STRIP_FROM_INC_PATH    =
   166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
   167 # less readable) file names. This can be useful is your file systems doesn't
   168 # support long names like on DOS, Mac, or CD-ROM.
   169 # The default value is: NO.
   171 SHORT_NAMES            = NO
   173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
   174 # first line (until the first dot) of a Javadoc-style comment as the brief
   175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
   176 # style comments (thus requiring an explicit @brief command for a brief
   177 # description.)
   178 # The default value is: NO.
   180 JAVADOC_AUTOBRIEF      = YES
   182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
   183 # line (until the first dot) of a Qt-style comment as the brief description. If
   184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
   185 # requiring an explicit \brief command for a brief description.)
   186 # The default value is: NO.
   188 QT_AUTOBRIEF           = NO
   190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
   191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
   192 # a brief description. This used to be the default behavior. The new default is
   193 # to treat a multi-line C++ comment block as a detailed description. Set this
   194 # tag to YES if you prefer the old behavior instead.
   195 #
   196 # Note that setting this tag to YES also means that rational rose comments are
   197 # not recognized any more.
   198 # The default value is: NO.
   200 MULTILINE_CPP_IS_BRIEF = NO
   202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
   203 # documentation from any documented member that it re-implements.
   204 # The default value is: YES.
   206 INHERIT_DOCS           = YES
   208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
   209 # new page for each member. If set to NO, the documentation of a member will be
   210 # part of the file/class/namespace that contains it.
   211 # The default value is: NO.
   213 SEPARATE_MEMBER_PAGES  = NO
   215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
   216 # uses this value to replace tabs by spaces in code fragments.
   217 # Minimum value: 1, maximum value: 16, default value: 4.
   219 TAB_SIZE               = 4
   221 # This tag can be used to specify a number of aliases that act as commands in
   222 # the documentation. An alias has the form:
   223 # name=value
   224 # For example adding
   225 # "sideeffect=@par Side Effects:\n"
   226 # will allow you to put the command \sideeffect (or @sideeffect) in the
   227 # documentation, which will result in a user-defined paragraph with heading
   228 # "Side Effects:". You can put \n's in the value part of an alias to insert
   229 # newlines.
   231 ALIASES                =
   233 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
   234 # only. Doxygen will then generate output that is more tailored for C. For
   235 # instance, some of the names that are used will be different. The list of all
   236 # members will be omitted, etc.
   237 # The default value is: NO.
   239 OPTIMIZE_OUTPUT_FOR_C  = YES
   241 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
   242 # Python sources only. Doxygen will then generate output that is more tailored
   243 # for that language. For instance, namespaces will be presented as packages,
   244 # qualified scopes will look different, etc.
   245 # The default value is: NO.
   247 OPTIMIZE_OUTPUT_JAVA   = NO
   249 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
   250 # sources. Doxygen will then generate output that is tailored for Fortran.
   251 # The default value is: NO.
   253 OPTIMIZE_FOR_FORTRAN   = NO
   255 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
   256 # sources. Doxygen will then generate output that is tailored for VHDL.
   257 # The default value is: NO.
   259 OPTIMIZE_OUTPUT_VHDL   = NO
   261 # Doxygen selects the parser to use depending on the extension of the files it
   262 # parses. With this tag you can assign which parser to use for a given
   263 # extension. Doxygen has a built-in mapping, but you can override or extend it
   264 # using this tag. The format is ext=language, where ext is a file extension, and
   265 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
   266 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
   267 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
   268 # Fortran. In the later case the parser tries to guess whether the code is fixed
   269 # or free formatted code, this is the default for Fortran type files), VHDL. For
   270 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
   271 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
   272 #
   273 # Note For files without extension you can use no_extension as a placeholder.
   274 #
   275 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
   276 # the files are not read by doxygen.
   278 EXTENSION_MAPPING      =
   280 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
   281 # according to the Markdown format, which allows for more readable
   282 # documentation. See http://daringfireball.net/projects/markdown/ for details.
   283 # The output of markdown processing is further processed by doxygen, so you can
   284 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
   285 # case of backward compatibilities issues.
   286 # The default value is: YES.
   288 MARKDOWN_SUPPORT       = YES
   290 # When enabled doxygen tries to link words that correspond to documented
   291 # classes, or namespaces to their corresponding documentation. Such a link can
   292 # be prevented in individual cases by by putting a % sign in front of the word
   293 # or globally by setting AUTOLINK_SUPPORT to NO.
   294 # The default value is: YES.
   296 AUTOLINK_SUPPORT       = YES
   298 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
   299 # to include (a tag file for) the STL sources as input, then you should set this
   300 # tag to YES in order to let doxygen match functions declarations and
   301 # definitions whose arguments contain STL classes (e.g. func(std::string);
   302 # versus func(std::string) {}). This also make the inheritance and collaboration
   303 # diagrams that involve STL classes more complete and accurate.
   304 # The default value is: NO.
   306 BUILTIN_STL_SUPPORT    = NO
   308 # If you use Microsoft's C++/CLI language, you should set this option to YES to
   309 # enable parsing support.
   310 # The default value is: NO.
   312 CPP_CLI_SUPPORT        = NO
   314 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
   315 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
   316 # will parse them like normal C++ but will assume all classes use public instead
   317 # of private inheritance when no explicit protection keyword is present.
   318 # The default value is: NO.
   320 SIP_SUPPORT            = NO
   322 # For Microsoft's IDL there are propget and propput attributes to indicate
   323 # getter and setter methods for a property. Setting this option to YES will make
   324 # doxygen to replace the get and set methods by a property in the documentation.
   325 # This will only work if the methods are indeed getting or setting a simple
   326 # type. If this is not the case, or you want to show the methods anyway, you
   327 # should set this option to NO.
   328 # The default value is: YES.
   330 IDL_PROPERTY_SUPPORT   = YES
   332 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   333 # tag is set to YES, then doxygen will reuse the documentation of the first
   334 # member in the group (if any) for the other members of the group. By default
   335 # all members of a group must be documented explicitly.
   336 # The default value is: NO.
   338 DISTRIBUTE_GROUP_DOC   = NO
   340 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
   341 # (for instance a group of public functions) to be put as a subgroup of that
   342 # type (e.g. under the Public Functions section). Set it to NO to prevent
   343 # subgrouping. Alternatively, this can be done per class using the
   344 # \nosubgrouping command.
   345 # The default value is: YES.
   347 SUBGROUPING            = YES
   349 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
   350 # are shown inside the group in which they are included (e.g. using \ingroup)
   351 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
   352 # and RTF).
   353 #
   354 # Note that this feature does not work in combination with
   355 # SEPARATE_MEMBER_PAGES.
   356 # The default value is: NO.
   358 INLINE_GROUPED_CLASSES = NO
   360 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
   361 # with only public data fields or simple typedef fields will be shown inline in
   362 # the documentation of the scope in which they are defined (i.e. file,
   363 # namespace, or group documentation), provided this scope is documented. If set
   364 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
   365 # Man pages) or section (for LaTeX and RTF).
   366 # The default value is: NO.
   368 INLINE_SIMPLE_STRUCTS  = NO
   370 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
   371 # enum is documented as struct, union, or enum with the name of the typedef. So
   372 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
   373 # with name TypeT. When disabled the typedef will appear as a member of a file,
   374 # namespace, or class. And the struct will be named TypeS. This can typically be
   375 # useful for C code in case the coding convention dictates that all compound
   376 # types are typedef'ed and only the typedef is referenced, never the tag name.
   377 # The default value is: NO.
   379 TYPEDEF_HIDES_STRUCT   = NO
   381 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
   382 # cache is used to resolve symbols given their name and scope. Since this can be
   383 # an expensive process and often the same symbol appears multiple times in the
   384 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
   385 # doxygen will become slower. If the cache is too large, memory is wasted. The
   386 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
   387 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
   388 # symbols. At the end of a run doxygen will report the cache usage and suggest
   389 # the optimal cache size from a speed point of view.
   390 # Minimum value: 0, maximum value: 9, default value: 0.
   392 LOOKUP_CACHE_SIZE      = 0
   394 #---------------------------------------------------------------------------
   395 # Build related configuration options
   396 #---------------------------------------------------------------------------
   398 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   399 # documentation are documented, even if no documentation was available. Private
   400 # class members and static file members will be hidden unless the
   401 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
   402 # Note: This will also disable the warnings about undocumented members that are
   403 # normally produced when WARNINGS is set to YES.
   404 # The default value is: NO.
   406 EXTRACT_ALL            = NO
   408 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
   409 # be included in the documentation.
   410 # The default value is: NO.
   412 EXTRACT_PRIVATE        = NO
   414 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
   415 # scope will be included in the documentation.
   416 # The default value is: NO.
   418 EXTRACT_PACKAGE        = NO
   420 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
   421 # included in the documentation.
   422 # The default value is: NO.
   424 EXTRACT_STATIC         = NO
   426 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
   427 # locally in source files will be included in the documentation. If set to NO
   428 # only classes defined in header files are included. Does not have any effect
   429 # for Java sources.
   430 # The default value is: YES.
   432 EXTRACT_LOCAL_CLASSES  = YES
   434 # This flag is only useful for Objective-C code. When set to YES local methods,
   435 # which are defined in the implementation section but not in the interface are
   436 # included in the documentation. If set to NO only methods in the interface are
   437 # included.
   438 # The default value is: NO.
   440 EXTRACT_LOCAL_METHODS  = NO
   442 # If this flag is set to YES, the members of anonymous namespaces will be
   443 # extracted and appear in the documentation as a namespace called
   444 # 'anonymous_namespace{file}', where file will be replaced with the base name of
   445 # the file that contains the anonymous namespace. By default anonymous namespace
   446 # are hidden.
   447 # The default value is: NO.
   449 EXTRACT_ANON_NSPACES   = NO
   451 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
   452 # undocumented members inside documented classes or files. If set to NO these
   453 # members will be included in the various overviews, but no documentation
   454 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
   455 # The default value is: NO.
   457 HIDE_UNDOC_MEMBERS     = NO
   459 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
   460 # undocumented classes that are normally visible in the class hierarchy. If set
   461 # to NO these classes will be included in the various overviews. This option has
   462 # no effect if EXTRACT_ALL is enabled.
   463 # The default value is: NO.
   465 HIDE_UNDOC_CLASSES     = NO
   467 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
   468 # (class|struct|union) declarations. If set to NO these declarations will be
   469 # included in the documentation.
   470 # The default value is: NO.
   472 HIDE_FRIEND_COMPOUNDS  = NO
   474 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
   475 # documentation blocks found inside the body of a function. If set to NO these
   476 # blocks will be appended to the function's detailed documentation block.
   477 # The default value is: NO.
   479 HIDE_IN_BODY_DOCS      = NO
   481 # The INTERNAL_DOCS tag determines if documentation that is typed after a
   482 # \internal command is included. If the tag is set to NO then the documentation
   483 # will be excluded. Set it to YES to include the internal documentation.
   484 # The default value is: NO.
   486 INTERNAL_DOCS          = NO
   488 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
   489 # names in lower-case letters. If set to YES upper-case letters are also
   490 # allowed. This is useful if you have classes or files whose names only differ
   491 # in case and if your file system supports case sensitive file names. Windows
   492 # and Mac users are advised to set this option to NO.
   493 # The default value is: system dependent.
   495 CASE_SENSE_NAMES       = YES
   497 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
   498 # their full class and namespace scopes in the documentation. If set to YES the
   499 # scope will be hidden.
   500 # The default value is: NO.
   502 HIDE_SCOPE_NAMES       = NO
   504 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
   505 # the files that are included by a file in the documentation of that file.
   506 # The default value is: YES.
   508 SHOW_INCLUDE_FILES     = YES
   510 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
   511 # grouped member an include statement to the documentation, telling the reader
   512 # which file to include in order to use the member.
   513 # The default value is: NO.
   515 SHOW_GROUPED_MEMB_INC  = NO
   517 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
   518 # files with double quotes in the documentation rather than with sharp brackets.
   519 # The default value is: NO.
   521 FORCE_LOCAL_INCLUDES   = NO
   523 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
   524 # documentation for inline members.
   525 # The default value is: YES.
   527 INLINE_INFO            = YES
   529 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
   530 # (detailed) documentation of file and class members alphabetically by member
   531 # name. If set to NO the members will appear in declaration order.
   532 # The default value is: YES.
   534 SORT_MEMBER_DOCS       = YES
   536 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
   537 # descriptions of file, namespace and class members alphabetically by member
   538 # name. If set to NO the members will appear in declaration order. Note that
   539 # this will also influence the order of the classes in the class list.
   540 # The default value is: NO.
   542 SORT_BRIEF_DOCS        = NO
   544 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
   545 # (brief and detailed) documentation of class members so that constructors and
   546 # destructors are listed first. If set to NO the constructors will appear in the
   547 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
   548 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
   549 # member documentation.
   550 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
   551 # detailed member documentation.
   552 # The default value is: NO.
   554 SORT_MEMBERS_CTORS_1ST = NO
   556 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
   557 # of group names into alphabetical order. If set to NO the group names will
   558 # appear in their defined order.
   559 # The default value is: NO.
   561 SORT_GROUP_NAMES       = NO
   563 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
   564 # fully-qualified names, including namespaces. If set to NO, the class list will
   565 # be sorted only by class name, not including the namespace part.
   566 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
   567 # Note: This option applies only to the class list, not to the alphabetical
   568 # list.
   569 # The default value is: NO.
   571 SORT_BY_SCOPE_NAME     = NO
   573 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
   574 # type resolution of all parameters of a function it will reject a match between
   575 # the prototype and the implementation of a member function even if there is
   576 # only one candidate or it is obvious which candidate to choose by doing a
   577 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
   578 # accept a match between prototype and implementation in such cases.
   579 # The default value is: NO.
   581 STRICT_PROTO_MATCHING  = NO
   583 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
   584 # todo list. This list is created by putting \todo commands in the
   585 # documentation.
   586 # The default value is: YES.
   588 GENERATE_TODOLIST      = YES
   590 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
   591 # test list. This list is created by putting \test commands in the
   592 # documentation.
   593 # The default value is: YES.
   595 GENERATE_TESTLIST      = YES
   597 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
   598 # list. This list is created by putting \bug commands in the documentation.
   599 # The default value is: YES.
   601 GENERATE_BUGLIST       = YES
   603 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
   604 # the deprecated list. This list is created by putting \deprecated commands in
   605 # the documentation.
   606 # The default value is: YES.
   608 GENERATE_DEPRECATEDLIST= YES
   610 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
   611 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
   612 # ... \endcond blocks.
   614 ENABLED_SECTIONS       =
   616 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
   617 # initial value of a variable or macro / define can have for it to appear in the
   618 # documentation. If the initializer consists of more lines than specified here
   619 # it will be hidden. Use a value of 0 to hide initializers completely. The
   620 # appearance of the value of individual variables and macros / defines can be
   621 # controlled using \showinitializer or \hideinitializer command in the
   622 # documentation regardless of this setting.
   623 # Minimum value: 0, maximum value: 10000, default value: 30.
   625 MAX_INITIALIZER_LINES  = 30
   627 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
   628 # the bottom of the documentation of classes and structs. If set to YES the list
   629 # will mention the files that were used to generate the documentation.
   630 # The default value is: YES.
   632 SHOW_USED_FILES        = YES
   634 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
   635 # will remove the Files entry from the Quick Index and from the Folder Tree View
   636 # (if specified).
   637 # The default value is: YES.
   639 SHOW_FILES             = YES
   641 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
   642 # page. This will remove the Namespaces entry from the Quick Index and from the
   643 # Folder Tree View (if specified).
   644 # The default value is: YES.
   646 SHOW_NAMESPACES        = YES
   648 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
   649 # doxygen should invoke to get the current version for each file (typically from
   650 # the version control system). Doxygen will invoke the program by executing (via
   651 # popen()) the command command input-file, where command is the value of the
   652 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
   653 # by doxygen. Whatever the program writes to standard output is used as the file
   654 # version. For an example see the documentation.
   656 FILE_VERSION_FILTER    =
   658 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
   659 # by doxygen. The layout file controls the global structure of the generated
   660 # output files in an output format independent way. To create the layout file
   661 # that represents doxygen's defaults, run doxygen with the -l option. You can
   662 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
   663 # will be used as the name of the layout file.
   664 #
   665 # Note that if you run doxygen from a directory containing a file called
   666 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
   667 # tag is left empty.
   669 LAYOUT_FILE            =
   671 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
   672 # the reference definitions. This must be a list of .bib files. The .bib
   673 # extension is automatically appended if omitted. This requires the bibtex tool
   674 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
   675 # For LaTeX the style of the bibliography can be controlled using
   676 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
   677 # search path. Do not use file names with spaces, bibtex cannot handle them. See
   678 # also \cite for info how to create references.
   680 CITE_BIB_FILES         =
   682 #---------------------------------------------------------------------------
   683 # Configuration options related to warning and progress messages
   684 #---------------------------------------------------------------------------
   686 # The QUIET tag can be used to turn on/off the messages that are generated to
   687 # standard output by doxygen. If QUIET is set to YES this implies that the
   688 # messages are off.
   689 # The default value is: NO.
   691 QUIET                  = YES
   693 # The WARNINGS tag can be used to turn on/off the warning messages that are
   694 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
   695 # this implies that the warnings are on.
   696 #
   697 # Tip: Turn warnings on while writing the documentation.
   698 # The default value is: YES.
   700 WARNINGS               = YES
   702 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
   703 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
   704 # will automatically be disabled.
   705 # The default value is: YES.
   707 WARN_IF_UNDOCUMENTED   = YES
   709 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
   710 # potential errors in the documentation, such as not documenting some parameters
   711 # in a documented function, or documenting parameters that don't exist or using
   712 # markup commands wrongly.
   713 # The default value is: YES.
   715 WARN_IF_DOC_ERROR      = YES
   717 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
   718 # are documented, but have no documentation for their parameters or return
   719 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
   720 # documentation, but not about the absence of documentation.
   721 # The default value is: NO.
   723 WARN_NO_PARAMDOC       = YES
   725 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
   726 # can produce. The string should contain the $file, $line, and $text tags, which
   727 # will be replaced by the file and line number from which the warning originated
   728 # and the warning text. Optionally the format may contain $version, which will
   729 # be replaced by the version of the file (if it could be obtained via
   730 # FILE_VERSION_FILTER)
   731 # The default value is: $file:$line: $text.
   733 WARN_FORMAT            = "$file:$line: $text"
   735 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
   736 # messages should be written. If left blank the output is written to standard
   737 # error (stderr).
   739 WARN_LOGFILE           =
   741 #---------------------------------------------------------------------------
   742 # Configuration options related to the input files
   743 #---------------------------------------------------------------------------
   745 # The INPUT tag is used to specify the files and/or directories that contain
   746 # documented source files. You may enter file names like myfile.cpp or
   747 # directories like /usr/src/myproject. Separate the files or directories with
   748 # spaces.
   749 # Note: If this tag is empty the current directory is searched.
   751 INPUT                  = @DOXY_INPUT@
   753 # This tag can be used to specify the character encoding of the source files
   754 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
   755 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
   756 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
   757 # possible encodings.
   758 # The default value is: UTF-8.
   760 INPUT_ENCODING         = UTF-8
   762 # If the value of the INPUT tag contains directories, you can use the
   763 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
   764 # *.h) to filter out the source-files in the directories. If left blank the
   765 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
   766 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
   767 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
   768 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
   769 # *.qsf, *.as and *.js.
   771 FILE_PATTERNS          =
   773 # The RECURSIVE tag can be used to specify whether or not subdirectories should
   774 # be searched for input files as well.
   775 # The default value is: NO.
   777 RECURSIVE              = YES
   779 # The EXCLUDE tag can be used to specify files and/or directories that should be
   780 # excluded from the INPUT source files. This way you can easily exclude a
   781 # subdirectory from a directory tree whose root is specified with the INPUT tag.
   782 #
   783 # Note that relative paths are relative to the directory from which doxygen is
   784 # run.
   786 EXCLUDE                =
   788 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
   789 # directories that are symbolic links (a Unix file system feature) are excluded
   790 # from the input.
   791 # The default value is: NO.
   793 EXCLUDE_SYMLINKS       = NO
   795 # If the value of the INPUT tag contains directories, you can use the
   796 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
   797 # certain files from those directories.
   798 #
   799 # Note that the wildcards are matched against the file with absolute path, so to
   800 # exclude all test directories for example use the pattern */test/*
   802 EXCLUDE_PATTERNS       =
   804 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
   805 # (namespaces, classes, functions, etc.) that should be excluded from the
   806 # output. The symbol name can be a fully qualified name, a word, or if the
   807 # wildcard * is used, a substring. Examples: ANamespace, AClass,
   808 # AClass::ANamespace, ANamespace::*Test
   809 #
   810 # Note that the wildcards are matched against the file with absolute path, so to
   811 # exclude all test directories use the pattern */test/*
   813 EXCLUDE_SYMBOLS        =
   815 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
   816 # that contain example code fragments that are included (see the \include
   817 # command).
   819 EXAMPLE_PATH           =
   821 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
   822 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
   823 # *.h) to filter out the source-files in the directories. If left blank all
   824 # files are included.
   826 EXAMPLE_PATTERNS       =
   828 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
   829 # searched for input files to be used with the \include or \dontinclude commands
   830 # irrespective of the value of the RECURSIVE tag.
   831 # The default value is: NO.
   833 EXAMPLE_RECURSIVE      = NO
   835 # The IMAGE_PATH tag can be used to specify one or more files or directories
   836 # that contain images that are to be included in the documentation (see the
   837 # \image command).
   839 IMAGE_PATH             =
   841 # The INPUT_FILTER tag can be used to specify a program that doxygen should
   842 # invoke to filter for each input file. Doxygen will invoke the filter program
   843 # by executing (via popen()) the command:
   844 #
   845 # <filter> <input-file>
   846 #
   847 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
   848 # name of an input file. Doxygen will then use the output that the filter
   849 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
   850 # will be ignored.
   851 #
   852 # Note that the filter must not add or remove lines; it is applied before the
   853 # code is scanned, but not when the output code is generated. If lines are added
   854 # or removed, the anchors will not be placed correctly.
   856 INPUT_FILTER           =
   858 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
   859 # basis. Doxygen will compare the file name with each pattern and apply the
   860 # filter if there is a match. The filters are a list of the form: pattern=filter
   861 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
   862 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
   863 # patterns match the file name, INPUT_FILTER is applied.
   865 FILTER_PATTERNS        =
   867 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   868 # INPUT_FILTER ) will also be used to filter the input files that are used for
   869 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
   870 # The default value is: NO.
   872 FILTER_SOURCE_FILES    = NO
   874 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
   875 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
   876 # it is also possible to disable source filtering for a specific pattern using
   877 # *.ext= (so without naming a filter).
   878 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
   880 FILTER_SOURCE_PATTERNS =
   882 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
   883 # is part of the input, its contents will be placed on the main page
   884 # (index.html). This can be useful if you have a project on for instance GitHub
   885 # and want to reuse the introduction page also for the doxygen output.
   887 USE_MDFILE_AS_MAINPAGE =
   889 #---------------------------------------------------------------------------
   890 # Configuration options related to source browsing
   891 #---------------------------------------------------------------------------
   893 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
   894 # generated. Documented entities will be cross-referenced with these sources.
   895 #
   896 # Note: To get rid of all source code in the generated output, make sure that
   897 # also VERBATIM_HEADERS is set to NO.
   898 # The default value is: NO.
   900 SOURCE_BROWSER         = NO
   902 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
   903 # classes and enums directly into the documentation.
   904 # The default value is: NO.
   906 INLINE_SOURCES         = NO
   908 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
   909 # special comment blocks from generated source code fragments. Normal C, C++ and
   910 # Fortran comments will always remain visible.
   911 # The default value is: YES.
   913 STRIP_CODE_COMMENTS    = YES
   915 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
   916 # function all documented functions referencing it will be listed.
   917 # The default value is: NO.
   919 REFERENCED_BY_RELATION = NO
   921 # If the REFERENCES_RELATION tag is set to YES then for each documented function
   922 # all documented entities called/used by that function will be listed.
   923 # The default value is: NO.
   925 REFERENCES_RELATION    = NO
   927 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
   928 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
   929 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
   930 # link to the documentation.
   931 # The default value is: YES.
   933 REFERENCES_LINK_SOURCE = YES
   935 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
   936 # source code will show a tooltip with additional information such as prototype,
   937 # brief description and links to the definition and documentation. Since this
   938 # will make the HTML file larger and loading of large files a bit slower, you
   939 # can opt to disable this feature.
   940 # The default value is: YES.
   941 # This tag requires that the tag SOURCE_BROWSER is set to YES.
   943 SOURCE_TOOLTIPS        = YES
   945 # If the USE_HTAGS tag is set to YES then the references to source code will
   946 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
   947 # source browser. The htags tool is part of GNU's global source tagging system
   948 # (see http://www.gnu.org/software/global/global.html). You will need version
   949 # 4.8.6 or higher.
   950 #
   951 # To use it do the following:
   952 # - Install the latest version of global
   953 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
   954 # - Make sure the INPUT points to the root of the source tree
   955 # - Run doxygen as normal
   956 #
   957 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
   958 # tools must be available from the command line (i.e. in the search path).
   959 #
   960 # The result: instead of the source browser generated by doxygen, the links to
   961 # source code will now point to the output of htags.
   962 # The default value is: NO.
   963 # This tag requires that the tag SOURCE_BROWSER is set to YES.
   965 USE_HTAGS              = NO
   967 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
   968 # verbatim copy of the header file for each class for which an include is
   969 # specified. Set to NO to disable this.
   970 # See also: Section \class.
   971 # The default value is: YES.
   973 VERBATIM_HEADERS       = YES
   975 #---------------------------------------------------------------------------
   976 # Configuration options related to the alphabetical class index
   977 #---------------------------------------------------------------------------
   979 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
   980 # compounds will be generated. Enable this if the project contains a lot of
   981 # classes, structs, unions or interfaces.
   982 # The default value is: YES.
   984 ALPHABETICAL_INDEX     = YES
   986 # In case all classes in a project start with a common prefix, all classes will
   987 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
   988 # can be used to specify a prefix (or a list of prefixes) that should be ignored
   989 # while generating the index headers.
   990 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
   992 IGNORE_PREFIX          =
   994 #---------------------------------------------------------------------------
   995 # Configuration options related to the HTML output
   996 #---------------------------------------------------------------------------
   998 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
   999 # The default value is: YES.
  1001 GENERATE_HTML          = YES
  1003 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  1004 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1005 # it.
  1006 # The default directory is: html.
  1007 # This tag requires that the tag GENERATE_HTML is set to YES.
  1009 HTML_OUTPUT            = web/api
  1011 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  1012 # generated HTML page (for example: .htm, .php, .asp).
  1013 # The default value is: .html.
  1014 # This tag requires that the tag GENERATE_HTML is set to YES.
  1016 HTML_FILE_EXTENSION    = .html
  1018 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  1019 # each generated HTML page. If the tag is left blank doxygen will generate a
  1020 # standard header.
  1022 # To get valid HTML the header file that includes any scripts and style sheets
  1023 # that doxygen needs, which is dependent on the configuration options used (e.g.
  1024 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  1025 # default header using
  1026 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  1027 # YourConfigFile
  1028 # and then modify the file new_header.html. See also section "Doxygen usage"
  1029 # for information on how to generate the default header that doxygen normally
  1030 # uses.
  1031 # Note: The header is subject to change so you typically have to regenerate the
  1032 # default header when upgrading to a newer version of doxygen. For a description
  1033 # of the possible markers and block names see the documentation.
  1034 # This tag requires that the tag GENERATE_HTML is set to YES.
  1036 HTML_HEADER            =
  1038 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  1039 # generated HTML page. If the tag is left blank doxygen will generate a standard
  1040 # footer. See HTML_HEADER for more information on how to generate a default
  1041 # footer and what special commands can be used inside the footer. See also
  1042 # section "Doxygen usage" for information on how to generate the default footer
  1043 # that doxygen normally uses.
  1044 # This tag requires that the tag GENERATE_HTML is set to YES.
  1046 HTML_FOOTER            =
  1048 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  1049 # sheet that is used by each HTML page. It can be used to fine-tune the look of
  1050 # the HTML output. If left blank doxygen will generate a default style sheet.
  1051 # See also section "Doxygen usage" for information on how to generate the style
  1052 # sheet that doxygen normally uses.
  1053 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  1054 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  1055 # obsolete.
  1056 # This tag requires that the tag GENERATE_HTML is set to YES.
  1058 HTML_STYLESHEET        =
  1060 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
  1061 # defined cascading style sheet that is included after the standard style sheets
  1062 # created by doxygen. Using this option one can overrule certain style aspects.
  1063 # This is preferred over using HTML_STYLESHEET since it does not replace the
  1064 # standard style sheet and is therefor more robust against future updates.
  1065 # Doxygen will copy the style sheet file to the output directory. For an example
  1066 # see the documentation.
  1067 # This tag requires that the tag GENERATE_HTML is set to YES.
  1069 HTML_EXTRA_STYLESHEET  =
  1071 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  1072 # other source files which should be copied to the HTML output directory. Note
  1073 # that these files will be copied to the base HTML output directory. Use the
  1074 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  1075 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  1076 # files will be copied as-is; there are no commands or markers available.
  1077 # This tag requires that the tag GENERATE_HTML is set to YES.
  1079 HTML_EXTRA_FILES       =
  1081 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  1082 # will adjust the colors in the stylesheet and background images according to
  1083 # this color. Hue is specified as an angle on a colorwheel, see
  1084 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  1085 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  1086 # purple, and 360 is red again.
  1087 # Minimum value: 0, maximum value: 359, default value: 220.
  1088 # This tag requires that the tag GENERATE_HTML is set to YES.
  1090 HTML_COLORSTYLE_HUE    = 220
  1092 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  1093 # in the HTML output. For a value of 0 the output will use grayscales only. A
  1094 # value of 255 will produce the most vivid colors.
  1095 # Minimum value: 0, maximum value: 255, default value: 100.
  1096 # This tag requires that the tag GENERATE_HTML is set to YES.
  1098 HTML_COLORSTYLE_SAT    = 100
  1100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  1101 # luminance component of the colors in the HTML output. Values below 100
  1102 # gradually make the output lighter, whereas values above 100 make the output
  1103 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  1104 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  1105 # change the gamma.
  1106 # Minimum value: 40, maximum value: 240, default value: 80.
  1107 # This tag requires that the tag GENERATE_HTML is set to YES.
  1109 HTML_COLORSTYLE_GAMMA  = 80
  1111 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  1112 # page will contain the date and time when the page was generated. Setting this
  1113 # to NO can help when comparing the output of multiple runs.
  1114 # The default value is: YES.
  1115 # This tag requires that the tag GENERATE_HTML is set to YES.
  1117 HTML_TIMESTAMP         = YES
  1119 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  1120 # documentation will contain sections that can be hidden and shown after the
  1121 # page has loaded.
  1122 # The default value is: NO.
  1123 # This tag requires that the tag GENERATE_HTML is set to YES.
  1125 HTML_DYNAMIC_SECTIONS  = NO
  1127 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1128 # shown in the various tree structured indices initially; the user can expand
  1129 # and collapse entries dynamically later on. Doxygen will expand the tree to
  1130 # such a level that at most the specified number of entries are visible (unless
  1131 # a fully collapsed tree already exceeds this amount). So setting the number of
  1132 # entries 1 will produce a full collapsed tree by default. 0 is a special value
  1133 # representing an infinite number of entries and will result in a full expanded
  1134 # tree by default.
  1135 # Minimum value: 0, maximum value: 9999, default value: 100.
  1136 # This tag requires that the tag GENERATE_HTML is set to YES.
  1138 HTML_INDEX_NUM_ENTRIES = 100
  1140 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1141 # generated that can be used as input for Apple's Xcode 3 integrated development
  1142 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
  1143 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  1144 # Makefile in the HTML output directory. Running make will produce the docset in
  1145 # that directory and running make install will install the docset in
  1146 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1147 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  1148 # for more information.
  1149 # The default value is: NO.
  1150 # This tag requires that the tag GENERATE_HTML is set to YES.
  1152 GENERATE_DOCSET        = NO
  1154 # This tag determines the name of the docset feed. A documentation feed provides
  1155 # an umbrella under which multiple documentation sets from a single provider
  1156 # (such as a company or product suite) can be grouped.
  1157 # The default value is: Doxygen generated docs.
  1158 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1160 DOCSET_FEEDNAME        = "Doxygen generated docs"
  1162 # This tag specifies a string that should uniquely identify the documentation
  1163 # set bundle. This should be a reverse domain-name style string, e.g.
  1164 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1165 # The default value is: org.doxygen.Project.
  1166 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1168 DOCSET_BUNDLE_ID       = org.doxygen.Project
  1170 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1171 # the documentation publisher. This should be a reverse domain-name style
  1172 # string, e.g. com.mycompany.MyDocSet.documentation.
  1173 # The default value is: org.doxygen.Publisher.
  1174 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1176 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
  1178 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1179 # The default value is: Publisher.
  1180 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1182 DOCSET_PUBLISHER_NAME  = Publisher
  1184 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1185 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1186 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1187 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1188 # Windows.
  1190 # The HTML Help Workshop contains a compiler that can convert all HTML output
  1191 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1192 # files are now used as the Windows 98 help format, and will replace the old
  1193 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1194 # HTML files also contain an index, a table of contents, and you can search for
  1195 # words in the documentation. The HTML workshop also contains a viewer for
  1196 # compressed HTML files.
  1197 # The default value is: NO.
  1198 # This tag requires that the tag GENERATE_HTML is set to YES.
  1200 GENERATE_HTMLHELP      = NO
  1202 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1203 # file. You can add a path in front of the file if the result should not be
  1204 # written to the html output directory.
  1205 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1207 CHM_FILE               =
  1209 # The HHC_LOCATION tag can be used to specify the location (absolute path
  1210 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
  1211 # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1212 # The file has to be specified with full path.
  1213 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1215 HHC_LOCATION           =
  1217 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
  1218 # YES) or that it should be included in the master .chm file ( NO).
  1219 # The default value is: NO.
  1220 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1222 GENERATE_CHI           = NO
  1224 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
  1225 # and project file content.
  1226 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1228 CHM_INDEX_ENCODING     =
  1230 # The BINARY_TOC flag controls whether a binary table of contents is generated (
  1231 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
  1232 # enables the Previous and Next buttons.
  1233 # The default value is: NO.
  1234 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1236 BINARY_TOC             = NO
  1238 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1239 # the table of contents of the HTML help documentation and to the tree view.
  1240 # The default value is: NO.
  1241 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1243 TOC_EXPAND             = NO
  1245 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1246 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1247 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1248 # (.qch) of the generated HTML documentation.
  1249 # The default value is: NO.
  1250 # This tag requires that the tag GENERATE_HTML is set to YES.
  1252 GENERATE_QHP           = NO
  1254 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1255 # the file name of the resulting .qch file. The path specified is relative to
  1256 # the HTML output folder.
  1257 # This tag requires that the tag GENERATE_QHP is set to YES.
  1259 QCH_FILE               =
  1261 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1262 # Project output. For more information please see Qt Help Project / Namespace
  1263 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1264 # The default value is: org.doxygen.Project.
  1265 # This tag requires that the tag GENERATE_QHP is set to YES.
  1267 QHP_NAMESPACE          = org.doxygen.Project
  1269 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1270 # Help Project output. For more information please see Qt Help Project / Virtual
  1271 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1272 # folders).
  1273 # The default value is: doc.
  1274 # This tag requires that the tag GENERATE_QHP is set to YES.
  1276 QHP_VIRTUAL_FOLDER     = doc
  1278 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1279 # filter to add. For more information please see Qt Help Project / Custom
  1280 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1281 # filters).
  1282 # This tag requires that the tag GENERATE_QHP is set to YES.
  1284 QHP_CUST_FILTER_NAME   =
  1286 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1287 # custom filter to add. For more information please see Qt Help Project / Custom
  1288 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1289 # filters).
  1290 # This tag requires that the tag GENERATE_QHP is set to YES.
  1292 QHP_CUST_FILTER_ATTRS  =
  1294 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1295 # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1296 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1297 # This tag requires that the tag GENERATE_QHP is set to YES.
  1299 QHP_SECT_FILTER_ATTRS  =
  1301 # The QHG_LOCATION tag can be used to specify the location of Qt's
  1302 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1303 # generated .qhp file.
  1304 # This tag requires that the tag GENERATE_QHP is set to YES.
  1306 QHG_LOCATION           =
  1308 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1309 # generated, together with the HTML files, they form an Eclipse help plugin. To
  1310 # install this plugin and make it available under the help contents menu in
  1311 # Eclipse, the contents of the directory containing the HTML and XML files needs
  1312 # to be copied into the plugins directory of eclipse. The name of the directory
  1313 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1314 # After copying Eclipse needs to be restarted before the help appears.
  1315 # The default value is: NO.
  1316 # This tag requires that the tag GENERATE_HTML is set to YES.
  1318 GENERATE_ECLIPSEHELP   = NO
  1320 # A unique identifier for the Eclipse help plugin. When installing the plugin
  1321 # the directory name containing the HTML and XML files should also have this
  1322 # name. Each documentation set should have its own identifier.
  1323 # The default value is: org.doxygen.Project.
  1324 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1326 ECLIPSE_DOC_ID         = org.doxygen.Project
  1328 # If you want full control over the layout of the generated HTML pages it might
  1329 # be necessary to disable the index and replace it with your own. The
  1330 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1331 # of each HTML page. A value of NO enables the index and the value YES disables
  1332 # it. Since the tabs in the index contain the same information as the navigation
  1333 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1334 # The default value is: NO.
  1335 # This tag requires that the tag GENERATE_HTML is set to YES.
  1337 DISABLE_INDEX          = NO
  1339 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1340 # structure should be generated to display hierarchical information. If the tag
  1341 # value is set to YES, a side panel will be generated containing a tree-like
  1342 # index structure (just like the one that is generated for HTML Help). For this
  1343 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1344 # (i.e. any modern browser). Windows users are probably better off using the
  1345 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
  1346 # further fine-tune the look of the index. As an example, the default style
  1347 # sheet generated by doxygen has an example that shows how to put an image at
  1348 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1349 # the same information as the tab index, you could consider setting
  1350 # DISABLE_INDEX to YES when enabling this option.
  1351 # The default value is: NO.
  1352 # This tag requires that the tag GENERATE_HTML is set to YES.
  1354 GENERATE_TREEVIEW      = NO
  1356 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1357 # doxygen will group on one line in the generated HTML documentation.
  1359 # Note that a value of 0 will completely suppress the enum values from appearing
  1360 # in the overview section.
  1361 # Minimum value: 0, maximum value: 20, default value: 4.
  1362 # This tag requires that the tag GENERATE_HTML is set to YES.
  1364 ENUM_VALUES_PER_LINE   = 4
  1366 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1367 # to set the initial width (in pixels) of the frame in which the tree is shown.
  1368 # Minimum value: 0, maximum value: 1500, default value: 250.
  1369 # This tag requires that the tag GENERATE_HTML is set to YES.
  1371 TREEVIEW_WIDTH         = 250
  1373 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
  1374 # external symbols imported via tag files in a separate window.
  1375 # The default value is: NO.
  1376 # This tag requires that the tag GENERATE_HTML is set to YES.
  1378 EXT_LINKS_IN_WINDOW    = NO
  1380 # Use this tag to change the font size of LaTeX formulas included as images in
  1381 # the HTML documentation. When you change the font size after a successful
  1382 # doxygen run you need to manually remove any form_*.png images from the HTML
  1383 # output directory to force them to be regenerated.
  1384 # Minimum value: 8, maximum value: 50, default value: 10.
  1385 # This tag requires that the tag GENERATE_HTML is set to YES.
  1387 FORMULA_FONTSIZE       = 10
  1389 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1390 # generated for formulas are transparent PNGs. Transparent PNGs are not
  1391 # supported properly for IE 6.0, but are supported on all modern browsers.
  1393 # Note that when changing this option you need to delete any form_*.png files in
  1394 # the HTML output directory before the changes have effect.
  1395 # The default value is: YES.
  1396 # This tag requires that the tag GENERATE_HTML is set to YES.
  1398 FORMULA_TRANSPARENT    = YES
  1400 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1401 # http://www.mathjax.org) which uses client side Javascript for the rendering
  1402 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
  1403 # installed or if you want to formulas look prettier in the HTML output. When
  1404 # enabled you may also need to install MathJax separately and configure the path
  1405 # to it using the MATHJAX_RELPATH option.
  1406 # The default value is: NO.
  1407 # This tag requires that the tag GENERATE_HTML is set to YES.
  1409 USE_MATHJAX            = NO
  1411 # When MathJax is enabled you can set the default output format to be used for
  1412 # the MathJax output. See the MathJax site (see:
  1413 # http://docs.mathjax.org/en/latest/output.html) for more details.
  1414 # Possible values are: HTML-CSS (which is slower, but has the best
  1415 # compatibility), NativeMML (i.e. MathML) and SVG.
  1416 # The default value is: HTML-CSS.
  1417 # This tag requires that the tag USE_MATHJAX is set to YES.
  1419 MATHJAX_FORMAT         = HTML-CSS
  1421 # When MathJax is enabled you need to specify the location relative to the HTML
  1422 # output directory using the MATHJAX_RELPATH option. The destination directory
  1423 # should contain the MathJax.js script. For instance, if the mathjax directory
  1424 # is located at the same level as the HTML output directory, then
  1425 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1426 # Content Delivery Network so you can quickly see the result without installing
  1427 # MathJax. However, it is strongly recommended to install a local copy of
  1428 # MathJax from http://www.mathjax.org before deployment.
  1429 # The default value is: http://cdn.mathjax.org/mathjax/latest.
  1430 # This tag requires that the tag USE_MATHJAX is set to YES.
  1432 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  1434 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1435 # extension names that should be enabled during MathJax rendering. For example
  1436 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1437 # This tag requires that the tag USE_MATHJAX is set to YES.
  1439 MATHJAX_EXTENSIONS     =
  1441 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1442 # of code that will be used on startup of the MathJax code. See the MathJax site
  1443 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1444 # example see the documentation.
  1445 # This tag requires that the tag USE_MATHJAX is set to YES.
  1447 MATHJAX_CODEFILE       =
  1449 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1450 # the HTML output. The underlying search engine uses javascript and DHTML and
  1451 # should work on any modern browser. Note that when using HTML help
  1452 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1453 # there is already a search function so this one should typically be disabled.
  1454 # For large projects the javascript based search engine can be slow, then
  1455 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1456 # search using the keyboard; to jump to the search box use <access key> + S
  1457 # (what the <access key> is depends on the OS and browser, but it is typically
  1458 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1459 # key> to jump into the search results window, the results can be navigated
  1460 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1461 # the search. The filter options can be selected when the cursor is inside the
  1462 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1463 # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1464 # option.
  1465 # The default value is: YES.
  1466 # This tag requires that the tag GENERATE_HTML is set to YES.
  1468 SEARCHENGINE           = YES
  1470 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1471 # implemented using a web server instead of a web client using Javascript. There
  1472 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1473 # setting. When disabled, doxygen will generate a PHP script for searching and
  1474 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1475 # and searching needs to be provided by external tools. See the section
  1476 # "External Indexing and Searching" for details.
  1477 # The default value is: NO.
  1478 # This tag requires that the tag SEARCHENGINE is set to YES.
  1480 SERVER_BASED_SEARCH    = NO
  1482 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1483 # script for searching. Instead the search results are written to an XML file
  1484 # which needs to be processed by an external indexer. Doxygen will invoke an
  1485 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1486 # search results.
  1488 # Doxygen ships with an example indexer ( doxyindexer) and search engine
  1489 # (doxysearch.cgi) which are based on the open source search engine library
  1490 # Xapian (see: http://xapian.org/).
  1492 # See the section "External Indexing and Searching" for details.
  1493 # The default value is: NO.
  1494 # This tag requires that the tag SEARCHENGINE is set to YES.
  1496 EXTERNAL_SEARCH        = NO
  1498 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1499 # which will return the search results when EXTERNAL_SEARCH is enabled.
  1501 # Doxygen ships with an example indexer ( doxyindexer) and search engine
  1502 # (doxysearch.cgi) which are based on the open source search engine library
  1503 # Xapian (see: http://xapian.org/). See the section "External Indexing and
  1504 # Searching" for details.
  1505 # This tag requires that the tag SEARCHENGINE is set to YES.
  1507 SEARCHENGINE_URL       =
  1509 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1510 # search data is written to a file for indexing by an external tool. With the
  1511 # SEARCHDATA_FILE tag the name of this file can be specified.
  1512 # The default file is: searchdata.xml.
  1513 # This tag requires that the tag SEARCHENGINE is set to YES.
  1515 SEARCHDATA_FILE        = searchdata.xml
  1517 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1518 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1519 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1520 # projects and redirect the results back to the right project.
  1521 # This tag requires that the tag SEARCHENGINE is set to YES.
  1523 EXTERNAL_SEARCH_ID     =
  1525 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1526 # projects other than the one defined by this configuration file, but that are
  1527 # all added to the same external search index. Each project needs to have a
  1528 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1529 # to a relative location where the documentation can be found. The format is:
  1530 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1531 # This tag requires that the tag SEARCHENGINE is set to YES.
  1533 EXTRA_SEARCH_MAPPINGS  =
  1535 #---------------------------------------------------------------------------
  1536 # Configuration options related to the LaTeX output
  1537 #---------------------------------------------------------------------------
  1539 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
  1540 # The default value is: YES.
  1542 GENERATE_LATEX         = NO
  1544 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1545 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1546 # it.
  1547 # The default directory is: latex.
  1548 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1550 LATEX_OUTPUT           = latex
  1552 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1553 # invoked.
  1555 # Note that when enabling USE_PDFLATEX this option is only used for generating
  1556 # bitmaps for formulas in the HTML output, but not in the Makefile that is
  1557 # written to the output directory.
  1558 # The default file is: latex.
  1559 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1561 LATEX_CMD_NAME         = latex
  1563 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1564 # index for LaTeX.
  1565 # The default file is: makeindex.
  1566 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1568 MAKEINDEX_CMD_NAME     = makeindex
  1570 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
  1571 # documents. This may be useful for small projects and may help to save some
  1572 # trees in general.
  1573 # The default value is: NO.
  1574 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1576 COMPACT_LATEX          = NO
  1578 # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1579 # printer.
  1580 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1581 # 14 inches) and executive (7.25 x 10.5 inches).
  1582 # The default value is: a4.
  1583 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1585 PAPER_TYPE             = a4
  1587 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1588 # that should be included in the LaTeX output. To get the times font for
  1589 # instance you can specify
  1590 # EXTRA_PACKAGES=times
  1591 # If left blank no extra packages will be included.
  1592 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1594 EXTRA_PACKAGES         =
  1596 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1597 # generated LaTeX document. The header should contain everything until the first
  1598 # chapter. If it is left blank doxygen will generate a standard header. See
  1599 # section "Doxygen usage" for information on how to let doxygen write the
  1600 # default header to a separate file.
  1602 # Note: Only use a user-defined header if you know what you are doing! The
  1603 # following commands have a special meaning inside the header: $title,
  1604 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
  1605 # replace them by respectively the title of the page, the current date and time,
  1606 # only the current date, the version number of doxygen, the project name (see
  1607 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
  1608 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1610 LATEX_HEADER           =
  1612 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1613 # generated LaTeX document. The footer should contain everything after the last
  1614 # chapter. If it is left blank doxygen will generate a standard footer.
  1616 # Note: Only use a user-defined footer if you know what you are doing!
  1617 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1619 LATEX_FOOTER           =
  1621 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1622 # other source files which should be copied to the LATEX_OUTPUT output
  1623 # directory. Note that the files will be copied as-is; there are no commands or
  1624 # markers available.
  1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1627 LATEX_EXTRA_FILES      =
  1629 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1630 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1631 # contain links (just like the HTML output) instead of page references. This
  1632 # makes the output suitable for online browsing using a PDF viewer.
  1633 # The default value is: YES.
  1634 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1636 PDF_HYPERLINKS         = YES
  1638 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1639 # the PDF file directly from the LaTeX files. Set this option to YES to get a
  1640 # higher quality PDF documentation.
  1641 # The default value is: YES.
  1642 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1644 USE_PDFLATEX           = YES
  1646 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1647 # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1648 # if errors occur, instead of asking the user for help. This option is also used
  1649 # when generating formulas in HTML.
  1650 # The default value is: NO.
  1651 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1653 LATEX_BATCHMODE        = NO
  1655 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1656 # index chapters (such as File Index, Compound Index, etc.) in the output.
  1657 # The default value is: NO.
  1658 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1660 LATEX_HIDE_INDICES     = NO
  1662 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1663 # code with syntax highlighting in the LaTeX output.
  1665 # Note that which sources are shown also depends on other settings such as
  1666 # SOURCE_BROWSER.
  1667 # The default value is: NO.
  1668 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1670 LATEX_SOURCE_CODE      = NO
  1672 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1673 # bibliography, e.g. plainnat, or ieeetr. See
  1674 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1675 # The default value is: plain.
  1676 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1678 LATEX_BIB_STYLE        = plain
  1680 #---------------------------------------------------------------------------
  1681 # Configuration options related to the RTF output
  1682 #---------------------------------------------------------------------------
  1684 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
  1685 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1686 # readers/editors.
  1687 # The default value is: NO.
  1689 GENERATE_RTF           = NO
  1691 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1692 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1693 # it.
  1694 # The default directory is: rtf.
  1695 # This tag requires that the tag GENERATE_RTF is set to YES.
  1697 RTF_OUTPUT             = rtf
  1699 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
  1700 # documents. This may be useful for small projects and may help to save some
  1701 # trees in general.
  1702 # The default value is: NO.
  1703 # This tag requires that the tag GENERATE_RTF is set to YES.
  1705 COMPACT_RTF            = NO
  1707 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1708 # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1709 # output) instead of page references. This makes the output suitable for online
  1710 # browsing using Word or some other Word compatible readers that support those
  1711 # fields.
  1713 # Note: WordPad (write) and others do not support links.
  1714 # The default value is: NO.
  1715 # This tag requires that the tag GENERATE_RTF is set to YES.
  1717 RTF_HYPERLINKS         = NO
  1719 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1720 # file, i.e. a series of assignments. You only have to provide replacements,
  1721 # missing definitions are set to their default value.
  1723 # See also section "Doxygen usage" for information on how to generate the
  1724 # default style sheet that doxygen normally uses.
  1725 # This tag requires that the tag GENERATE_RTF is set to YES.
  1727 RTF_STYLESHEET_FILE    =
  1729 # Set optional variables used in the generation of an RTF document. Syntax is
  1730 # similar to doxygen's config file. A template extensions file can be generated
  1731 # using doxygen -e rtf extensionFile.
  1732 # This tag requires that the tag GENERATE_RTF is set to YES.
  1734 RTF_EXTENSIONS_FILE    =
  1736 #---------------------------------------------------------------------------
  1737 # Configuration options related to the man page output
  1738 #---------------------------------------------------------------------------
  1740 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
  1741 # classes and files.
  1742 # The default value is: NO.
  1744 GENERATE_MAN           = NO
  1746 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1747 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1748 # it. A directory man3 will be created inside the directory specified by
  1749 # MAN_OUTPUT.
  1750 # The default directory is: man.
  1751 # This tag requires that the tag GENERATE_MAN is set to YES.
  1753 MAN_OUTPUT             = man
  1755 # The MAN_EXTENSION tag determines the extension that is added to the generated
  1756 # man pages. In case the manual section does not start with a number, the number
  1757 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1758 # optional.
  1759 # The default value is: .3.
  1760 # This tag requires that the tag GENERATE_MAN is set to YES.
  1762 MAN_EXTENSION          = .3
  1764 # The MAN_SUBDIR tag determines the name of the directory created within
  1765 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1766 # MAN_EXTENSION with the initial . removed.
  1767 # This tag requires that the tag GENERATE_MAN is set to YES.
  1769 MAN_SUBDIR             =
  1771 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1772 # will generate one additional man file for each entity documented in the real
  1773 # man page(s). These additional files only source the real man page, but without
  1774 # them the man command would be unable to find the correct page.
  1775 # The default value is: NO.
  1776 # This tag requires that the tag GENERATE_MAN is set to YES.
  1778 MAN_LINKS              = NO
  1780 #---------------------------------------------------------------------------
  1781 # Configuration options related to the XML output
  1782 #---------------------------------------------------------------------------
  1784 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
  1785 # captures the structure of the code including all documentation.
  1786 # The default value is: NO.
  1788 GENERATE_XML           = NO
  1790 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1791 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1792 # it.
  1793 # The default directory is: xml.
  1794 # This tag requires that the tag GENERATE_XML is set to YES.
  1796 XML_OUTPUT             = xml
  1798 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
  1799 # listings (including syntax highlighting and cross-referencing information) to
  1800 # the XML output. Note that enabling this will significantly increase the size
  1801 # of the XML output.
  1802 # The default value is: YES.
  1803 # This tag requires that the tag GENERATE_XML is set to YES.
  1805 XML_PROGRAMLISTING     = YES
  1807 #---------------------------------------------------------------------------
  1808 # Configuration options related to the DOCBOOK output
  1809 #---------------------------------------------------------------------------
  1811 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
  1812 # that can be used to generate PDF.
  1813 # The default value is: NO.
  1815 GENERATE_DOCBOOK       = NO
  1817 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1818 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1819 # front of it.
  1820 # The default directory is: docbook.
  1821 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1823 DOCBOOK_OUTPUT         = docbook
  1825 #---------------------------------------------------------------------------
  1826 # Configuration options for the AutoGen Definitions output
  1827 #---------------------------------------------------------------------------
  1829 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
  1830 # Definitions (see http://autogen.sf.net) file that captures the structure of
  1831 # the code including all documentation. Note that this feature is still
  1832 # experimental and incomplete at the moment.
  1833 # The default value is: NO.
  1835 GENERATE_AUTOGEN_DEF   = NO
  1837 #---------------------------------------------------------------------------
  1838 # Configuration options related to the Perl module output
  1839 #---------------------------------------------------------------------------
  1841 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
  1842 # file that captures the structure of the code including all documentation.
  1844 # Note that this feature is still experimental and incomplete at the moment.
  1845 # The default value is: NO.
  1847 GENERATE_PERLMOD       = NO
  1849 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
  1850 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1851 # output from the Perl module output.
  1852 # The default value is: NO.
  1853 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1855 PERLMOD_LATEX          = NO
  1857 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
  1858 # formatted so it can be parsed by a human reader. This is useful if you want to
  1859 # understand what is going on. On the other hand, if this tag is set to NO the
  1860 # size of the Perl module output will be much smaller and Perl will parse it
  1861 # just the same.
  1862 # The default value is: YES.
  1863 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1865 PERLMOD_PRETTY         = YES
  1867 # The names of the make variables in the generated doxyrules.make file are
  1868 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1869 # so different doxyrules.make files included by the same Makefile don't
  1870 # overwrite each other's variables.
  1871 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1873 PERLMOD_MAKEVAR_PREFIX =
  1875 #---------------------------------------------------------------------------
  1876 # Configuration options related to the preprocessor
  1877 #---------------------------------------------------------------------------
  1879 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
  1880 # C-preprocessor directives found in the sources and include files.
  1881 # The default value is: YES.
  1883 ENABLE_PREPROCESSING   = YES
  1885 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
  1886 # in the source code. If set to NO only conditional compilation will be
  1887 # performed. Macro expansion can be done in a controlled way by setting
  1888 # EXPAND_ONLY_PREDEF to YES.
  1889 # The default value is: NO.
  1890 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1892 MACRO_EXPANSION        = NO
  1894 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1895 # the macro expansion is limited to the macros specified with the PREDEFINED and
  1896 # EXPAND_AS_DEFINED tags.
  1897 # The default value is: NO.
  1898 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1900 EXPAND_ONLY_PREDEF     = NO
  1902 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
  1903 # INCLUDE_PATH will be searched if a #include is found.
  1904 # The default value is: YES.
  1905 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1907 SEARCH_INCLUDES        = YES
  1909 # The INCLUDE_PATH tag can be used to specify one or more directories that
  1910 # contain include files that are not input files but should be processed by the
  1911 # preprocessor.
  1912 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1914 INCLUDE_PATH           =
  1916 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1917 # patterns (like *.h and *.hpp) to filter out the header-files in the
  1918 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1919 # used.
  1920 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1922 INCLUDE_FILE_PATTERNS  =
  1924 # The PREDEFINED tag can be used to specify one or more macro names that are
  1925 # defined before the preprocessor is started (similar to the -D option of e.g.
  1926 # gcc). The argument of the tag is a list of macros of the form: name or
  1927 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1928 # is assumed. To prevent a macro definition from being undefined via #undef or
  1929 # recursively expanded use the := operator instead of the = operator.
  1930 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1932 PREDEFINED             =
  1934 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1935 # tag can be used to specify a list of macro names that should be expanded. The
  1936 # macro definition that is found in the sources will be used. Use the PREDEFINED
  1937 # tag if you want to use a different macro definition that overrules the
  1938 # definition found in the source code.
  1939 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1941 EXPAND_AS_DEFINED      =
  1943 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1944 # remove all references to function-like macros that are alone on a line, have
  1945 # an all uppercase name, and do not end with a semicolon. Such function macros
  1946 # are typically used for boiler-plate code, and will confuse the parser if not
  1947 # removed.
  1948 # The default value is: YES.
  1949 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1951 SKIP_FUNCTION_MACROS   = YES
  1953 #---------------------------------------------------------------------------
  1954 # Configuration options related to external references
  1955 #---------------------------------------------------------------------------
  1957 # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1958 # file the location of the external documentation should be added. The format of
  1959 # a tag file without this location is as follows:
  1960 # TAGFILES = file1 file2 ...
  1961 # Adding location for the tag files is done as follows:
  1962 # TAGFILES = file1=loc1 "file2 = loc2" ...
  1963 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1964 # section "Linking to external documentation" for more information about the use
  1965 # of tag files.
  1966 # Note: Each tag file must have a unique name (where the name does NOT include
  1967 # the path). If a tag file is not located in the directory in which doxygen is
  1968 # run, you must also specify the path to the tagfile here.
  1970 TAGFILES               =
  1972 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1973 # tag file that is based on the input files it reads. See section "Linking to
  1974 # external documentation" for more information about the usage of tag files.
  1976 GENERATE_TAGFILE       =
  1978 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
  1979 # class index. If set to NO only the inherited external classes will be listed.
  1980 # The default value is: NO.
  1982 ALLEXTERNALS           = NO
  1984 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
  1985 # the modules index. If set to NO, only the current project's groups will be
  1986 # listed.
  1987 # The default value is: YES.
  1989 EXTERNAL_GROUPS        = YES
  1991 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
  1992 # the related pages index. If set to NO, only the current project's pages will
  1993 # be listed.
  1994 # The default value is: YES.
  1996 EXTERNAL_PAGES         = YES
  1998 #---------------------------------------------------------------------------
  1999 # Configuration options related to the dot tool
  2000 #---------------------------------------------------------------------------
  2002 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
  2003 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  2004 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  2005 # disabled, but it is recommended to install and use dot, since it yields more
  2006 # powerful graphs.
  2007 # The default value is: YES.
  2009 CLASS_DIAGRAMS         = YES
  2011 # You can include diagrams made with dia in doxygen documentation. Doxygen will
  2012 # then run dia to produce the diagram and insert it in the documentation. The
  2013 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  2014 # If left empty dia is assumed to be found in the default search path.
  2016 DIA_PATH               =
  2018 # If set to YES, the inheritance and collaboration graphs will hide inheritance
  2019 # and usage relations if the target is undocumented or is not a class.
  2020 # The default value is: YES.
  2022 HIDE_UNDOC_RELATIONS   = YES
  2024 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  2025 # available from the path. This tool is part of Graphviz (see:
  2026 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2027 # Bell Labs. The other options in this section have no effect if this option is
  2028 # set to NO
  2029 # The default value is: YES.
  2031 HAVE_DOT               = NO
  2033 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  2034 # to run in parallel. When set to 0 doxygen will base this on the number of
  2035 # processors available in the system. You can set it explicitly to a value
  2036 # larger than 0 to get control over the balance between CPU load and processing
  2037 # speed.
  2038 # Minimum value: 0, maximum value: 32, default value: 0.
  2039 # This tag requires that the tag HAVE_DOT is set to YES.
  2041 DOT_NUM_THREADS        = 0
  2043 # When you want a differently looking font n the dot files that doxygen
  2044 # generates you can specify the font name using DOT_FONTNAME. You need to make
  2045 # sure dot is able to find the font, which can be done by putting it in a
  2046 # standard location or by setting the DOTFONTPATH environment variable or by
  2047 # setting DOT_FONTPATH to the directory containing the font.
  2048 # The default value is: Helvetica.
  2049 # This tag requires that the tag HAVE_DOT is set to YES.
  2051 DOT_FONTNAME           = Helvetica
  2053 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2054 # dot graphs.
  2055 # Minimum value: 4, maximum value: 24, default value: 10.
  2056 # This tag requires that the tag HAVE_DOT is set to YES.
  2058 DOT_FONTSIZE           = 10
  2060 # By default doxygen will tell dot to use the default font as specified with
  2061 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2062 # the path where dot can find it using this tag.
  2063 # This tag requires that the tag HAVE_DOT is set to YES.
  2065 DOT_FONTPATH           =
  2067 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2068 # each documented class showing the direct and indirect inheritance relations.
  2069 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2070 # The default value is: YES.
  2071 # This tag requires that the tag HAVE_DOT is set to YES.
  2073 CLASS_GRAPH            = YES
  2075 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  2076 # graph for each documented class showing the direct and indirect implementation
  2077 # dependencies (inheritance, containment, and class references variables) of the
  2078 # class with other documented classes.
  2079 # The default value is: YES.
  2080 # This tag requires that the tag HAVE_DOT is set to YES.
  2082 COLLABORATION_GRAPH    = YES
  2084 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2085 # groups, showing the direct groups dependencies.
  2086 # The default value is: YES.
  2087 # This tag requires that the tag HAVE_DOT is set to YES.
  2089 GROUP_GRAPHS           = YES
  2091 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  2092 # collaboration diagrams in a style similar to the OMG's Unified Modeling
  2093 # Language.
  2094 # The default value is: NO.
  2095 # This tag requires that the tag HAVE_DOT is set to YES.
  2097 UML_LOOK               = NO
  2099 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  2100 # class node. If there are many fields or methods and many nodes the graph may
  2101 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  2102 # number of items for each type to make the size more manageable. Set this to 0
  2103 # for no limit. Note that the threshold may be exceeded by 50% before the limit
  2104 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  2105 # but if the number exceeds 15, the total amount of fields shown is limited to
  2106 # 10.
  2107 # Minimum value: 0, maximum value: 100, default value: 10.
  2108 # This tag requires that the tag HAVE_DOT is set to YES.
  2110 UML_LIMIT_NUM_FIELDS   = 10
  2112 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2113 # collaboration graphs will show the relations between templates and their
  2114 # instances.
  2115 # The default value is: NO.
  2116 # This tag requires that the tag HAVE_DOT is set to YES.
  2118 TEMPLATE_RELATIONS     = NO
  2120 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  2121 # YES then doxygen will generate a graph for each documented file showing the
  2122 # direct and indirect include dependencies of the file with other documented
  2123 # files.
  2124 # The default value is: YES.
  2125 # This tag requires that the tag HAVE_DOT is set to YES.
  2127 INCLUDE_GRAPH          = YES
  2129 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  2130 # set to YES then doxygen will generate a graph for each documented file showing
  2131 # the direct and indirect include dependencies of the file with other documented
  2132 # files.
  2133 # The default value is: YES.
  2134 # This tag requires that the tag HAVE_DOT is set to YES.
  2136 INCLUDED_BY_GRAPH      = YES
  2138 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  2139 # dependency graph for every global function or class method.
  2141 # Note that enabling this option will significantly increase the time of a run.
  2142 # So in most cases it will be better to enable call graphs for selected
  2143 # functions only using the \callgraph command.
  2144 # The default value is: NO.
  2145 # This tag requires that the tag HAVE_DOT is set to YES.
  2147 CALL_GRAPH             = NO
  2149 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  2150 # dependency graph for every global function or class method.
  2152 # Note that enabling this option will significantly increase the time of a run.
  2153 # So in most cases it will be better to enable caller graphs for selected
  2154 # functions only using the \callergraph command.
  2155 # The default value is: NO.
  2156 # This tag requires that the tag HAVE_DOT is set to YES.
  2158 CALLER_GRAPH           = NO
  2160 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  2161 # hierarchy of all classes instead of a textual one.
  2162 # The default value is: YES.
  2163 # This tag requires that the tag HAVE_DOT is set to YES.
  2165 GRAPHICAL_HIERARCHY    = YES
  2167 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  2168 # dependencies a directory has on other directories in a graphical way. The
  2169 # dependency relations are determined by the #include relations between the
  2170 # files in the directories.
  2171 # The default value is: YES.
  2172 # This tag requires that the tag HAVE_DOT is set to YES.
  2174 DIRECTORY_GRAPH        = YES
  2176 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  2177 # generated by dot.
  2178 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2179 # to make the SVG files visible in IE 9+ (other browsers do not have this
  2180 # requirement).
  2181 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  2182 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  2183 # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  2184 # The default value is: png.
  2185 # This tag requires that the tag HAVE_DOT is set to YES.
  2187 DOT_IMAGE_FORMAT       = png
  2189 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  2190 # enable generation of interactive SVG images that allow zooming and panning.
  2192 # Note that this requires a modern browser other than Internet Explorer. Tested
  2193 # and working are Firefox, Chrome, Safari, and Opera.
  2194 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  2195 # the SVG files visible. Older versions of IE do not have SVG support.
  2196 # The default value is: NO.
  2197 # This tag requires that the tag HAVE_DOT is set to YES.
  2199 INTERACTIVE_SVG        = NO
  2201 # The DOT_PATH tag can be used to specify the path where the dot tool can be
  2202 # found. If left blank, it is assumed the dot tool can be found in the path.
  2203 # This tag requires that the tag HAVE_DOT is set to YES.
  2205 DOT_PATH               =
  2207 # The DOTFILE_DIRS tag can be used to specify one or more directories that
  2208 # contain dot files that are included in the documentation (see the \dotfile
  2209 # command).
  2210 # This tag requires that the tag HAVE_DOT is set to YES.
  2212 DOTFILE_DIRS           =
  2214 # The MSCFILE_DIRS tag can be used to specify one or more directories that
  2215 # contain msc files that are included in the documentation (see the \mscfile
  2216 # command).
  2218 MSCFILE_DIRS           =
  2220 # The DIAFILE_DIRS tag can be used to specify one or more directories that
  2221 # contain dia files that are included in the documentation (see the \diafile
  2222 # command).
  2224 DIAFILE_DIRS           =
  2226 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2227 # that will be shown in the graph. If the number of nodes in a graph becomes
  2228 # larger than this value, doxygen will truncate the graph, which is visualized
  2229 # by representing a node as a red box. Note that doxygen if the number of direct
  2230 # children of the root node in a graph is already larger than
  2231 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  2232 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2233 # Minimum value: 0, maximum value: 10000, default value: 50.
  2234 # This tag requires that the tag HAVE_DOT is set to YES.
  2236 DOT_GRAPH_MAX_NODES    = 50
  2238 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  2239 # generated by dot. A depth value of 3 means that only nodes reachable from the
  2240 # root by following a path via at most 3 edges will be shown. Nodes that lay
  2241 # further from the root node will be omitted. Note that setting this option to 1
  2242 # or 2 may greatly reduce the computation time needed for large code bases. Also
  2243 # note that the size of a graph can be further restricted by
  2244 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  2245 # Minimum value: 0, maximum value: 1000, default value: 0.
  2246 # This tag requires that the tag HAVE_DOT is set to YES.
  2248 MAX_DOT_GRAPH_DEPTH    = 0
  2250 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2251 # background. This is disabled by default, because dot on Windows does not seem
  2252 # to support this out of the box.
  2254 # Warning: Depending on the platform used, enabling this option may lead to
  2255 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2256 # read).
  2257 # The default value is: NO.
  2258 # This tag requires that the tag HAVE_DOT is set to YES.
  2260 DOT_TRANSPARENT        = NO
  2262 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  2263 # files in one run (i.e. multiple -o and -T options on the command line). This
  2264 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2265 # this, this feature is disabled by default.
  2266 # The default value is: NO.
  2267 # This tag requires that the tag HAVE_DOT is set to YES.
  2269 DOT_MULTI_TARGETS      = YES
  2271 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2272 # explaining the meaning of the various boxes and arrows in the dot generated
  2273 # graphs.
  2274 # The default value is: YES.
  2275 # This tag requires that the tag HAVE_DOT is set to YES.
  2277 GENERATE_LEGEND        = YES
  2279 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
  2280 # files that are used to generate the various graphs.
  2281 # The default value is: YES.
  2282 # This tag requires that the tag HAVE_DOT is set to YES.
  2284 DOT_CLEANUP            = YES

mercurial