Doxyfile

Mon, 14 May 2018 13:15:32 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 14 May 2018 13:15:32 +0200
changeset 304
1f9237cfeb26
parent 266
33d229634809
child 462
1bcf7c8d4b47
permissions
-rw-r--r--

fixes typo in modules.md

     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           = ./uaplogo.png
    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       = docs
    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 # This tag can be used to specify a number of word-keyword mappings (TCL only).
   234 # A mapping has the form "name=value". For example adding "class=itcl::class"
   235 # will allow you to use the command class in the itcl::class meaning.
   237 TCL_SUBST              =
   239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
   240 # only. Doxygen will then generate output that is more tailored for C. For
   241 # instance, some of the names that are used will be different. The list of all
   242 # members will be omitted, etc.
   243 # The default value is: NO.
   245 OPTIMIZE_OUTPUT_FOR_C  = YES
   247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
   248 # Python sources only. Doxygen will then generate output that is more tailored
   249 # for that language. For instance, namespaces will be presented as packages,
   250 # qualified scopes will look different, etc.
   251 # The default value is: NO.
   253 OPTIMIZE_OUTPUT_JAVA   = NO
   255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
   256 # sources. Doxygen will then generate output that is tailored for Fortran.
   257 # The default value is: NO.
   259 OPTIMIZE_FOR_FORTRAN   = NO
   261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
   262 # sources. Doxygen will then generate output that is tailored for VHDL.
   263 # The default value is: NO.
   265 OPTIMIZE_OUTPUT_VHDL   = NO
   267 # Doxygen selects the parser to use depending on the extension of the files it
   268 # parses. With this tag you can assign which parser to use for a given
   269 # extension. Doxygen has a built-in mapping, but you can override or extend it
   270 # using this tag. The format is ext=language, where ext is a file extension, and
   271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
   272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
   273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
   274 # Fortran. In the later case the parser tries to guess whether the code is fixed
   275 # or free formatted code, this is the default for Fortran type files), VHDL. For
   276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
   277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
   278 #
   279 # Note For files without extension you can use no_extension as a placeholder.
   280 #
   281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
   282 # the files are not read by doxygen.
   284 EXTENSION_MAPPING      =
   286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
   287 # according to the Markdown format, which allows for more readable
   288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
   289 # The output of markdown processing is further processed by doxygen, so you can
   290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
   291 # case of backward compatibilities issues.
   292 # The default value is: YES.
   294 MARKDOWN_SUPPORT       = YES
   296 # When enabled doxygen tries to link words that correspond to documented
   297 # classes, or namespaces to their corresponding documentation. Such a link can
   298 # be prevented in individual cases by by putting a % sign in front of the word
   299 # or globally by setting AUTOLINK_SUPPORT to NO.
   300 # The default value is: YES.
   302 AUTOLINK_SUPPORT       = YES
   304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
   305 # to include (a tag file for) the STL sources as input, then you should set this
   306 # tag to YES in order to let doxygen match functions declarations and
   307 # definitions whose arguments contain STL classes (e.g. func(std::string);
   308 # versus func(std::string) {}). This also make the inheritance and collaboration
   309 # diagrams that involve STL classes more complete and accurate.
   310 # The default value is: NO.
   312 BUILTIN_STL_SUPPORT    = NO
   314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
   315 # enable parsing support.
   316 # The default value is: NO.
   318 CPP_CLI_SUPPORT        = NO
   320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
   321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
   322 # will parse them like normal C++ but will assume all classes use public instead
   323 # of private inheritance when no explicit protection keyword is present.
   324 # The default value is: NO.
   326 SIP_SUPPORT            = NO
   328 # For Microsoft's IDL there are propget and propput attributes to indicate
   329 # getter and setter methods for a property. Setting this option to YES will make
   330 # doxygen to replace the get and set methods by a property in the documentation.
   331 # This will only work if the methods are indeed getting or setting a simple
   332 # type. If this is not the case, or you want to show the methods anyway, you
   333 # should set this option to NO.
   334 # The default value is: YES.
   336 IDL_PROPERTY_SUPPORT   = YES
   338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
   339 # tag is set to YES, then doxygen will reuse the documentation of the first
   340 # member in the group (if any) for the other members of the group. By default
   341 # all members of a group must be documented explicitly.
   342 # The default value is: NO.
   344 DISTRIBUTE_GROUP_DOC   = NO
   346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
   347 # (for instance a group of public functions) to be put as a subgroup of that
   348 # type (e.g. under the Public Functions section). Set it to NO to prevent
   349 # subgrouping. Alternatively, this can be done per class using the
   350 # \nosubgrouping command.
   351 # The default value is: YES.
   353 SUBGROUPING            = YES
   355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
   356 # are shown inside the group in which they are included (e.g. using \ingroup)
   357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
   358 # and RTF).
   359 #
   360 # Note that this feature does not work in combination with
   361 # SEPARATE_MEMBER_PAGES.
   362 # The default value is: NO.
   364 INLINE_GROUPED_CLASSES = NO
   366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
   367 # with only public data fields or simple typedef fields will be shown inline in
   368 # the documentation of the scope in which they are defined (i.e. file,
   369 # namespace, or group documentation), provided this scope is documented. If set
   370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
   371 # Man pages) or section (for LaTeX and RTF).
   372 # The default value is: NO.
   374 INLINE_SIMPLE_STRUCTS  = NO
   376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
   377 # enum is documented as struct, union, or enum with the name of the typedef. So
   378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
   379 # with name TypeT. When disabled the typedef will appear as a member of a file,
   380 # namespace, or class. And the struct will be named TypeS. This can typically be
   381 # useful for C code in case the coding convention dictates that all compound
   382 # types are typedef'ed and only the typedef is referenced, never the tag name.
   383 # The default value is: NO.
   385 TYPEDEF_HIDES_STRUCT   = NO
   387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
   388 # cache is used to resolve symbols given their name and scope. Since this can be
   389 # an expensive process and often the same symbol appears multiple times in the
   390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
   391 # doxygen will become slower. If the cache is too large, memory is wasted. The
   392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
   393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
   394 # symbols. At the end of a run doxygen will report the cache usage and suggest
   395 # the optimal cache size from a speed point of view.
   396 # Minimum value: 0, maximum value: 9, default value: 0.
   398 LOOKUP_CACHE_SIZE      = 0
   400 #---------------------------------------------------------------------------
   401 # Build related configuration options
   402 #---------------------------------------------------------------------------
   404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
   405 # documentation are documented, even if no documentation was available. Private
   406 # class members and static file members will be hidden unless the
   407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
   408 # Note: This will also disable the warnings about undocumented members that are
   409 # normally produced when WARNINGS is set to YES.
   410 # The default value is: NO.
   412 EXTRACT_ALL            = NO
   414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
   415 # be included in the documentation.
   416 # The default value is: NO.
   418 EXTRACT_PRIVATE        = NO
   420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
   421 # scope will be included in the documentation.
   422 # The default value is: NO.
   424 EXTRACT_PACKAGE        = NO
   426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
   427 # included in the documentation.
   428 # The default value is: NO.
   430 EXTRACT_STATIC         = NO
   432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
   433 # locally in source files will be included in the documentation. If set to NO
   434 # only classes defined in header files are included. Does not have any effect
   435 # for Java sources.
   436 # The default value is: YES.
   438 EXTRACT_LOCAL_CLASSES  = YES
   440 # This flag is only useful for Objective-C code. When set to YES local methods,
   441 # which are defined in the implementation section but not in the interface are
   442 # included in the documentation. If set to NO only methods in the interface are
   443 # included.
   444 # The default value is: NO.
   446 EXTRACT_LOCAL_METHODS  = NO
   448 # If this flag is set to YES, the members of anonymous namespaces will be
   449 # extracted and appear in the documentation as a namespace called
   450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
   451 # the file that contains the anonymous namespace. By default anonymous namespace
   452 # are hidden.
   453 # The default value is: NO.
   455 EXTRACT_ANON_NSPACES   = NO
   457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
   458 # undocumented members inside documented classes or files. If set to NO these
   459 # members will be included in the various overviews, but no documentation
   460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
   461 # The default value is: NO.
   463 HIDE_UNDOC_MEMBERS     = NO
   465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
   466 # undocumented classes that are normally visible in the class hierarchy. If set
   467 # to NO these classes will be included in the various overviews. This option has
   468 # no effect if EXTRACT_ALL is enabled.
   469 # The default value is: NO.
   471 HIDE_UNDOC_CLASSES     = NO
   473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
   474 # (class|struct|union) declarations. If set to NO these declarations will be
   475 # included in the documentation.
   476 # The default value is: NO.
   478 HIDE_FRIEND_COMPOUNDS  = NO
   480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
   481 # documentation blocks found inside the body of a function. If set to NO these
   482 # blocks will be appended to the function's detailed documentation block.
   483 # The default value is: NO.
   485 HIDE_IN_BODY_DOCS      = NO
   487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
   488 # \internal command is included. If the tag is set to NO then the documentation
   489 # will be excluded. Set it to YES to include the internal documentation.
   490 # The default value is: NO.
   492 INTERNAL_DOCS          = NO
   494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
   495 # names in lower-case letters. If set to YES upper-case letters are also
   496 # allowed. This is useful if you have classes or files whose names only differ
   497 # in case and if your file system supports case sensitive file names. Windows
   498 # and Mac users are advised to set this option to NO.
   499 # The default value is: system dependent.
   501 CASE_SENSE_NAMES       = YES
   503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
   504 # their full class and namespace scopes in the documentation. If set to YES the
   505 # scope will be hidden.
   506 # The default value is: NO.
   508 HIDE_SCOPE_NAMES       = NO
   510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
   511 # the files that are included by a file in the documentation of that file.
   512 # The default value is: YES.
   514 SHOW_INCLUDE_FILES     = YES
   516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
   517 # grouped member an include statement to the documentation, telling the reader
   518 # which file to include in order to use the member.
   519 # The default value is: NO.
   521 SHOW_GROUPED_MEMB_INC  = NO
   523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
   524 # files with double quotes in the documentation rather than with sharp brackets.
   525 # The default value is: NO.
   527 FORCE_LOCAL_INCLUDES   = NO
   529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
   530 # documentation for inline members.
   531 # The default value is: YES.
   533 INLINE_INFO            = YES
   535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
   536 # (detailed) documentation of file and class members alphabetically by member
   537 # name. If set to NO the members will appear in declaration order.
   538 # The default value is: YES.
   540 SORT_MEMBER_DOCS       = YES
   542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
   543 # descriptions of file, namespace and class members alphabetically by member
   544 # name. If set to NO the members will appear in declaration order. Note that
   545 # this will also influence the order of the classes in the class list.
   546 # The default value is: NO.
   548 SORT_BRIEF_DOCS        = NO
   550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
   551 # (brief and detailed) documentation of class members so that constructors and
   552 # destructors are listed first. If set to NO the constructors will appear in the
   553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
   554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
   555 # member documentation.
   556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
   557 # detailed member documentation.
   558 # The default value is: NO.
   560 SORT_MEMBERS_CTORS_1ST = NO
   562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
   563 # of group names into alphabetical order. If set to NO the group names will
   564 # appear in their defined order.
   565 # The default value is: NO.
   567 SORT_GROUP_NAMES       = NO
   569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
   570 # fully-qualified names, including namespaces. If set to NO, the class list will
   571 # be sorted only by class name, not including the namespace part.
   572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
   573 # Note: This option applies only to the class list, not to the alphabetical
   574 # list.
   575 # The default value is: NO.
   577 SORT_BY_SCOPE_NAME     = NO
   579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
   580 # type resolution of all parameters of a function it will reject a match between
   581 # the prototype and the implementation of a member function even if there is
   582 # only one candidate or it is obvious which candidate to choose by doing a
   583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
   584 # accept a match between prototype and implementation in such cases.
   585 # The default value is: NO.
   587 STRICT_PROTO_MATCHING  = NO
   589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
   590 # todo list. This list is created by putting \todo commands in the
   591 # documentation.
   592 # The default value is: YES.
   594 GENERATE_TODOLIST      = YES
   596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
   597 # test list. This list is created by putting \test commands in the
   598 # documentation.
   599 # The default value is: YES.
   601 GENERATE_TESTLIST      = YES
   603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
   604 # list. This list is created by putting \bug commands in the documentation.
   605 # The default value is: YES.
   607 GENERATE_BUGLIST       = YES
   609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
   610 # the deprecated list. This list is created by putting \deprecated commands in
   611 # the documentation.
   612 # The default value is: YES.
   614 GENERATE_DEPRECATEDLIST= YES
   616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
   617 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
   618 # ... \endcond blocks.
   620 ENABLED_SECTIONS       =
   622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
   623 # initial value of a variable or macro / define can have for it to appear in the
   624 # documentation. If the initializer consists of more lines than specified here
   625 # it will be hidden. Use a value of 0 to hide initializers completely. The
   626 # appearance of the value of individual variables and macros / defines can be
   627 # controlled using \showinitializer or \hideinitializer command in the
   628 # documentation regardless of this setting.
   629 # Minimum value: 0, maximum value: 10000, default value: 30.
   631 MAX_INITIALIZER_LINES  = 30
   633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
   634 # the bottom of the documentation of classes and structs. If set to YES the list
   635 # will mention the files that were used to generate the documentation.
   636 # The default value is: YES.
   638 SHOW_USED_FILES        = YES
   640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
   641 # will remove the Files entry from the Quick Index and from the Folder Tree View
   642 # (if specified).
   643 # The default value is: YES.
   645 SHOW_FILES             = YES
   647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
   648 # page. This will remove the Namespaces entry from the Quick Index and from the
   649 # Folder Tree View (if specified).
   650 # The default value is: YES.
   652 SHOW_NAMESPACES        = YES
   654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
   655 # doxygen should invoke to get the current version for each file (typically from
   656 # the version control system). Doxygen will invoke the program by executing (via
   657 # popen()) the command command input-file, where command is the value of the
   658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
   659 # by doxygen. Whatever the program writes to standard output is used as the file
   660 # version. For an example see the documentation.
   662 FILE_VERSION_FILTER    =
   664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
   665 # by doxygen. The layout file controls the global structure of the generated
   666 # output files in an output format independent way. To create the layout file
   667 # that represents doxygen's defaults, run doxygen with the -l option. You can
   668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
   669 # will be used as the name of the layout file.
   670 #
   671 # Note that if you run doxygen from a directory containing a file called
   672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
   673 # tag is left empty.
   675 LAYOUT_FILE            =
   677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
   678 # the reference definitions. This must be a list of .bib files. The .bib
   679 # extension is automatically appended if omitted. This requires the bibtex tool
   680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
   681 # For LaTeX the style of the bibliography can be controlled using
   682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
   683 # search path. Do not use file names with spaces, bibtex cannot handle them. See
   684 # also \cite for info how to create references.
   686 CITE_BIB_FILES         =
   688 #---------------------------------------------------------------------------
   689 # Configuration options related to warning and progress messages
   690 #---------------------------------------------------------------------------
   692 # The QUIET tag can be used to turn on/off the messages that are generated to
   693 # standard output by doxygen. If QUIET is set to YES this implies that the
   694 # messages are off.
   695 # The default value is: NO.
   697 QUIET                  = NO
   699 # The WARNINGS tag can be used to turn on/off the warning messages that are
   700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
   701 # this implies that the warnings are on.
   702 #
   703 # Tip: Turn warnings on while writing the documentation.
   704 # The default value is: YES.
   706 WARNINGS               = YES
   708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
   709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
   710 # will automatically be disabled.
   711 # The default value is: YES.
   713 WARN_IF_UNDOCUMENTED   = YES
   715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
   716 # potential errors in the documentation, such as not documenting some parameters
   717 # in a documented function, or documenting parameters that don't exist or using
   718 # markup commands wrongly.
   719 # The default value is: YES.
   721 WARN_IF_DOC_ERROR      = YES
   723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
   724 # are documented, but have no documentation for their parameters or return
   725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
   726 # documentation, but not about the absence of documentation.
   727 # The default value is: NO.
   729 WARN_NO_PARAMDOC       = YES
   731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
   732 # can produce. The string should contain the $file, $line, and $text tags, which
   733 # will be replaced by the file and line number from which the warning originated
   734 # and the warning text. Optionally the format may contain $version, which will
   735 # be replaced by the version of the file (if it could be obtained via
   736 # FILE_VERSION_FILTER)
   737 # The default value is: $file:$line: $text.
   739 WARN_FORMAT            = "$file:$line: $text"
   741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
   742 # messages should be written. If left blank the output is written to standard
   743 # error (stderr).
   745 WARN_LOGFILE           =
   747 #---------------------------------------------------------------------------
   748 # Configuration options related to the input files
   749 #---------------------------------------------------------------------------
   751 # The INPUT tag is used to specify the files and/or directories that contain
   752 # documented source files. You may enter file names like myfile.cpp or
   753 # directories like /usr/src/myproject. Separate the files or directories with
   754 # spaces.
   755 # Note: If this tag is empty the current directory is searched.
   757 INPUT                  = ./src
   759 # This tag can be used to specify the character encoding of the source files
   760 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
   761 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
   762 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
   763 # possible encodings.
   764 # The default value is: UTF-8.
   766 INPUT_ENCODING         = UTF-8
   768 # If the value of the INPUT tag contains directories, you can use the
   769 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
   770 # *.h) to filter out the source-files in the directories. If left blank the
   771 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
   772 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
   773 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
   774 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
   775 # *.qsf, *.as and *.js.
   777 FILE_PATTERNS          =
   779 # The RECURSIVE tag can be used to specify whether or not subdirectories should
   780 # be searched for input files as well.
   781 # The default value is: NO.
   783 RECURSIVE              = YES
   785 # The EXCLUDE tag can be used to specify files and/or directories that should be
   786 # excluded from the INPUT source files. This way you can easily exclude a
   787 # subdirectory from a directory tree whose root is specified with the INPUT tag.
   788 #
   789 # Note that relative paths are relative to the directory from which doxygen is
   790 # run.
   792 EXCLUDE                =
   794 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
   795 # directories that are symbolic links (a Unix file system feature) are excluded
   796 # from the input.
   797 # The default value is: NO.
   799 EXCLUDE_SYMLINKS       = NO
   801 # If the value of the INPUT tag contains directories, you can use the
   802 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
   803 # certain files from those directories.
   804 #
   805 # Note that the wildcards are matched against the file with absolute path, so to
   806 # exclude all test directories for example use the pattern */test/*
   808 EXCLUDE_PATTERNS       =
   810 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
   811 # (namespaces, classes, functions, etc.) that should be excluded from the
   812 # output. The symbol name can be a fully qualified name, a word, or if the
   813 # wildcard * is used, a substring. Examples: ANamespace, AClass,
   814 # AClass::ANamespace, ANamespace::*Test
   815 #
   816 # Note that the wildcards are matched against the file with absolute path, so to
   817 # exclude all test directories use the pattern */test/*
   819 EXCLUDE_SYMBOLS        =
   821 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
   822 # that contain example code fragments that are included (see the \include
   823 # command).
   825 EXAMPLE_PATH           =
   827 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
   828 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
   829 # *.h) to filter out the source-files in the directories. If left blank all
   830 # files are included.
   832 EXAMPLE_PATTERNS       =
   834 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
   835 # searched for input files to be used with the \include or \dontinclude commands
   836 # irrespective of the value of the RECURSIVE tag.
   837 # The default value is: NO.
   839 EXAMPLE_RECURSIVE      = NO
   841 # The IMAGE_PATH tag can be used to specify one or more files or directories
   842 # that contain images that are to be included in the documentation (see the
   843 # \image command).
   845 IMAGE_PATH             =
   847 # The INPUT_FILTER tag can be used to specify a program that doxygen should
   848 # invoke to filter for each input file. Doxygen will invoke the filter program
   849 # by executing (via popen()) the command:
   850 #
   851 # <filter> <input-file>
   852 #
   853 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
   854 # name of an input file. Doxygen will then use the output that the filter
   855 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
   856 # will be ignored.
   857 #
   858 # Note that the filter must not add or remove lines; it is applied before the
   859 # code is scanned, but not when the output code is generated. If lines are added
   860 # or removed, the anchors will not be placed correctly.
   862 INPUT_FILTER           =
   864 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
   865 # basis. Doxygen will compare the file name with each pattern and apply the
   866 # filter if there is a match. The filters are a list of the form: pattern=filter
   867 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
   868 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
   869 # patterns match the file name, INPUT_FILTER is applied.
   871 FILTER_PATTERNS        =
   873 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
   874 # INPUT_FILTER ) will also be used to filter the input files that are used for
   875 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
   876 # The default value is: NO.
   878 FILTER_SOURCE_FILES    = NO
   880 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
   881 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
   882 # it is also possible to disable source filtering for a specific pattern using
   883 # *.ext= (so without naming a filter).
   884 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
   886 FILTER_SOURCE_PATTERNS =
   888 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
   889 # is part of the input, its contents will be placed on the main page
   890 # (index.html). This can be useful if you have a project on for instance GitHub
   891 # and want to reuse the introduction page also for the doxygen output.
   893 USE_MDFILE_AS_MAINPAGE =
   895 #---------------------------------------------------------------------------
   896 # Configuration options related to source browsing
   897 #---------------------------------------------------------------------------
   899 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
   900 # generated. Documented entities will be cross-referenced with these sources.
   901 #
   902 # Note: To get rid of all source code in the generated output, make sure that
   903 # also VERBATIM_HEADERS is set to NO.
   904 # The default value is: NO.
   906 SOURCE_BROWSER         = NO
   908 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
   909 # classes and enums directly into the documentation.
   910 # The default value is: NO.
   912 INLINE_SOURCES         = NO
   914 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
   915 # special comment blocks from generated source code fragments. Normal C, C++ and
   916 # Fortran comments will always remain visible.
   917 # The default value is: YES.
   919 STRIP_CODE_COMMENTS    = YES
   921 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
   922 # function all documented functions referencing it will be listed.
   923 # The default value is: NO.
   925 REFERENCED_BY_RELATION = NO
   927 # If the REFERENCES_RELATION tag is set to YES then for each documented function
   928 # all documented entities called/used by that function will be listed.
   929 # The default value is: NO.
   931 REFERENCES_RELATION    = NO
   933 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
   934 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
   935 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
   936 # link to the documentation.
   937 # The default value is: YES.
   939 REFERENCES_LINK_SOURCE = YES
   941 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
   942 # source code will show a tooltip with additional information such as prototype,
   943 # brief description and links to the definition and documentation. Since this
   944 # will make the HTML file larger and loading of large files a bit slower, you
   945 # can opt to disable this feature.
   946 # The default value is: YES.
   947 # This tag requires that the tag SOURCE_BROWSER is set to YES.
   949 SOURCE_TOOLTIPS        = YES
   951 # If the USE_HTAGS tag is set to YES then the references to source code will
   952 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
   953 # source browser. The htags tool is part of GNU's global source tagging system
   954 # (see http://www.gnu.org/software/global/global.html). You will need version
   955 # 4.8.6 or higher.
   956 #
   957 # To use it do the following:
   958 # - Install the latest version of global
   959 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
   960 # - Make sure the INPUT points to the root of the source tree
   961 # - Run doxygen as normal
   962 #
   963 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
   964 # tools must be available from the command line (i.e. in the search path).
   965 #
   966 # The result: instead of the source browser generated by doxygen, the links to
   967 # source code will now point to the output of htags.
   968 # The default value is: NO.
   969 # This tag requires that the tag SOURCE_BROWSER is set to YES.
   971 USE_HTAGS              = NO
   973 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
   974 # verbatim copy of the header file for each class for which an include is
   975 # specified. Set to NO to disable this.
   976 # See also: Section \class.
   977 # The default value is: YES.
   979 VERBATIM_HEADERS       = YES
   981 #---------------------------------------------------------------------------
   982 # Configuration options related to the alphabetical class index
   983 #---------------------------------------------------------------------------
   985 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
   986 # compounds will be generated. Enable this if the project contains a lot of
   987 # classes, structs, unions or interfaces.
   988 # The default value is: YES.
   990 ALPHABETICAL_INDEX     = YES
   992 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
   993 # which the alphabetical index list will be split.
   994 # Minimum value: 1, maximum value: 20, default value: 5.
   995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
   997 COLS_IN_ALPHA_INDEX    = 5
   999 # In case all classes in a project start with a common prefix, all classes will
  1000 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  1001 # can be used to specify a prefix (or a list of prefixes) that should be ignored
  1002 # while generating the index headers.
  1003 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  1005 IGNORE_PREFIX          =
  1007 #---------------------------------------------------------------------------
  1008 # Configuration options related to the HTML output
  1009 #---------------------------------------------------------------------------
  1011 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
  1012 # The default value is: YES.
  1014 GENERATE_HTML          = YES
  1016 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  1017 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1018 # it.
  1019 # The default directory is: html.
  1020 # This tag requires that the tag GENERATE_HTML is set to YES.
  1022 HTML_OUTPUT            = web/api
  1024 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  1025 # generated HTML page (for example: .htm, .php, .asp).
  1026 # The default value is: .html.
  1027 # This tag requires that the tag GENERATE_HTML is set to YES.
  1029 HTML_FILE_EXTENSION    = .html
  1031 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  1032 # each generated HTML page. If the tag is left blank doxygen will generate a
  1033 # standard header.
  1035 # To get valid HTML the header file that includes any scripts and style sheets
  1036 # that doxygen needs, which is dependent on the configuration options used (e.g.
  1037 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  1038 # default header using
  1039 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  1040 # YourConfigFile
  1041 # and then modify the file new_header.html. See also section "Doxygen usage"
  1042 # for information on how to generate the default header that doxygen normally
  1043 # uses.
  1044 # Note: The header is subject to change so you typically have to regenerate the
  1045 # default header when upgrading to a newer version of doxygen. For a description
  1046 # of the possible markers and block names see the documentation.
  1047 # This tag requires that the tag GENERATE_HTML is set to YES.
  1049 HTML_HEADER            =
  1051 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  1052 # generated HTML page. If the tag is left blank doxygen will generate a standard
  1053 # footer. See HTML_HEADER for more information on how to generate a default
  1054 # footer and what special commands can be used inside the footer. See also
  1055 # section "Doxygen usage" for information on how to generate the default footer
  1056 # that doxygen normally uses.
  1057 # This tag requires that the tag GENERATE_HTML is set to YES.
  1059 HTML_FOOTER            =
  1061 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  1062 # sheet that is used by each HTML page. It can be used to fine-tune the look of
  1063 # the HTML output. If left blank doxygen will generate a default style sheet.
  1064 # See also section "Doxygen usage" for information on how to generate the style
  1065 # sheet that doxygen normally uses.
  1066 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  1067 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  1068 # obsolete.
  1069 # This tag requires that the tag GENERATE_HTML is set to YES.
  1071 HTML_STYLESHEET        =
  1073 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
  1074 # defined cascading style sheet that is included after the standard style sheets
  1075 # created by doxygen. Using this option one can overrule certain style aspects.
  1076 # This is preferred over using HTML_STYLESHEET since it does not replace the
  1077 # standard style sheet and is therefor more robust against future updates.
  1078 # Doxygen will copy the style sheet file to the output directory. For an example
  1079 # see the documentation.
  1080 # This tag requires that the tag GENERATE_HTML is set to YES.
  1082 HTML_EXTRA_STYLESHEET  =
  1084 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  1085 # other source files which should be copied to the HTML output directory. Note
  1086 # that these files will be copied to the base HTML output directory. Use the
  1087 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  1088 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  1089 # files will be copied as-is; there are no commands or markers available.
  1090 # This tag requires that the tag GENERATE_HTML is set to YES.
  1092 HTML_EXTRA_FILES       =
  1094 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  1095 # will adjust the colors in the stylesheet and background images according to
  1096 # this color. Hue is specified as an angle on a colorwheel, see
  1097 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  1098 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  1099 # purple, and 360 is red again.
  1100 # Minimum value: 0, maximum value: 359, default value: 220.
  1101 # This tag requires that the tag GENERATE_HTML is set to YES.
  1103 HTML_COLORSTYLE_HUE    = 220
  1105 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  1106 # in the HTML output. For a value of 0 the output will use grayscales only. A
  1107 # value of 255 will produce the most vivid colors.
  1108 # Minimum value: 0, maximum value: 255, default value: 100.
  1109 # This tag requires that the tag GENERATE_HTML is set to YES.
  1111 HTML_COLORSTYLE_SAT    = 100
  1113 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  1114 # luminance component of the colors in the HTML output. Values below 100
  1115 # gradually make the output lighter, whereas values above 100 make the output
  1116 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  1117 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  1118 # change the gamma.
  1119 # Minimum value: 40, maximum value: 240, default value: 80.
  1120 # This tag requires that the tag GENERATE_HTML is set to YES.
  1122 HTML_COLORSTYLE_GAMMA  = 80
  1124 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  1125 # page will contain the date and time when the page was generated. Setting this
  1126 # to NO can help when comparing the output of multiple runs.
  1127 # The default value is: YES.
  1128 # This tag requires that the tag GENERATE_HTML is set to YES.
  1130 HTML_TIMESTAMP         = YES
  1132 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  1133 # documentation will contain sections that can be hidden and shown after the
  1134 # page has loaded.
  1135 # The default value is: NO.
  1136 # This tag requires that the tag GENERATE_HTML is set to YES.
  1138 HTML_DYNAMIC_SECTIONS  = NO
  1140 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1141 # shown in the various tree structured indices initially; the user can expand
  1142 # and collapse entries dynamically later on. Doxygen will expand the tree to
  1143 # such a level that at most the specified number of entries are visible (unless
  1144 # a fully collapsed tree already exceeds this amount). So setting the number of
  1145 # entries 1 will produce a full collapsed tree by default. 0 is a special value
  1146 # representing an infinite number of entries and will result in a full expanded
  1147 # tree by default.
  1148 # Minimum value: 0, maximum value: 9999, default value: 100.
  1149 # This tag requires that the tag GENERATE_HTML is set to YES.
  1151 HTML_INDEX_NUM_ENTRIES = 100
  1153 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1154 # generated that can be used as input for Apple's Xcode 3 integrated development
  1155 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
  1156 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  1157 # Makefile in the HTML output directory. Running make will produce the docset in
  1158 # that directory and running make install will install the docset in
  1159 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1160 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  1161 # for more information.
  1162 # The default value is: NO.
  1163 # This tag requires that the tag GENERATE_HTML is set to YES.
  1165 GENERATE_DOCSET        = NO
  1167 # This tag determines the name of the docset feed. A documentation feed provides
  1168 # an umbrella under which multiple documentation sets from a single provider
  1169 # (such as a company or product suite) can be grouped.
  1170 # The default value is: Doxygen generated docs.
  1171 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1173 DOCSET_FEEDNAME        = "Doxygen generated docs"
  1175 # This tag specifies a string that should uniquely identify the documentation
  1176 # set bundle. This should be a reverse domain-name style string, e.g.
  1177 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1178 # The default value is: org.doxygen.Project.
  1179 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1181 DOCSET_BUNDLE_ID       = org.doxygen.Project
  1183 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1184 # the documentation publisher. This should be a reverse domain-name style
  1185 # string, e.g. com.mycompany.MyDocSet.documentation.
  1186 # The default value is: org.doxygen.Publisher.
  1187 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1189 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
  1191 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1192 # The default value is: Publisher.
  1193 # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1195 DOCSET_PUBLISHER_NAME  = Publisher
  1197 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1198 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1199 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1200 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1201 # Windows.
  1203 # The HTML Help Workshop contains a compiler that can convert all HTML output
  1204 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1205 # files are now used as the Windows 98 help format, and will replace the old
  1206 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1207 # HTML files also contain an index, a table of contents, and you can search for
  1208 # words in the documentation. The HTML workshop also contains a viewer for
  1209 # compressed HTML files.
  1210 # The default value is: NO.
  1211 # This tag requires that the tag GENERATE_HTML is set to YES.
  1213 GENERATE_HTMLHELP      = NO
  1215 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1216 # file. You can add a path in front of the file if the result should not be
  1217 # written to the html output directory.
  1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1220 CHM_FILE               =
  1222 # The HHC_LOCATION tag can be used to specify the location (absolute path
  1223 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
  1224 # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1225 # The file has to be specified with full path.
  1226 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1228 HHC_LOCATION           =
  1230 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
  1231 # YES) or that it should be included in the master .chm file ( NO).
  1232 # The default value is: NO.
  1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1235 GENERATE_CHI           = NO
  1237 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
  1238 # and project file content.
  1239 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1241 CHM_INDEX_ENCODING     =
  1243 # The BINARY_TOC flag controls whether a binary table of contents is generated (
  1244 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
  1245 # enables the Previous and Next buttons.
  1246 # The default value is: NO.
  1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1249 BINARY_TOC             = NO
  1251 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1252 # the table of contents of the HTML help documentation and to the tree view.
  1253 # The default value is: NO.
  1254 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1256 TOC_EXPAND             = NO
  1258 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1259 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1260 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1261 # (.qch) of the generated HTML documentation.
  1262 # The default value is: NO.
  1263 # This tag requires that the tag GENERATE_HTML is set to YES.
  1265 GENERATE_QHP           = NO
  1267 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1268 # the file name of the resulting .qch file. The path specified is relative to
  1269 # the HTML output folder.
  1270 # This tag requires that the tag GENERATE_QHP is set to YES.
  1272 QCH_FILE               =
  1274 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1275 # Project output. For more information please see Qt Help Project / Namespace
  1276 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1277 # The default value is: org.doxygen.Project.
  1278 # This tag requires that the tag GENERATE_QHP is set to YES.
  1280 QHP_NAMESPACE          = org.doxygen.Project
  1282 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1283 # Help Project output. For more information please see Qt Help Project / Virtual
  1284 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1285 # folders).
  1286 # The default value is: doc.
  1287 # This tag requires that the tag GENERATE_QHP is set to YES.
  1289 QHP_VIRTUAL_FOLDER     = doc
  1291 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1292 # filter to add. For more information please see Qt Help Project / Custom
  1293 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1294 # filters).
  1295 # This tag requires that the tag GENERATE_QHP is set to YES.
  1297 QHP_CUST_FILTER_NAME   =
  1299 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1300 # custom filter to add. For more information please see Qt Help Project / Custom
  1301 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1302 # filters).
  1303 # This tag requires that the tag GENERATE_QHP is set to YES.
  1305 QHP_CUST_FILTER_ATTRS  =
  1307 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1308 # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1309 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1310 # This tag requires that the tag GENERATE_QHP is set to YES.
  1312 QHP_SECT_FILTER_ATTRS  =
  1314 # The QHG_LOCATION tag can be used to specify the location of Qt's
  1315 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1316 # generated .qhp file.
  1317 # This tag requires that the tag GENERATE_QHP is set to YES.
  1319 QHG_LOCATION           =
  1321 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1322 # generated, together with the HTML files, they form an Eclipse help plugin. To
  1323 # install this plugin and make it available under the help contents menu in
  1324 # Eclipse, the contents of the directory containing the HTML and XML files needs
  1325 # to be copied into the plugins directory of eclipse. The name of the directory
  1326 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1327 # After copying Eclipse needs to be restarted before the help appears.
  1328 # The default value is: NO.
  1329 # This tag requires that the tag GENERATE_HTML is set to YES.
  1331 GENERATE_ECLIPSEHELP   = NO
  1333 # A unique identifier for the Eclipse help plugin. When installing the plugin
  1334 # the directory name containing the HTML and XML files should also have this
  1335 # name. Each documentation set should have its own identifier.
  1336 # The default value is: org.doxygen.Project.
  1337 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1339 ECLIPSE_DOC_ID         = org.doxygen.Project
  1341 # If you want full control over the layout of the generated HTML pages it might
  1342 # be necessary to disable the index and replace it with your own. The
  1343 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1344 # of each HTML page. A value of NO enables the index and the value YES disables
  1345 # it. Since the tabs in the index contain the same information as the navigation
  1346 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1347 # The default value is: NO.
  1348 # This tag requires that the tag GENERATE_HTML is set to YES.
  1350 DISABLE_INDEX          = NO
  1352 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1353 # structure should be generated to display hierarchical information. If the tag
  1354 # value is set to YES, a side panel will be generated containing a tree-like
  1355 # index structure (just like the one that is generated for HTML Help). For this
  1356 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1357 # (i.e. any modern browser). Windows users are probably better off using the
  1358 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
  1359 # further fine-tune the look of the index. As an example, the default style
  1360 # sheet generated by doxygen has an example that shows how to put an image at
  1361 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1362 # the same information as the tab index, you could consider setting
  1363 # DISABLE_INDEX to YES when enabling this option.
  1364 # The default value is: NO.
  1365 # This tag requires that the tag GENERATE_HTML is set to YES.
  1367 GENERATE_TREEVIEW      = NO
  1369 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1370 # doxygen will group on one line in the generated HTML documentation.
  1372 # Note that a value of 0 will completely suppress the enum values from appearing
  1373 # in the overview section.
  1374 # Minimum value: 0, maximum value: 20, default value: 4.
  1375 # This tag requires that the tag GENERATE_HTML is set to YES.
  1377 ENUM_VALUES_PER_LINE   = 4
  1379 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1380 # to set the initial width (in pixels) of the frame in which the tree is shown.
  1381 # Minimum value: 0, maximum value: 1500, default value: 250.
  1382 # This tag requires that the tag GENERATE_HTML is set to YES.
  1384 TREEVIEW_WIDTH         = 250
  1386 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
  1387 # external symbols imported via tag files in a separate window.
  1388 # The default value is: NO.
  1389 # This tag requires that the tag GENERATE_HTML is set to YES.
  1391 EXT_LINKS_IN_WINDOW    = NO
  1393 # Use this tag to change the font size of LaTeX formulas included as images in
  1394 # the HTML documentation. When you change the font size after a successful
  1395 # doxygen run you need to manually remove any form_*.png images from the HTML
  1396 # output directory to force them to be regenerated.
  1397 # Minimum value: 8, maximum value: 50, default value: 10.
  1398 # This tag requires that the tag GENERATE_HTML is set to YES.
  1400 FORMULA_FONTSIZE       = 10
  1402 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1403 # generated for formulas are transparent PNGs. Transparent PNGs are not
  1404 # supported properly for IE 6.0, but are supported on all modern browsers.
  1406 # Note that when changing this option you need to delete any form_*.png files in
  1407 # the HTML output directory before the changes have effect.
  1408 # The default value is: YES.
  1409 # This tag requires that the tag GENERATE_HTML is set to YES.
  1411 FORMULA_TRANSPARENT    = YES
  1413 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1414 # http://www.mathjax.org) which uses client side Javascript for the rendering
  1415 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
  1416 # installed or if you want to formulas look prettier in the HTML output. When
  1417 # enabled you may also need to install MathJax separately and configure the path
  1418 # to it using the MATHJAX_RELPATH option.
  1419 # The default value is: NO.
  1420 # This tag requires that the tag GENERATE_HTML is set to YES.
  1422 USE_MATHJAX            = NO
  1424 # When MathJax is enabled you can set the default output format to be used for
  1425 # the MathJax output. See the MathJax site (see:
  1426 # http://docs.mathjax.org/en/latest/output.html) for more details.
  1427 # Possible values are: HTML-CSS (which is slower, but has the best
  1428 # compatibility), NativeMML (i.e. MathML) and SVG.
  1429 # The default value is: HTML-CSS.
  1430 # This tag requires that the tag USE_MATHJAX is set to YES.
  1432 MATHJAX_FORMAT         = HTML-CSS
  1434 # When MathJax is enabled you need to specify the location relative to the HTML
  1435 # output directory using the MATHJAX_RELPATH option. The destination directory
  1436 # should contain the MathJax.js script. For instance, if the mathjax directory
  1437 # is located at the same level as the HTML output directory, then
  1438 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1439 # Content Delivery Network so you can quickly see the result without installing
  1440 # MathJax. However, it is strongly recommended to install a local copy of
  1441 # MathJax from http://www.mathjax.org before deployment.
  1442 # The default value is: http://cdn.mathjax.org/mathjax/latest.
  1443 # This tag requires that the tag USE_MATHJAX is set to YES.
  1445 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
  1447 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1448 # extension names that should be enabled during MathJax rendering. For example
  1449 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1450 # This tag requires that the tag USE_MATHJAX is set to YES.
  1452 MATHJAX_EXTENSIONS     =
  1454 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1455 # of code that will be used on startup of the MathJax code. See the MathJax site
  1456 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1457 # example see the documentation.
  1458 # This tag requires that the tag USE_MATHJAX is set to YES.
  1460 MATHJAX_CODEFILE       =
  1462 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1463 # the HTML output. The underlying search engine uses javascript and DHTML and
  1464 # should work on any modern browser. Note that when using HTML help
  1465 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1466 # there is already a search function so this one should typically be disabled.
  1467 # For large projects the javascript based search engine can be slow, then
  1468 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1469 # search using the keyboard; to jump to the search box use <access key> + S
  1470 # (what the <access key> is depends on the OS and browser, but it is typically
  1471 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1472 # key> to jump into the search results window, the results can be navigated
  1473 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1474 # the search. The filter options can be selected when the cursor is inside the
  1475 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1476 # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1477 # option.
  1478 # The default value is: YES.
  1479 # This tag requires that the tag GENERATE_HTML is set to YES.
  1481 SEARCHENGINE           = YES
  1483 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1484 # implemented using a web server instead of a web client using Javascript. There
  1485 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1486 # setting. When disabled, doxygen will generate a PHP script for searching and
  1487 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1488 # and searching needs to be provided by external tools. See the section
  1489 # "External Indexing and Searching" for details.
  1490 # The default value is: NO.
  1491 # This tag requires that the tag SEARCHENGINE is set to YES.
  1493 SERVER_BASED_SEARCH    = NO
  1495 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1496 # script for searching. Instead the search results are written to an XML file
  1497 # which needs to be processed by an external indexer. Doxygen will invoke an
  1498 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1499 # search results.
  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/).
  1505 # See the section "External Indexing and Searching" for details.
  1506 # The default value is: NO.
  1507 # This tag requires that the tag SEARCHENGINE is set to YES.
  1509 EXTERNAL_SEARCH        = NO
  1511 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1512 # which will return the search results when EXTERNAL_SEARCH is enabled.
  1514 # Doxygen ships with an example indexer ( doxyindexer) and search engine
  1515 # (doxysearch.cgi) which are based on the open source search engine library
  1516 # Xapian (see: http://xapian.org/). See the section "External Indexing and
  1517 # Searching" for details.
  1518 # This tag requires that the tag SEARCHENGINE is set to YES.
  1520 SEARCHENGINE_URL       =
  1522 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1523 # search data is written to a file for indexing by an external tool. With the
  1524 # SEARCHDATA_FILE tag the name of this file can be specified.
  1525 # The default file is: searchdata.xml.
  1526 # This tag requires that the tag SEARCHENGINE is set to YES.
  1528 SEARCHDATA_FILE        = searchdata.xml
  1530 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1531 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1532 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1533 # projects and redirect the results back to the right project.
  1534 # This tag requires that the tag SEARCHENGINE is set to YES.
  1536 EXTERNAL_SEARCH_ID     =
  1538 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1539 # projects other than the one defined by this configuration file, but that are
  1540 # all added to the same external search index. Each project needs to have a
  1541 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1542 # to a relative location where the documentation can be found. The format is:
  1543 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1544 # This tag requires that the tag SEARCHENGINE is set to YES.
  1546 EXTRA_SEARCH_MAPPINGS  =
  1548 #---------------------------------------------------------------------------
  1549 # Configuration options related to the LaTeX output
  1550 #---------------------------------------------------------------------------
  1552 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
  1553 # The default value is: YES.
  1555 GENERATE_LATEX         = NO
  1557 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1558 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1559 # it.
  1560 # The default directory is: latex.
  1561 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1563 LATEX_OUTPUT           = latex
  1565 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1566 # invoked.
  1568 # Note that when enabling USE_PDFLATEX this option is only used for generating
  1569 # bitmaps for formulas in the HTML output, but not in the Makefile that is
  1570 # written to the output directory.
  1571 # The default file is: latex.
  1572 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1574 LATEX_CMD_NAME         = latex
  1576 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1577 # index for LaTeX.
  1578 # The default file is: makeindex.
  1579 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1581 MAKEINDEX_CMD_NAME     = makeindex
  1583 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
  1584 # documents. This may be useful for small projects and may help to save some
  1585 # trees in general.
  1586 # The default value is: NO.
  1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1589 COMPACT_LATEX          = NO
  1591 # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1592 # printer.
  1593 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1594 # 14 inches) and executive (7.25 x 10.5 inches).
  1595 # The default value is: a4.
  1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1598 PAPER_TYPE             = a4
  1600 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1601 # that should be included in the LaTeX output. To get the times font for
  1602 # instance you can specify
  1603 # EXTRA_PACKAGES=times
  1604 # If left blank no extra packages will be included.
  1605 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1607 EXTRA_PACKAGES         =
  1609 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1610 # generated LaTeX document. The header should contain everything until the first
  1611 # chapter. If it is left blank doxygen will generate a standard header. See
  1612 # section "Doxygen usage" for information on how to let doxygen write the
  1613 # default header to a separate file.
  1615 # Note: Only use a user-defined header if you know what you are doing! The
  1616 # following commands have a special meaning inside the header: $title,
  1617 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
  1618 # replace them by respectively the title of the page, the current date and time,
  1619 # only the current date, the version number of doxygen, the project name (see
  1620 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
  1621 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1623 LATEX_HEADER           =
  1625 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1626 # generated LaTeX document. The footer should contain everything after the last
  1627 # chapter. If it is left blank doxygen will generate a standard footer.
  1629 # Note: Only use a user-defined footer if you know what you are doing!
  1630 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1632 LATEX_FOOTER           =
  1634 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1635 # other source files which should be copied to the LATEX_OUTPUT output
  1636 # directory. Note that the files will be copied as-is; there are no commands or
  1637 # markers available.
  1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1640 LATEX_EXTRA_FILES      =
  1642 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1643 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1644 # contain links (just like the HTML output) instead of page references. This
  1645 # makes the output suitable for online browsing using a PDF viewer.
  1646 # The default value is: YES.
  1647 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1649 PDF_HYPERLINKS         = YES
  1651 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1652 # the PDF file directly from the LaTeX files. Set this option to YES to get a
  1653 # higher quality PDF documentation.
  1654 # The default value is: YES.
  1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1657 USE_PDFLATEX           = YES
  1659 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1660 # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1661 # if errors occur, instead of asking the user for help. This option is also used
  1662 # when generating formulas in HTML.
  1663 # The default value is: NO.
  1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1666 LATEX_BATCHMODE        = NO
  1668 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1669 # index chapters (such as File Index, Compound Index, etc.) in the output.
  1670 # The default value is: NO.
  1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1673 LATEX_HIDE_INDICES     = NO
  1675 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1676 # code with syntax highlighting in the LaTeX output.
  1678 # Note that which sources are shown also depends on other settings such as
  1679 # SOURCE_BROWSER.
  1680 # The default value is: NO.
  1681 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1683 LATEX_SOURCE_CODE      = NO
  1685 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1686 # bibliography, e.g. plainnat, or ieeetr. See
  1687 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1688 # The default value is: plain.
  1689 # This tag requires that the tag GENERATE_LATEX is set to YES.
  1691 LATEX_BIB_STYLE        = plain
  1693 #---------------------------------------------------------------------------
  1694 # Configuration options related to the RTF output
  1695 #---------------------------------------------------------------------------
  1697 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
  1698 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1699 # readers/editors.
  1700 # The default value is: NO.
  1702 GENERATE_RTF           = NO
  1704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1705 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1706 # it.
  1707 # The default directory is: rtf.
  1708 # This tag requires that the tag GENERATE_RTF is set to YES.
  1710 RTF_OUTPUT             = rtf
  1712 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
  1713 # documents. This may be useful for small projects and may help to save some
  1714 # trees in general.
  1715 # The default value is: NO.
  1716 # This tag requires that the tag GENERATE_RTF is set to YES.
  1718 COMPACT_RTF            = NO
  1720 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1721 # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1722 # output) instead of page references. This makes the output suitable for online
  1723 # browsing using Word or some other Word compatible readers that support those
  1724 # fields.
  1726 # Note: WordPad (write) and others do not support links.
  1727 # The default value is: NO.
  1728 # This tag requires that the tag GENERATE_RTF is set to YES.
  1730 RTF_HYPERLINKS         = NO
  1732 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1733 # file, i.e. a series of assignments. You only have to provide replacements,
  1734 # missing definitions are set to their default value.
  1736 # See also section "Doxygen usage" for information on how to generate the
  1737 # default style sheet that doxygen normally uses.
  1738 # This tag requires that the tag GENERATE_RTF is set to YES.
  1740 RTF_STYLESHEET_FILE    =
  1742 # Set optional variables used in the generation of an RTF document. Syntax is
  1743 # similar to doxygen's config file. A template extensions file can be generated
  1744 # using doxygen -e rtf extensionFile.
  1745 # This tag requires that the tag GENERATE_RTF is set to YES.
  1747 RTF_EXTENSIONS_FILE    =
  1749 #---------------------------------------------------------------------------
  1750 # Configuration options related to the man page output
  1751 #---------------------------------------------------------------------------
  1753 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
  1754 # classes and files.
  1755 # The default value is: NO.
  1757 GENERATE_MAN           = NO
  1759 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1760 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1761 # it. A directory man3 will be created inside the directory specified by
  1762 # MAN_OUTPUT.
  1763 # The default directory is: man.
  1764 # This tag requires that the tag GENERATE_MAN is set to YES.
  1766 MAN_OUTPUT             = man
  1768 # The MAN_EXTENSION tag determines the extension that is added to the generated
  1769 # man pages. In case the manual section does not start with a number, the number
  1770 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1771 # optional.
  1772 # The default value is: .3.
  1773 # This tag requires that the tag GENERATE_MAN is set to YES.
  1775 MAN_EXTENSION          = .3
  1777 # The MAN_SUBDIR tag determines the name of the directory created within
  1778 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1779 # MAN_EXTENSION with the initial . removed.
  1780 # This tag requires that the tag GENERATE_MAN is set to YES.
  1782 MAN_SUBDIR             =
  1784 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1785 # will generate one additional man file for each entity documented in the real
  1786 # man page(s). These additional files only source the real man page, but without
  1787 # them the man command would be unable to find the correct page.
  1788 # The default value is: NO.
  1789 # This tag requires that the tag GENERATE_MAN is set to YES.
  1791 MAN_LINKS              = NO
  1793 #---------------------------------------------------------------------------
  1794 # Configuration options related to the XML output
  1795 #---------------------------------------------------------------------------
  1797 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
  1798 # captures the structure of the code including all documentation.
  1799 # The default value is: NO.
  1801 GENERATE_XML           = NO
  1803 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1804 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1805 # it.
  1806 # The default directory is: xml.
  1807 # This tag requires that the tag GENERATE_XML is set to YES.
  1809 XML_OUTPUT             = xml
  1811 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
  1812 # listings (including syntax highlighting and cross-referencing information) to
  1813 # the XML output. Note that enabling this will significantly increase the size
  1814 # of the XML output.
  1815 # The default value is: YES.
  1816 # This tag requires that the tag GENERATE_XML is set to YES.
  1818 XML_PROGRAMLISTING     = YES
  1820 #---------------------------------------------------------------------------
  1821 # Configuration options related to the DOCBOOK output
  1822 #---------------------------------------------------------------------------
  1824 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
  1825 # that can be used to generate PDF.
  1826 # The default value is: NO.
  1828 GENERATE_DOCBOOK       = NO
  1830 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1831 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1832 # front of it.
  1833 # The default directory is: docbook.
  1834 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1836 DOCBOOK_OUTPUT         = docbook
  1838 #---------------------------------------------------------------------------
  1839 # Configuration options for the AutoGen Definitions output
  1840 #---------------------------------------------------------------------------
  1842 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
  1843 # Definitions (see http://autogen.sf.net) file that captures the structure of
  1844 # the code including all documentation. Note that this feature is still
  1845 # experimental and incomplete at the moment.
  1846 # The default value is: NO.
  1848 GENERATE_AUTOGEN_DEF   = NO
  1850 #---------------------------------------------------------------------------
  1851 # Configuration options related to the Perl module output
  1852 #---------------------------------------------------------------------------
  1854 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
  1855 # file that captures the structure of the code including all documentation.
  1857 # Note that this feature is still experimental and incomplete at the moment.
  1858 # The default value is: NO.
  1860 GENERATE_PERLMOD       = NO
  1862 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
  1863 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1864 # output from the Perl module output.
  1865 # The default value is: NO.
  1866 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1868 PERLMOD_LATEX          = NO
  1870 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
  1871 # formatted so it can be parsed by a human reader. This is useful if you want to
  1872 # understand what is going on. On the other hand, if this tag is set to NO the
  1873 # size of the Perl module output will be much smaller and Perl will parse it
  1874 # just the same.
  1875 # The default value is: YES.
  1876 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1878 PERLMOD_PRETTY         = YES
  1880 # The names of the make variables in the generated doxyrules.make file are
  1881 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1882 # so different doxyrules.make files included by the same Makefile don't
  1883 # overwrite each other's variables.
  1884 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1886 PERLMOD_MAKEVAR_PREFIX =
  1888 #---------------------------------------------------------------------------
  1889 # Configuration options related to the preprocessor
  1890 #---------------------------------------------------------------------------
  1892 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
  1893 # C-preprocessor directives found in the sources and include files.
  1894 # The default value is: YES.
  1896 ENABLE_PREPROCESSING   = YES
  1898 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
  1899 # in the source code. If set to NO only conditional compilation will be
  1900 # performed. Macro expansion can be done in a controlled way by setting
  1901 # EXPAND_ONLY_PREDEF to YES.
  1902 # The default value is: NO.
  1903 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1905 MACRO_EXPANSION        = NO
  1907 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1908 # the macro expansion is limited to the macros specified with the PREDEFINED and
  1909 # EXPAND_AS_DEFINED tags.
  1910 # The default value is: NO.
  1911 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1913 EXPAND_ONLY_PREDEF     = NO
  1915 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
  1916 # INCLUDE_PATH will be searched if a #include is found.
  1917 # The default value is: YES.
  1918 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1920 SEARCH_INCLUDES        = YES
  1922 # The INCLUDE_PATH tag can be used to specify one or more directories that
  1923 # contain include files that are not input files but should be processed by the
  1924 # preprocessor.
  1925 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1927 INCLUDE_PATH           =
  1929 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1930 # patterns (like *.h and *.hpp) to filter out the header-files in the
  1931 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1932 # used.
  1933 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1935 INCLUDE_FILE_PATTERNS  =
  1937 # The PREDEFINED tag can be used to specify one or more macro names that are
  1938 # defined before the preprocessor is started (similar to the -D option of e.g.
  1939 # gcc). The argument of the tag is a list of macros of the form: name or
  1940 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1941 # is assumed. To prevent a macro definition from being undefined via #undef or
  1942 # recursively expanded use the := operator instead of the = operator.
  1943 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1945 PREDEFINED             =
  1947 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1948 # tag can be used to specify a list of macro names that should be expanded. The
  1949 # macro definition that is found in the sources will be used. Use the PREDEFINED
  1950 # tag if you want to use a different macro definition that overrules the
  1951 # definition found in the source code.
  1952 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1954 EXPAND_AS_DEFINED      =
  1956 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1957 # remove all references to function-like macros that are alone on a line, have
  1958 # an all uppercase name, and do not end with a semicolon. Such function macros
  1959 # are typically used for boiler-plate code, and will confuse the parser if not
  1960 # removed.
  1961 # The default value is: YES.
  1962 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1964 SKIP_FUNCTION_MACROS   = YES
  1966 #---------------------------------------------------------------------------
  1967 # Configuration options related to external references
  1968 #---------------------------------------------------------------------------
  1970 # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1971 # file the location of the external documentation should be added. The format of
  1972 # a tag file without this location is as follows:
  1973 # TAGFILES = file1 file2 ...
  1974 # Adding location for the tag files is done as follows:
  1975 # TAGFILES = file1=loc1 "file2 = loc2" ...
  1976 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1977 # section "Linking to external documentation" for more information about the use
  1978 # of tag files.
  1979 # Note: Each tag file must have a unique name (where the name does NOT include
  1980 # the path). If a tag file is not located in the directory in which doxygen is
  1981 # run, you must also specify the path to the tagfile here.
  1983 TAGFILES               =
  1985 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1986 # tag file that is based on the input files it reads. See section "Linking to
  1987 # external documentation" for more information about the usage of tag files.
  1989 GENERATE_TAGFILE       =
  1991 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
  1992 # class index. If set to NO only the inherited external classes will be listed.
  1993 # The default value is: NO.
  1995 ALLEXTERNALS           = NO
  1997 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
  1998 # the modules index. If set to NO, only the current project's groups will be
  1999 # listed.
  2000 # The default value is: YES.
  2002 EXTERNAL_GROUPS        = YES
  2004 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
  2005 # the related pages index. If set to NO, only the current project's pages will
  2006 # be listed.
  2007 # The default value is: YES.
  2009 EXTERNAL_PAGES         = YES
  2011 # The PERL_PATH should be the absolute path and name of the perl script
  2012 # interpreter (i.e. the result of 'which perl').
  2013 # The default file (with absolute path) is: /usr/bin/perl.
  2015 PERL_PATH              = /usr/bin/perl
  2017 #---------------------------------------------------------------------------
  2018 # Configuration options related to the dot tool
  2019 #---------------------------------------------------------------------------
  2021 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
  2022 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  2023 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  2024 # disabled, but it is recommended to install and use dot, since it yields more
  2025 # powerful graphs.
  2026 # The default value is: YES.
  2028 CLASS_DIAGRAMS         = YES
  2030 # You can define message sequence charts within doxygen comments using the \msc
  2031 # command. Doxygen will then run the mscgen tool (see:
  2032 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  2033 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  2034 # the mscgen tool resides. If left empty the tool is assumed to be found in the
  2035 # default search path.
  2037 MSCGEN_PATH            =
  2039 # You can include diagrams made with dia in doxygen documentation. Doxygen will
  2040 # then run dia to produce the diagram and insert it in the documentation. The
  2041 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  2042 # If left empty dia is assumed to be found in the default search path.
  2044 DIA_PATH               =
  2046 # If set to YES, the inheritance and collaboration graphs will hide inheritance
  2047 # and usage relations if the target is undocumented or is not a class.
  2048 # The default value is: YES.
  2050 HIDE_UNDOC_RELATIONS   = YES
  2052 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  2053 # available from the path. This tool is part of Graphviz (see:
  2054 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2055 # Bell Labs. The other options in this section have no effect if this option is
  2056 # set to NO
  2057 # The default value is: YES.
  2059 HAVE_DOT               = NO
  2061 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  2062 # to run in parallel. When set to 0 doxygen will base this on the number of
  2063 # processors available in the system. You can set it explicitly to a value
  2064 # larger than 0 to get control over the balance between CPU load and processing
  2065 # speed.
  2066 # Minimum value: 0, maximum value: 32, default value: 0.
  2067 # This tag requires that the tag HAVE_DOT is set to YES.
  2069 DOT_NUM_THREADS        = 0
  2071 # When you want a differently looking font n the dot files that doxygen
  2072 # generates you can specify the font name using DOT_FONTNAME. You need to make
  2073 # sure dot is able to find the font, which can be done by putting it in a
  2074 # standard location or by setting the DOTFONTPATH environment variable or by
  2075 # setting DOT_FONTPATH to the directory containing the font.
  2076 # The default value is: Helvetica.
  2077 # This tag requires that the tag HAVE_DOT is set to YES.
  2079 DOT_FONTNAME           = Helvetica
  2081 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2082 # dot graphs.
  2083 # Minimum value: 4, maximum value: 24, default value: 10.
  2084 # This tag requires that the tag HAVE_DOT is set to YES.
  2086 DOT_FONTSIZE           = 10
  2088 # By default doxygen will tell dot to use the default font as specified with
  2089 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2090 # the path where dot can find it using this tag.
  2091 # This tag requires that the tag HAVE_DOT is set to YES.
  2093 DOT_FONTPATH           =
  2095 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2096 # each documented class showing the direct and indirect inheritance relations.
  2097 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2098 # The default value is: YES.
  2099 # This tag requires that the tag HAVE_DOT is set to YES.
  2101 CLASS_GRAPH            = YES
  2103 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  2104 # graph for each documented class showing the direct and indirect implementation
  2105 # dependencies (inheritance, containment, and class references variables) of the
  2106 # class with other documented classes.
  2107 # The default value is: YES.
  2108 # This tag requires that the tag HAVE_DOT is set to YES.
  2110 COLLABORATION_GRAPH    = YES
  2112 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2113 # groups, showing the direct groups dependencies.
  2114 # The default value is: YES.
  2115 # This tag requires that the tag HAVE_DOT is set to YES.
  2117 GROUP_GRAPHS           = YES
  2119 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  2120 # collaboration diagrams in a style similar to the OMG's Unified Modeling
  2121 # Language.
  2122 # The default value is: NO.
  2123 # This tag requires that the tag HAVE_DOT is set to YES.
  2125 UML_LOOK               = NO
  2127 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  2128 # class node. If there are many fields or methods and many nodes the graph may
  2129 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  2130 # number of items for each type to make the size more manageable. Set this to 0
  2131 # for no limit. Note that the threshold may be exceeded by 50% before the limit
  2132 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  2133 # but if the number exceeds 15, the total amount of fields shown is limited to
  2134 # 10.
  2135 # Minimum value: 0, maximum value: 100, default value: 10.
  2136 # This tag requires that the tag HAVE_DOT is set to YES.
  2138 UML_LIMIT_NUM_FIELDS   = 10
  2140 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2141 # collaboration graphs will show the relations between templates and their
  2142 # instances.
  2143 # The default value is: NO.
  2144 # This tag requires that the tag HAVE_DOT is set to YES.
  2146 TEMPLATE_RELATIONS     = NO
  2148 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  2149 # YES then doxygen will generate a graph for each documented file showing the
  2150 # direct and indirect include dependencies of the file with other documented
  2151 # files.
  2152 # The default value is: YES.
  2153 # This tag requires that the tag HAVE_DOT is set to YES.
  2155 INCLUDE_GRAPH          = YES
  2157 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  2158 # set to YES then doxygen will generate a graph for each documented file showing
  2159 # the direct and indirect include dependencies of the file with other documented
  2160 # files.
  2161 # The default value is: YES.
  2162 # This tag requires that the tag HAVE_DOT is set to YES.
  2164 INCLUDED_BY_GRAPH      = YES
  2166 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  2167 # dependency graph for every global function or class method.
  2169 # Note that enabling this option will significantly increase the time of a run.
  2170 # So in most cases it will be better to enable call graphs for selected
  2171 # functions only using the \callgraph command.
  2172 # The default value is: NO.
  2173 # This tag requires that the tag HAVE_DOT is set to YES.
  2175 CALL_GRAPH             = NO
  2177 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  2178 # dependency graph for every global function or class method.
  2180 # Note that enabling this option will significantly increase the time of a run.
  2181 # So in most cases it will be better to enable caller graphs for selected
  2182 # functions only using the \callergraph command.
  2183 # The default value is: NO.
  2184 # This tag requires that the tag HAVE_DOT is set to YES.
  2186 CALLER_GRAPH           = NO
  2188 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  2189 # hierarchy of all classes instead of a textual one.
  2190 # The default value is: YES.
  2191 # This tag requires that the tag HAVE_DOT is set to YES.
  2193 GRAPHICAL_HIERARCHY    = YES
  2195 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  2196 # dependencies a directory has on other directories in a graphical way. The
  2197 # dependency relations are determined by the #include relations between the
  2198 # files in the directories.
  2199 # The default value is: YES.
  2200 # This tag requires that the tag HAVE_DOT is set to YES.
  2202 DIRECTORY_GRAPH        = YES
  2204 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  2205 # generated by dot.
  2206 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2207 # to make the SVG files visible in IE 9+ (other browsers do not have this
  2208 # requirement).
  2209 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  2210 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  2211 # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  2212 # The default value is: png.
  2213 # This tag requires that the tag HAVE_DOT is set to YES.
  2215 DOT_IMAGE_FORMAT       = png
  2217 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  2218 # enable generation of interactive SVG images that allow zooming and panning.
  2220 # Note that this requires a modern browser other than Internet Explorer. Tested
  2221 # and working are Firefox, Chrome, Safari, and Opera.
  2222 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  2223 # the SVG files visible. Older versions of IE do not have SVG support.
  2224 # The default value is: NO.
  2225 # This tag requires that the tag HAVE_DOT is set to YES.
  2227 INTERACTIVE_SVG        = NO
  2229 # The DOT_PATH tag can be used to specify the path where the dot tool can be
  2230 # found. If left blank, it is assumed the dot tool can be found in the path.
  2231 # This tag requires that the tag HAVE_DOT is set to YES.
  2233 DOT_PATH               =
  2235 # The DOTFILE_DIRS tag can be used to specify one or more directories that
  2236 # contain dot files that are included in the documentation (see the \dotfile
  2237 # command).
  2238 # This tag requires that the tag HAVE_DOT is set to YES.
  2240 DOTFILE_DIRS           =
  2242 # The MSCFILE_DIRS tag can be used to specify one or more directories that
  2243 # contain msc files that are included in the documentation (see the \mscfile
  2244 # command).
  2246 MSCFILE_DIRS           =
  2248 # The DIAFILE_DIRS tag can be used to specify one or more directories that
  2249 # contain dia files that are included in the documentation (see the \diafile
  2250 # command).
  2252 DIAFILE_DIRS           =
  2254 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2255 # that will be shown in the graph. If the number of nodes in a graph becomes
  2256 # larger than this value, doxygen will truncate the graph, which is visualized
  2257 # by representing a node as a red box. Note that doxygen if the number of direct
  2258 # children of the root node in a graph is already larger than
  2259 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  2260 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2261 # Minimum value: 0, maximum value: 10000, default value: 50.
  2262 # This tag requires that the tag HAVE_DOT is set to YES.
  2264 DOT_GRAPH_MAX_NODES    = 50
  2266 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  2267 # generated by dot. A depth value of 3 means that only nodes reachable from the
  2268 # root by following a path via at most 3 edges will be shown. Nodes that lay
  2269 # further from the root node will be omitted. Note that setting this option to 1
  2270 # or 2 may greatly reduce the computation time needed for large code bases. Also
  2271 # note that the size of a graph can be further restricted by
  2272 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  2273 # Minimum value: 0, maximum value: 1000, default value: 0.
  2274 # This tag requires that the tag HAVE_DOT is set to YES.
  2276 MAX_DOT_GRAPH_DEPTH    = 0
  2278 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2279 # background. This is disabled by default, because dot on Windows does not seem
  2280 # to support this out of the box.
  2282 # Warning: Depending on the platform used, enabling this option may lead to
  2283 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2284 # read).
  2285 # The default value is: NO.
  2286 # This tag requires that the tag HAVE_DOT is set to YES.
  2288 DOT_TRANSPARENT        = NO
  2290 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  2291 # files in one run (i.e. multiple -o and -T options on the command line). This
  2292 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2293 # this, this feature is disabled by default.
  2294 # The default value is: NO.
  2295 # This tag requires that the tag HAVE_DOT is set to YES.
  2297 DOT_MULTI_TARGETS      = YES
  2299 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2300 # explaining the meaning of the various boxes and arrows in the dot generated
  2301 # graphs.
  2302 # The default value is: YES.
  2303 # This tag requires that the tag HAVE_DOT is set to YES.
  2305 GENERATE_LEGEND        = YES
  2307 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
  2308 # files that are used to generate the various graphs.
  2309 # The default value is: YES.
  2310 # This tag requires that the tag HAVE_DOT is set to YES.
  2312 DOT_CLEANUP            = YES

mercurial