Warning, /Doxyfile is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.8.15
0002
0003 # This file describes the settings to be used by the documentation system
0004 # doxygen (www.doxygen.org) for a project.
0005 #
0006 # All text after a double hash (##) is considered a comment and is placed in
0007 # front of the TAG it is preceding.
0008 #
0009 # All text after a single hash (#) is considered a comment and will be ignored.
0010 # The format is:
0011 # TAG = value [value, ...]
0012 # For lists, items can also be appended using:
0013 # TAG += value [value, ...]
0014 # Values that contain spaces should be placed between quotes (\" \").
0015
0016 #---------------------------------------------------------------------------
0017 # Project related configuration options
0018 #---------------------------------------------------------------------------
0019
0020 # This tag specifies the encoding used for all characters in the configuration
0021 # file that follow. The default is UTF-8 which is also the encoding used for all
0022 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0023 # iconv built into libc) for the transcoding. See
0024 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
0025 # The default value is: UTF-8.
0026
0027 DOXYFILE_ENCODING = UTF-8
0028
0029 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
0030 # double-quotes, unless you are using Doxywizard) that should identify the
0031 # project for which the documentation is generated. This name is used in the
0032 # title of most generated pages and in a few other places.
0033 # The default value is: My Project.
0034
0035 PROJECT_NAME = RTEMS
0036
0037 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
0038 # could be handy for archiving the generated documentation or if some version
0039 # control system is used.
0040
0041 PROJECT_NUMBER = 6.0.0
0042
0043 # Using the PROJECT_BRIEF tag one can provide an optional one line description
0044 # for a project that appears at the top of each page and should give viewer a
0045 # quick idea about the purpose of the project. Keep the description short.
0046
0047 PROJECT_BRIEF =
0048
0049 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
0050 # in the documentation. The maximum height of the logo should not exceed 55
0051 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
0052 # the logo to the output directory.
0053
0054 PROJECT_LOGO = rtemslogo.png
0055
0056 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
0057 # into which the generated documentation will be written. If a relative path is
0058 # entered, it will be relative to the location where doxygen was started. If
0059 # left blank the current directory will be used.
0060
0061 OUTPUT_DIRECTORY = doc
0062
0063 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
0064 # directories (in 2 levels) under the output directory of each output format and
0065 # will distribute the generated files over these directories. Enabling this
0066 # option can be useful when feeding doxygen a huge amount of source files, where
0067 # putting all generated files in the same directory would otherwise causes
0068 # performance problems for the file system.
0069 # The default value is: NO.
0070
0071 CREATE_SUBDIRS = NO
0072
0073 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
0074 # characters to appear in the names of generated files. If set to NO, non-ASCII
0075 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
0076 # U+3044.
0077 # The default value is: NO.
0078
0079 ALLOW_UNICODE_NAMES = NO
0080
0081 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0082 # documentation generated by doxygen is written. Doxygen will use this
0083 # information to generate all constant output in the proper language.
0084 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
0085 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
0086 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
0087 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
0088 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
0089 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
0090 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
0091 # Ukrainian and Vietnamese.
0092 # The default value is: English.
0093
0094 OUTPUT_LANGUAGE = English
0095
0096 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
0097 # documentation generated by doxygen is written. Doxygen will use this
0098 # information to generate all generated output in the proper direction.
0099 # Possible values are: None, LTR, RTL and Context.
0100 # The default value is: None.
0101
0102 OUTPUT_TEXT_DIRECTION = None
0103
0104 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
0105 # descriptions after the members that are listed in the file and class
0106 # documentation (similar to Javadoc). Set to NO to disable this.
0107 # The default value is: YES.
0108
0109 BRIEF_MEMBER_DESC = YES
0110
0111 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
0112 # description of a member or function before the detailed description
0113 #
0114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0115 # brief descriptions will be completely suppressed.
0116 # The default value is: YES.
0117
0118 REPEAT_BRIEF = YES
0119
0120 # This tag implements a quasi-intelligent brief description abbreviator that is
0121 # used to form the text in various listings. Each string in this list, if found
0122 # as the leading text of the brief description, will be stripped from the text
0123 # and the result, after processing the whole list, is used as the annotated
0124 # text. Otherwise, the brief description is used as-is. If left blank, the
0125 # following values are used ($name is automatically replaced with the name of
0126 # the entity):The $name class, The $name widget, The $name file, is, provides,
0127 # specifies, contains, represents, a, an and the.
0128
0129 ABBREVIATE_BRIEF = "The $name class" \
0130 "The $name widget" \
0131 "The $name file" \
0132 is \
0133 provides \
0134 specifies \
0135 contains \
0136 represents \
0137 a \
0138 an \
0139 the
0140
0141 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0142 # doxygen will generate a detailed section even if there is only a brief
0143 # description.
0144 # The default value is: NO.
0145
0146 ALWAYS_DETAILED_SEC = NO
0147
0148 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0149 # inherited members of a class in the documentation of that class as if those
0150 # members were ordinary class members. Constructors, destructors and assignment
0151 # operators of the base classes will not be shown.
0152 # The default value is: NO.
0153
0154 INLINE_INHERITED_MEMB = NO
0155
0156 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
0157 # before files name in the file list and in the header files. If set to NO the
0158 # shortest path that makes the file name unique will be used
0159 # The default value is: YES.
0160
0161 FULL_PATH_NAMES = YES
0162
0163 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
0164 # Stripping is only done if one of the specified strings matches the left-hand
0165 # part of the path. The tag can be used to show relative paths in the file list.
0166 # If left blank the directory from which doxygen is run is used as the path to
0167 # strip.
0168 #
0169 # Note that you can specify absolute paths here, but also relative paths, which
0170 # will be relative from the directory where doxygen is started.
0171 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
0172
0173 STRIP_FROM_PATH =
0174
0175 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
0176 # path mentioned in the documentation of a class, which tells the reader which
0177 # header file to include in order to use a class. If left blank only the name of
0178 # the header file containing the class definition is used. Otherwise one should
0179 # specify the list of include paths that are normally passed to the compiler
0180 # using the -I flag.
0181
0182 STRIP_FROM_INC_PATH =
0183
0184 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
0185 # less readable) file names. This can be useful is your file systems doesn't
0186 # support long names like on DOS, Mac, or CD-ROM.
0187 # The default value is: NO.
0188
0189 SHORT_NAMES = NO
0190
0191 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
0192 # first line (until the first dot) of a Javadoc-style comment as the brief
0193 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
0194 # style comments (thus requiring an explicit @brief command for a brief
0195 # description.)
0196 # The default value is: NO.
0197
0198 JAVADOC_AUTOBRIEF = NO
0199
0200 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
0201 # line (until the first dot) of a Qt-style comment as the brief description. If
0202 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
0203 # requiring an explicit \brief command for a brief description.)
0204 # The default value is: NO.
0205
0206 QT_AUTOBRIEF = NO
0207
0208 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
0209 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
0210 # a brief description. This used to be the default behavior. The new default is
0211 # to treat a multi-line C++ comment block as a detailed description. Set this
0212 # tag to YES if you prefer the old behavior instead.
0213 #
0214 # Note that setting this tag to YES also means that rational rose comments are
0215 # not recognized any more.
0216 # The default value is: NO.
0217
0218 MULTILINE_CPP_IS_BRIEF = NO
0219
0220 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
0221 # documentation from any documented member that it re-implements.
0222 # The default value is: YES.
0223
0224 INHERIT_DOCS = YES
0225
0226 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
0227 # page for each member. If set to NO, the documentation of a member will be part
0228 # of the file/class/namespace that contains it.
0229 # The default value is: NO.
0230
0231 SEPARATE_MEMBER_PAGES = NO
0232
0233 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
0234 # uses this value to replace tabs by spaces in code fragments.
0235 # Minimum value: 1, maximum value: 16, default value: 4.
0236
0237 TAB_SIZE = 4
0238
0239 # This tag can be used to specify a number of aliases that act as commands in
0240 # the documentation. An alias has the form:
0241 # name=value
0242 # For example adding
0243 # "sideeffect=@par Side Effects:\n"
0244 # will allow you to put the command \sideeffect (or @sideeffect) in the
0245 # documentation, which will result in a user-defined paragraph with heading
0246 # "Side Effects:". You can put \n's in the value part of an alias to insert
0247 # newlines (in the resulting output). You can put ^^ in the value part of an
0248 # alias to insert a newline as if a physical newline was in the original file.
0249 # When you need a literal { or } or , in the value part of an alias you have to
0250 # escape them by means of a backslash (\), this can lead to conflicts with the
0251 # commands \{ and \} for these it is advised to use the version @{ and @} or use
0252 # a double escape (\\{ and \\})
0253
0254 ALIASES =
0255
0256 # This tag can be used to specify a number of word-keyword mappings (TCL only).
0257 # A mapping has the form "name=value". For example adding "class=itcl::class"
0258 # will allow you to use the command class in the itcl::class meaning.
0259
0260 TCL_SUBST =
0261
0262 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
0263 # only. Doxygen will then generate output that is more tailored for C. For
0264 # instance, some of the names that are used will be different. The list of all
0265 # members will be omitted, etc.
0266 # The default value is: NO.
0267
0268 OPTIMIZE_OUTPUT_FOR_C = YES
0269 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
0270 # Python sources only. Doxygen will then generate output that is more tailored
0271 # for that language. For instance, namespaces will be presented as packages,
0272 # qualified scopes will look different, etc.
0273 # The default value is: NO.
0274
0275 OPTIMIZE_OUTPUT_JAVA = NO
0276
0277 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0278 # sources. Doxygen will then generate output that is tailored for Fortran.
0279 # The default value is: NO.
0280
0281 OPTIMIZE_FOR_FORTRAN = NO
0282
0283 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0284 # sources. Doxygen will then generate output that is tailored for VHDL.
0285 # The default value is: NO.
0286
0287 OPTIMIZE_OUTPUT_VHDL = NO
0288
0289 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
0290 # sources only. Doxygen will then generate output that is more tailored for that
0291 # language. For instance, namespaces will be presented as modules, types will be
0292 # separated into more groups, etc.
0293 # The default value is: NO.
0294
0295 OPTIMIZE_OUTPUT_SLICE = NO
0296
0297 # Doxygen selects the parser to use depending on the extension of the files it
0298 # parses. With this tag you can assign which parser to use for a given
0299 # extension. Doxygen has a built-in mapping, but you can override or extend it
0300 # using this tag. The format is ext=language, where ext is a file extension, and
0301 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
0302 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
0303 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
0304 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
0305 # tries to guess whether the code is fixed or free formatted code, this is the
0306 # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
0307 # .inc files as Fortran files (default is PHP), and .f files as C (default is
0308 # Fortran), use: inc=Fortran f=C.
0309 #
0310 # Note: For files without extension you can use no_extension as a placeholder.
0311 #
0312 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
0313 # the files are not read by doxygen.
0314
0315 EXTENSION_MAPPING =
0316
0317 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
0318 # according to the Markdown format, which allows for more readable
0319 # documentation. See https://daringfireball.net/projects/markdown/ for details.
0320 # The output of markdown processing is further processed by doxygen, so you can
0321 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
0322 # case of backward compatibilities issues.
0323 # The default value is: YES.
0324
0325 MARKDOWN_SUPPORT = YES
0326
0327 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
0328 # to that level are automatically included in the table of contents, even if
0329 # they do not have an id attribute.
0330 # Note: This feature currently applies only to Markdown headings.
0331 # Minimum value: 0, maximum value: 99, default value: 0.
0332 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
0333
0334 TOC_INCLUDE_HEADINGS = 0
0335
0336 # When enabled doxygen tries to link words that correspond to documented
0337 # classes, or namespaces to their corresponding documentation. Such a link can
0338 # be prevented in individual cases by putting a % sign in front of the word or
0339 # globally by setting AUTOLINK_SUPPORT to NO.
0340 # The default value is: YES.
0341
0342 AUTOLINK_SUPPORT = YES
0343
0344 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0345 # to include (a tag file for) the STL sources as input, then you should set this
0346 # tag to YES in order to let doxygen match functions declarations and
0347 # definitions whose arguments contain STL classes (e.g. func(std::string);
0348 # versus func(std::string) {}). This also make the inheritance and collaboration
0349 # diagrams that involve STL classes more complete and accurate.
0350 # The default value is: NO.
0351
0352 BUILTIN_STL_SUPPORT = NO
0353
0354 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0355 # enable parsing support.
0356 # The default value is: NO.
0357
0358 CPP_CLI_SUPPORT = NO
0359
0360 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
0361 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
0362 # will parse them like normal C++ but will assume all classes use public instead
0363 # of private inheritance when no explicit protection keyword is present.
0364 # The default value is: NO.
0365
0366 SIP_SUPPORT = NO
0367
0368 # For Microsoft's IDL there are propget and propput attributes to indicate
0369 # getter and setter methods for a property. Setting this option to YES will make
0370 # doxygen to replace the get and set methods by a property in the documentation.
0371 # This will only work if the methods are indeed getting or setting a simple
0372 # type. If this is not the case, or you want to show the methods anyway, you
0373 # should set this option to NO.
0374 # The default value is: YES.
0375
0376 IDL_PROPERTY_SUPPORT = YES
0377
0378 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0379 # tag is set to YES then doxygen will reuse the documentation of the first
0380 # member in the group (if any) for the other members of the group. By default
0381 # all members of a group must be documented explicitly.
0382 # The default value is: NO.
0383
0384 DISTRIBUTE_GROUP_DOC = NO
0385
0386 # If one adds a struct or class to a group and this option is enabled, then also
0387 # any nested class or struct is added to the same group. By default this option
0388 # is disabled and one has to add nested compounds explicitly via \ingroup.
0389 # The default value is: NO.
0390
0391 GROUP_NESTED_COMPOUNDS = NO
0392
0393 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
0394 # (for instance a group of public functions) to be put as a subgroup of that
0395 # type (e.g. under the Public Functions section). Set it to NO to prevent
0396 # subgrouping. Alternatively, this can be done per class using the
0397 # \nosubgrouping command.
0398 # The default value is: YES.
0399
0400 SUBGROUPING = YES
0401
0402 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
0403 # are shown inside the group in which they are included (e.g. using \ingroup)
0404 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
0405 # and RTF).
0406 #
0407 # Note that this feature does not work in combination with
0408 # SEPARATE_MEMBER_PAGES.
0409 # The default value is: NO.
0410
0411 INLINE_GROUPED_CLASSES = NO
0412
0413 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
0414 # with only public data fields or simple typedef fields will be shown inline in
0415 # the documentation of the scope in which they are defined (i.e. file,
0416 # namespace, or group documentation), provided this scope is documented. If set
0417 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
0418 # Man pages) or section (for LaTeX and RTF).
0419 # The default value is: NO.
0420
0421 INLINE_SIMPLE_STRUCTS = NO
0422
0423 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
0424 # enum is documented as struct, union, or enum with the name of the typedef. So
0425 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0426 # with name TypeT. When disabled the typedef will appear as a member of a file,
0427 # namespace, or class. And the struct will be named TypeS. This can typically be
0428 # useful for C code in case the coding convention dictates that all compound
0429 # types are typedef'ed and only the typedef is referenced, never the tag name.
0430 # The default value is: NO.
0431
0432 TYPEDEF_HIDES_STRUCT = NO
0433
0434 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
0435 # cache is used to resolve symbols given their name and scope. Since this can be
0436 # an expensive process and often the same symbol appears multiple times in the
0437 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
0438 # doxygen will become slower. If the cache is too large, memory is wasted. The
0439 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
0440 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
0441 # symbols. At the end of a run doxygen will report the cache usage and suggest
0442 # the optimal cache size from a speed point of view.
0443 # Minimum value: 0, maximum value: 9, default value: 0.
0444
0445 LOOKUP_CACHE_SIZE = 0
0446
0447 #---------------------------------------------------------------------------
0448 # Build related configuration options
0449 #---------------------------------------------------------------------------
0450
0451 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
0452 # documentation are documented, even if no documentation was available. Private
0453 # class members and static file members will be hidden unless the
0454 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
0455 # Note: This will also disable the warnings about undocumented members that are
0456 # normally produced when WARNINGS is set to YES.
0457 # The default value is: NO.
0458
0459 EXTRACT_ALL = NO
0460
0461 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
0462 # be included in the documentation.
0463 # The default value is: NO.
0464
0465 EXTRACT_PRIVATE = NO
0466
0467 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
0468 # scope will be included in the documentation.
0469 # The default value is: NO.
0470
0471 EXTRACT_PACKAGE = NO
0472
0473 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
0474 # included in the documentation.
0475 # The default value is: NO.
0476
0477 EXTRACT_STATIC = NO
0478
0479 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
0480 # locally in source files will be included in the documentation. If set to NO,
0481 # only classes defined in header files are included. Does not have any effect
0482 # for Java sources.
0483 # The default value is: YES.
0484
0485 EXTRACT_LOCAL_CLASSES = YES
0486
0487 # This flag is only useful for Objective-C code. If set to YES, local methods,
0488 # which are defined in the implementation section but not in the interface are
0489 # included in the documentation. If set to NO, only methods in the interface are
0490 # included.
0491 # The default value is: NO.
0492
0493 EXTRACT_LOCAL_METHODS = NO
0494
0495 # If this flag is set to YES, the members of anonymous namespaces will be
0496 # extracted and appear in the documentation as a namespace called
0497 # 'anonymous_namespace{file}', where file will be replaced with the base name of
0498 # the file that contains the anonymous namespace. By default anonymous namespace
0499 # are hidden.
0500 # The default value is: NO.
0501
0502 EXTRACT_ANON_NSPACES = NO
0503
0504 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
0505 # undocumented members inside documented classes or files. If set to NO these
0506 # members will be included in the various overviews, but no documentation
0507 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
0508 # The default value is: NO.
0509
0510 HIDE_UNDOC_MEMBERS = NO
0511
0512 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
0513 # undocumented classes that are normally visible in the class hierarchy. If set
0514 # to NO, these classes will be included in the various overviews. This option
0515 # has no effect if EXTRACT_ALL is enabled.
0516 # The default value is: NO.
0517
0518 HIDE_UNDOC_CLASSES = NO
0519
0520 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
0521 # (class|struct|union) declarations. If set to NO, these declarations will be
0522 # included in the documentation.
0523 # The default value is: NO.
0524
0525 HIDE_FRIEND_COMPOUNDS = NO
0526
0527 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
0528 # documentation blocks found inside the body of a function. If set to NO, these
0529 # blocks will be appended to the function's detailed documentation block.
0530 # The default value is: NO.
0531
0532 HIDE_IN_BODY_DOCS = NO
0533
0534 # The INTERNAL_DOCS tag determines if documentation that is typed after a
0535 # \internal command is included. If the tag is set to NO then the documentation
0536 # will be excluded. Set it to YES to include the internal documentation.
0537 # The default value is: NO.
0538
0539 INTERNAL_DOCS = NO
0540
0541 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
0542 # names in lower-case letters. If set to YES, upper-case letters are also
0543 # allowed. This is useful if you have classes or files whose names only differ
0544 # in case and if your file system supports case sensitive file names. Windows
0545 # and Mac users are advised to set this option to NO.
0546 # The default value is: system dependent.
0547
0548 CASE_SENSE_NAMES = YES
0549
0550 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
0551 # their full class and namespace scopes in the documentation. If set to YES, the
0552 # scope will be hidden.
0553 # The default value is: NO.
0554
0555 HIDE_SCOPE_NAMES = NO
0556
0557 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
0558 # append additional text to a page's title, such as Class Reference. If set to
0559 # YES the compound reference will be hidden.
0560 # The default value is: NO.
0561
0562 HIDE_COMPOUND_REFERENCE= NO
0563
0564 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
0565 # the files that are included by a file in the documentation of that file.
0566 # The default value is: YES.
0567
0568 SHOW_INCLUDE_FILES = YES
0569
0570 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
0571 # grouped member an include statement to the documentation, telling the reader
0572 # which file to include in order to use the member.
0573 # The default value is: NO.
0574
0575 SHOW_GROUPED_MEMB_INC = NO
0576
0577 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
0578 # files with double quotes in the documentation rather than with sharp brackets.
0579 # The default value is: NO.
0580
0581 FORCE_LOCAL_INCLUDES = NO
0582
0583 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
0584 # documentation for inline members.
0585 # The default value is: YES.
0586
0587 INLINE_INFO = YES
0588
0589 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
0590 # (detailed) documentation of file and class members alphabetically by member
0591 # name. If set to NO, the members will appear in declaration order.
0592 # The default value is: YES.
0593
0594 SORT_MEMBER_DOCS = YES
0595
0596 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
0597 # descriptions of file, namespace and class members alphabetically by member
0598 # name. If set to NO, the members will appear in declaration order. Note that
0599 # this will also influence the order of the classes in the class list.
0600 # The default value is: NO.
0601
0602 SORT_BRIEF_DOCS = NO
0603
0604 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
0605 # (brief and detailed) documentation of class members so that constructors and
0606 # destructors are listed first. If set to NO the constructors will appear in the
0607 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
0608 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
0609 # member documentation.
0610 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
0611 # detailed member documentation.
0612 # The default value is: NO.
0613
0614 SORT_MEMBERS_CTORS_1ST = NO
0615
0616 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
0617 # of group names into alphabetical order. If set to NO the group names will
0618 # appear in their defined order.
0619 # The default value is: NO.
0620
0621 SORT_GROUP_NAMES = YES
0622
0623 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
0624 # fully-qualified names, including namespaces. If set to NO, the class list will
0625 # be sorted only by class name, not including the namespace part.
0626 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0627 # Note: This option applies only to the class list, not to the alphabetical
0628 # list.
0629 # The default value is: NO.
0630
0631 SORT_BY_SCOPE_NAME = NO
0632
0633 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
0634 # type resolution of all parameters of a function it will reject a match between
0635 # the prototype and the implementation of a member function even if there is
0636 # only one candidate or it is obvious which candidate to choose by doing a
0637 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
0638 # accept a match between prototype and implementation in such cases.
0639 # The default value is: NO.
0640
0641 STRICT_PROTO_MATCHING = NO
0642
0643 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
0644 # list. This list is created by putting \todo commands in the documentation.
0645 # The default value is: YES.
0646
0647 GENERATE_TODOLIST = YES
0648
0649 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
0650 # list. This list is created by putting \test commands in the documentation.
0651 # The default value is: YES.
0652
0653 GENERATE_TESTLIST = YES
0654
0655 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
0656 # list. This list is created by putting \bug commands in the documentation.
0657 # The default value is: YES.
0658
0659 GENERATE_BUGLIST = YES
0660
0661 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
0662 # the deprecated list. This list is created by putting \deprecated commands in
0663 # the documentation.
0664 # The default value is: YES.
0665
0666 GENERATE_DEPRECATEDLIST= YES
0667
0668 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
0669 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
0670 # ... \endcond blocks.
0671
0672 ENABLED_SECTIONS =
0673
0674 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
0675 # initial value of a variable or macro / define can have for it to appear in the
0676 # documentation. If the initializer consists of more lines than specified here
0677 # it will be hidden. Use a value of 0 to hide initializers completely. The
0678 # appearance of the value of individual variables and macros / defines can be
0679 # controlled using \showinitializer or \hideinitializer command in the
0680 # documentation regardless of this setting.
0681 # Minimum value: 0, maximum value: 10000, default value: 30.
0682
0683 MAX_INITIALIZER_LINES = 30
0684
0685 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
0686 # the bottom of the documentation of classes and structs. If set to YES, the
0687 # list will mention the files that were used to generate the documentation.
0688 # The default value is: YES.
0689
0690 SHOW_USED_FILES = YES
0691
0692 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
0693 # will remove the Files entry from the Quick Index and from the Folder Tree View
0694 # (if specified).
0695 # The default value is: YES.
0696
0697 SHOW_FILES = YES
0698
0699 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
0700 # page. This will remove the Namespaces entry from the Quick Index and from the
0701 # Folder Tree View (if specified).
0702 # The default value is: YES.
0703
0704 SHOW_NAMESPACES = YES
0705
0706 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0707 # doxygen should invoke to get the current version for each file (typically from
0708 # the version control system). Doxygen will invoke the program by executing (via
0709 # popen()) the command command input-file, where command is the value of the
0710 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
0711 # by doxygen. Whatever the program writes to standard output is used as the file
0712 # version. For an example see the documentation.
0713
0714 FILE_VERSION_FILTER =
0715
0716 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
0717 # by doxygen. The layout file controls the global structure of the generated
0718 # output files in an output format independent way. To create the layout file
0719 # that represents doxygen's defaults, run doxygen with the -l option. You can
0720 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
0721 # will be used as the name of the layout file.
0722 #
0723 # Note that if you run doxygen from a directory containing a file called
0724 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
0725 # tag is left empty.
0726
0727 LAYOUT_FILE =
0728
0729 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
0730 # the reference definitions. This must be a list of .bib files. The .bib
0731 # extension is automatically appended if omitted. This requires the bibtex tool
0732 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
0733 # For LaTeX the style of the bibliography can be controlled using
0734 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
0735 # search path. See also \cite for info how to create references.
0736
0737 CITE_BIB_FILES =
0738
0739 #---------------------------------------------------------------------------
0740 # Configuration options related to warning and progress messages
0741 #---------------------------------------------------------------------------
0742
0743 # The QUIET tag can be used to turn on/off the messages that are generated to
0744 # standard output by doxygen. If QUIET is set to YES this implies that the
0745 # messages are off.
0746 # The default value is: NO.
0747
0748 QUIET = NO
0749
0750 # The WARNINGS tag can be used to turn on/off the warning messages that are
0751 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
0752 # this implies that the warnings are on.
0753 #
0754 # Tip: Turn warnings on while writing the documentation.
0755 # The default value is: YES.
0756
0757 WARNINGS = YES
0758
0759 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
0760 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
0761 # will automatically be disabled.
0762 # The default value is: YES.
0763
0764 WARN_IF_UNDOCUMENTED = NO
0765
0766 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
0767 # potential errors in the documentation, such as not documenting some parameters
0768 # in a documented function, or documenting parameters that don't exist or using
0769 # markup commands wrongly.
0770 # The default value is: YES.
0771
0772 WARN_IF_DOC_ERROR = YES
0773
0774 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
0775 # are documented, but have no documentation for their parameters or return
0776 # value. If set to NO, doxygen will only warn about wrong or incomplete
0777 # parameter documentation, but not about the absence of documentation. If
0778 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
0779 # The default value is: NO.
0780
0781 WARN_NO_PARAMDOC = NO
0782
0783 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
0784 # a warning is encountered.
0785 # The default value is: NO.
0786
0787 WARN_AS_ERROR = NO
0788
0789 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
0790 # can produce. The string should contain the $file, $line, and $text tags, which
0791 # will be replaced by the file and line number from which the warning originated
0792 # and the warning text. Optionally the format may contain $version, which will
0793 # be replaced by the version of the file (if it could be obtained via
0794 # FILE_VERSION_FILTER)
0795 # The default value is: $file:$line: $text.
0796
0797 WARN_FORMAT = "$file:$line: $text"
0798
0799 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
0800 # messages should be written. If left blank the output is written to standard
0801 # error (stderr).
0802
0803 WARN_LOGFILE =
0804
0805 #---------------------------------------------------------------------------
0806 # Configuration options related to the input files
0807 #---------------------------------------------------------------------------
0808
0809 # The INPUT tag is used to specify the files and/or directories that contain
0810 # documented source files. You may enter file names like myfile.cpp or
0811 # directories like /usr/src/myproject. Separate the files or directories with
0812 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
0813 # Note: If this tag is empty the current directory is searched.
0814
0815 INPUT = bsps \
0816 cpukit \
0817 testsuites/fstests/tftpfs \
0818 testsuites/validation
0819
0820 # This tag can be used to specify the character encoding of the source files
0821 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
0822 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
0823 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
0824 # possible encodings.
0825 # The default value is: UTF-8.
0826
0827 INPUT_ENCODING = UTF-8
0828
0829 # If the value of the INPUT tag contains directories, you can use the
0830 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
0831 # *.h) to filter out the source-files in the directories.
0832 #
0833 # Note that for custom extensions or not directly supported extensions you also
0834 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
0835 # read by doxygen.
0836 #
0837 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
0838 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
0839 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
0840 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
0841 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
0842
0843 FILE_PATTERNS = *.c \
0844 *.cc \
0845 *.cxx \
0846 *.cpp \
0847 *.c++ \
0848 *.java \
0849 *.ii \
0850 *.ixx \
0851 *.ipp \
0852 *.i++ \
0853 *.inl \
0854 *.idl \
0855 *.ddl \
0856 *.odl \
0857 *.h \
0858 *.hh \
0859 *.hxx \
0860 *.hpp \
0861 *.h++ \
0862 *.cs \
0863 *.d \
0864 *.php \
0865 *.php4 \
0866 *.php5 \
0867 *.phtml \
0868 *.inc \
0869 *.m \
0870 *.markdown \
0871 *.md \
0872 *.mm \
0873 *.dox \
0874 *.py \
0875 *.pyw \
0876 *.f90 \
0877 *.f95 \
0878 *.f03 \
0879 *.f08 \
0880 *.f \
0881 *.for \
0882 *.tcl \
0883 *.vhd \
0884 *.vhdl \
0885 *.ucf \
0886 *.qsf \
0887 *.ice
0888
0889 # The RECURSIVE tag can be used to specify whether or not subdirectories should
0890 # be searched for input files as well.
0891 # The default value is: NO.
0892
0893 RECURSIVE = YES
0894
0895 # The EXCLUDE tag can be used to specify files and/or directories that should be
0896 # excluded from the INPUT source files. This way you can easily exclude a
0897 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0898 #
0899 # Note that relative paths are relative to the directory from which doxygen is
0900 # run.
0901
0902 EXCLUDE = cpukit/libnetworking cpukit/libfs/src/nfsclient
0903
0904 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
0905 # directories that are symbolic links (a Unix file system feature) are excluded
0906 # from the input.
0907 # The default value is: NO.
0908
0909 EXCLUDE_SYMLINKS = NO
0910
0911 # If the value of the INPUT tag contains directories, you can use the
0912 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0913 # certain files from those directories.
0914 #
0915 # Note that the wildcards are matched against the file with absolute path, so to
0916 # exclude all test directories for example use the pattern */test/*
0917
0918 EXCLUDE_PATTERNS =
0919
0920 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0921 # (namespaces, classes, functions, etc.) that should be excluded from the
0922 # output. The symbol name can be a fully qualified name, a word, or if the
0923 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0924 # AClass::ANamespace, ANamespace::*Test
0925 #
0926 # Note that the wildcards are matched against the file with absolute path, so to
0927 # exclude all test directories use the pattern */test/*
0928
0929 EXCLUDE_SYMBOLS =
0930
0931 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
0932 # that contain example code fragments that are included (see the \include
0933 # command).
0934
0935 EXAMPLE_PATH =
0936
0937 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0938 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
0939 # *.h) to filter out the source-files in the directories. If left blank all
0940 # files are included.
0941
0942 EXAMPLE_PATTERNS = *
0943
0944 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0945 # searched for input files to be used with the \include or \dontinclude commands
0946 # irrespective of the value of the RECURSIVE tag.
0947 # The default value is: NO.
0948
0949 EXAMPLE_RECURSIVE = NO
0950
0951 # The IMAGE_PATH tag can be used to specify one or more files or directories
0952 # that contain images that are to be included in the documentation (see the
0953 # \image command).
0954
0955 IMAGE_PATH =
0956
0957 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0958 # invoke to filter for each input file. Doxygen will invoke the filter program
0959 # by executing (via popen()) the command:
0960 #
0961 # <filter> <input-file>
0962 #
0963 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
0964 # name of an input file. Doxygen will then use the output that the filter
0965 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
0966 # will be ignored.
0967 #
0968 # Note that the filter must not add or remove lines; it is applied before the
0969 # code is scanned, but not when the output code is generated. If lines are added
0970 # or removed, the anchors will not be placed correctly.
0971 #
0972 # Note that for custom extensions or not directly supported extensions you also
0973 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
0974 # properly processed by doxygen.
0975
0976 INPUT_FILTER =
0977
0978 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0979 # basis. Doxygen will compare the file name with each pattern and apply the
0980 # filter if there is a match. The filters are a list of the form: pattern=filter
0981 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
0982 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
0983 # patterns match the file name, INPUT_FILTER is applied.
0984 #
0985 # Note that for custom extensions or not directly supported extensions you also
0986 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
0987 # properly processed by doxygen.
0988
0989 FILTER_PATTERNS =
0990
0991 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0992 # INPUT_FILTER) will also be used to filter the input files that are used for
0993 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
0994 # The default value is: NO.
0995
0996 FILTER_SOURCE_FILES = NO
0997
0998 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
0999 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1000 # it is also possible to disable source filtering for a specific pattern using
1001 # *.ext= (so without naming a filter).
1002 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1003
1004 FILTER_SOURCE_PATTERNS =
1005
1006 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1007 # is part of the input, its contents will be placed on the main page
1008 # (index.html). This can be useful if you have a project on for instance GitHub
1009 # and want to reuse the introduction page also for the doxygen output.
1010
1011 USE_MDFILE_AS_MAINPAGE =
1012
1013 #---------------------------------------------------------------------------
1014 # Configuration options related to source browsing
1015 #---------------------------------------------------------------------------
1016
1017 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1018 # generated. Documented entities will be cross-referenced with these sources.
1019 #
1020 # Note: To get rid of all source code in the generated output, make sure that
1021 # also VERBATIM_HEADERS is set to NO.
1022 # The default value is: NO.
1023
1024 SOURCE_BROWSER = NO
1025
1026 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1027 # classes and enums directly into the documentation.
1028 # The default value is: NO.
1029
1030 INLINE_SOURCES = NO
1031
1032 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1033 # special comment blocks from generated source code fragments. Normal C, C++ and
1034 # Fortran comments will always remain visible.
1035 # The default value is: YES.
1036
1037 STRIP_CODE_COMMENTS = YES
1038
1039 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1040 # entity all documented functions referencing it will be listed.
1041 # The default value is: NO.
1042
1043 REFERENCED_BY_RELATION = NO
1044
1045 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1046 # all documented entities called/used by that function will be listed.
1047 # The default value is: NO.
1048
1049 REFERENCES_RELATION = NO
1050
1051 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1052 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1053 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1054 # link to the documentation.
1055 # The default value is: YES.
1056
1057 REFERENCES_LINK_SOURCE = YES
1058
1059 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1060 # source code will show a tooltip with additional information such as prototype,
1061 # brief description and links to the definition and documentation. Since this
1062 # will make the HTML file larger and loading of large files a bit slower, you
1063 # can opt to disable this feature.
1064 # The default value is: YES.
1065 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1066
1067 SOURCE_TOOLTIPS = YES
1068
1069 # If the USE_HTAGS tag is set to YES then the references to source code will
1070 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1071 # source browser. The htags tool is part of GNU's global source tagging system
1072 # (see https://www.gnu.org/software/global/global.html). You will need version
1073 # 4.8.6 or higher.
1074 #
1075 # To use it do the following:
1076 # - Install the latest version of global
1077 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1078 # - Make sure the INPUT points to the root of the source tree
1079 # - Run doxygen as normal
1080 #
1081 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1082 # tools must be available from the command line (i.e. in the search path).
1083 #
1084 # The result: instead of the source browser generated by doxygen, the links to
1085 # source code will now point to the output of htags.
1086 # The default value is: NO.
1087 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1088
1089 USE_HTAGS = NO
1090
1091 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1092 # verbatim copy of the header file for each class for which an include is
1093 # specified. Set to NO to disable this.
1094 # See also: Section \class.
1095 # The default value is: YES.
1096
1097 VERBATIM_HEADERS = YES
1098
1099 #---------------------------------------------------------------------------
1100 # Configuration options related to the alphabetical class index
1101 #---------------------------------------------------------------------------
1102
1103 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1104 # compounds will be generated. Enable this if the project contains a lot of
1105 # classes, structs, unions or interfaces.
1106 # The default value is: YES.
1107
1108 ALPHABETICAL_INDEX = YES
1109
1110 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1111 # which the alphabetical index list will be split.
1112 # Minimum value: 1, maximum value: 20, default value: 5.
1113 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1114
1115 COLS_IN_ALPHA_INDEX = 5
1116
1117 # In case all classes in a project start with a common prefix, all classes will
1118 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1119 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1120 # while generating the index headers.
1121 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1122
1123 IGNORE_PREFIX =
1124
1125 #---------------------------------------------------------------------------
1126 # Configuration options related to the HTML output
1127 #---------------------------------------------------------------------------
1128
1129 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1130 # The default value is: YES.
1131
1132 GENERATE_HTML = YES
1133
1134 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1135 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1136 # it.
1137 # The default directory is: html.
1138 # This tag requires that the tag GENERATE_HTML is set to YES.
1139
1140 HTML_OUTPUT = html
1141
1142 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1143 # generated HTML page (for example: .htm, .php, .asp).
1144 # The default value is: .html.
1145 # This tag requires that the tag GENERATE_HTML is set to YES.
1146
1147 HTML_FILE_EXTENSION = .html
1148
1149 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1150 # each generated HTML page. If the tag is left blank doxygen will generate a
1151 # standard header.
1152 #
1153 # To get valid HTML the header file that includes any scripts and style sheets
1154 # that doxygen needs, which is dependent on the configuration options used (e.g.
1155 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1156 # default header using
1157 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1158 # YourConfigFile
1159 # and then modify the file new_header.html. See also section "Doxygen usage"
1160 # for information on how to generate the default header that doxygen normally
1161 # uses.
1162 # Note: The header is subject to change so you typically have to regenerate the
1163 # default header when upgrading to a newer version of doxygen. For a description
1164 # of the possible markers and block names see the documentation.
1165 # This tag requires that the tag GENERATE_HTML is set to YES.
1166
1167 HTML_HEADER =
1168
1169 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1170 # generated HTML page. If the tag is left blank doxygen will generate a standard
1171 # footer. See HTML_HEADER for more information on how to generate a default
1172 # footer and what special commands can be used inside the footer. See also
1173 # section "Doxygen usage" for information on how to generate the default footer
1174 # that doxygen normally uses.
1175 # This tag requires that the tag GENERATE_HTML is set to YES.
1176
1177 HTML_FOOTER =
1178
1179 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1180 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1181 # the HTML output. If left blank doxygen will generate a default style sheet.
1182 # See also section "Doxygen usage" for information on how to generate the style
1183 # sheet that doxygen normally uses.
1184 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1185 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1186 # obsolete.
1187 # This tag requires that the tag GENERATE_HTML is set to YES.
1188
1189 HTML_STYLESHEET =
1190
1191 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1192 # cascading style sheets that are included after the standard style sheets
1193 # created by doxygen. Using this option one can overrule certain style aspects.
1194 # This is preferred over using HTML_STYLESHEET since it does not replace the
1195 # standard style sheet and is therefore more robust against future updates.
1196 # Doxygen will copy the style sheet files to the output directory.
1197 # Note: The order of the extra style sheet files is of importance (e.g. the last
1198 # style sheet in the list overrules the setting of the previous ones in the
1199 # list). For an example see the documentation.
1200 # This tag requires that the tag GENERATE_HTML is set to YES.
1201
1202 HTML_EXTRA_STYLESHEET =
1203
1204 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1205 # other source files which should be copied to the HTML output directory. Note
1206 # that these files will be copied to the base HTML output directory. Use the
1207 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1208 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1209 # files will be copied as-is; there are no commands or markers available.
1210 # This tag requires that the tag GENERATE_HTML is set to YES.
1211
1212 HTML_EXTRA_FILES =
1213
1214 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1215 # will adjust the colors in the style sheet and background images according to
1216 # this color. Hue is specified as an angle on a colorwheel, see
1217 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1218 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1219 # purple, and 360 is red again.
1220 # Minimum value: 0, maximum value: 359, default value: 220.
1221 # This tag requires that the tag GENERATE_HTML is set to YES.
1222
1223 HTML_COLORSTYLE_HUE = 220
1224
1225 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1226 # in the HTML output. For a value of 0 the output will use grayscales only. A
1227 # value of 255 will produce the most vivid colors.
1228 # Minimum value: 0, maximum value: 255, default value: 100.
1229 # This tag requires that the tag GENERATE_HTML is set to YES.
1230
1231 HTML_COLORSTYLE_SAT = 100
1232
1233 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1234 # luminance component of the colors in the HTML output. Values below 100
1235 # gradually make the output lighter, whereas values above 100 make the output
1236 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1237 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1238 # change the gamma.
1239 # Minimum value: 40, maximum value: 240, default value: 80.
1240 # This tag requires that the tag GENERATE_HTML is set to YES.
1241
1242 HTML_COLORSTYLE_GAMMA = 80
1243
1244 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1245 # page will contain the date and time when the page was generated. Setting this
1246 # to YES can help to show when doxygen was last run and thus if the
1247 # documentation is up to date.
1248 # The default value is: NO.
1249 # This tag requires that the tag GENERATE_HTML is set to YES.
1250
1251 HTML_TIMESTAMP = NO
1252
1253 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1254 # documentation will contain a main index with vertical navigation menus that
1255 # are dynamically created via Javascript. If disabled, the navigation index will
1256 # consists of multiple levels of tabs that are statically embedded in every HTML
1257 # page. Disable this option to support browsers that do not have Javascript,
1258 # like the Qt help browser.
1259 # The default value is: YES.
1260 # This tag requires that the tag GENERATE_HTML is set to YES.
1261
1262 HTML_DYNAMIC_MENUS = YES
1263
1264 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1265 # documentation will contain sections that can be hidden and shown after the
1266 # page has loaded.
1267 # The default value is: NO.
1268 # This tag requires that the tag GENERATE_HTML is set to YES.
1269
1270 HTML_DYNAMIC_SECTIONS = NO
1271
1272 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1273 # shown in the various tree structured indices initially; the user can expand
1274 # and collapse entries dynamically later on. Doxygen will expand the tree to
1275 # such a level that at most the specified number of entries are visible (unless
1276 # a fully collapsed tree already exceeds this amount). So setting the number of
1277 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1278 # representing an infinite number of entries and will result in a full expanded
1279 # tree by default.
1280 # Minimum value: 0, maximum value: 9999, default value: 100.
1281 # This tag requires that the tag GENERATE_HTML is set to YES.
1282
1283 HTML_INDEX_NUM_ENTRIES = 100
1284
1285 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1286 # generated that can be used as input for Apple's Xcode 3 integrated development
1287 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1288 # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1289 # Makefile in the HTML output directory. Running make will produce the docset in
1290 # that directory and running make install will install the docset in
1291 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1292 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1293 # genXcode/_index.html for more information.
1294 # The default value is: NO.
1295 # This tag requires that the tag GENERATE_HTML is set to YES.
1296
1297 GENERATE_DOCSET = NO
1298
1299 # This tag determines the name of the docset feed. A documentation feed provides
1300 # an umbrella under which multiple documentation sets from a single provider
1301 # (such as a company or product suite) can be grouped.
1302 # The default value is: Doxygen generated docs.
1303 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1304
1305 DOCSET_FEEDNAME = "Doxygen generated docs"
1306
1307 # This tag specifies a string that should uniquely identify the documentation
1308 # set bundle. This should be a reverse domain-name style string, e.g.
1309 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1310 # The default value is: org.doxygen.Project.
1311 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1312
1313 DOCSET_BUNDLE_ID = org.doxygen.Project
1314
1315 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1316 # the documentation publisher. This should be a reverse domain-name style
1317 # string, e.g. com.mycompany.MyDocSet.documentation.
1318 # The default value is: org.doxygen.Publisher.
1319 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1320
1321 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1322
1323 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1324 # The default value is: Publisher.
1325 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1326
1327 DOCSET_PUBLISHER_NAME = Publisher
1328
1329 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1330 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1331 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1332 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1333 # Windows.
1334 #
1335 # The HTML Help Workshop contains a compiler that can convert all HTML output
1336 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1337 # files are now used as the Windows 98 help format, and will replace the old
1338 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1339 # HTML files also contain an index, a table of contents, and you can search for
1340 # words in the documentation. The HTML workshop also contains a viewer for
1341 # compressed HTML files.
1342 # The default value is: NO.
1343 # This tag requires that the tag GENERATE_HTML is set to YES.
1344
1345 GENERATE_HTMLHELP = NO
1346
1347 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1348 # file. You can add a path in front of the file if the result should not be
1349 # written to the html output directory.
1350 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1351
1352 CHM_FILE =
1353
1354 # The HHC_LOCATION tag can be used to specify the location (absolute path
1355 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1356 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1357 # The file has to be specified with full path.
1358 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1359
1360 HHC_LOCATION =
1361
1362 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1363 # (YES) or that it should be included in the master .chm file (NO).
1364 # The default value is: NO.
1365 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1366
1367 GENERATE_CHI = NO
1368
1369 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1370 # and project file content.
1371 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1372
1373 CHM_INDEX_ENCODING =
1374
1375 # The BINARY_TOC flag controls whether a binary table of contents is generated
1376 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1377 # enables the Previous and Next buttons.
1378 # The default value is: NO.
1379 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1380
1381 BINARY_TOC = NO
1382
1383 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1384 # the table of contents of the HTML help documentation and to the tree view.
1385 # The default value is: NO.
1386 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1387
1388 TOC_EXPAND = NO
1389
1390 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1391 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1392 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1393 # (.qch) of the generated HTML documentation.
1394 # The default value is: NO.
1395 # This tag requires that the tag GENERATE_HTML is set to YES.
1396
1397 GENERATE_QHP = NO
1398
1399 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1400 # the file name of the resulting .qch file. The path specified is relative to
1401 # the HTML output folder.
1402 # This tag requires that the tag GENERATE_QHP is set to YES.
1403
1404 QCH_FILE =
1405
1406 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1407 # Project output. For more information please see Qt Help Project / Namespace
1408 # (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1409 # The default value is: org.doxygen.Project.
1410 # This tag requires that the tag GENERATE_QHP is set to YES.
1411
1412 QHP_NAMESPACE = org.doxygen.Project
1413
1414 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1415 # Help Project output. For more information please see Qt Help Project / Virtual
1416 # Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1417 # folders).
1418 # The default value is: doc.
1419 # This tag requires that the tag GENERATE_QHP is set to YES.
1420
1421 QHP_VIRTUAL_FOLDER = doc
1422
1423 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1424 # filter to add. For more information please see Qt Help Project / Custom
1425 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1426 # filters).
1427 # This tag requires that the tag GENERATE_QHP is set to YES.
1428
1429 QHP_CUST_FILTER_NAME =
1430
1431 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1432 # custom filter to add. For more information please see Qt Help Project / Custom
1433 # Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1434 # filters).
1435 # This tag requires that the tag GENERATE_QHP is set to YES.
1436
1437 QHP_CUST_FILTER_ATTRS =
1438
1439 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1440 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1441 # http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1442 # This tag requires that the tag GENERATE_QHP is set to YES.
1443
1444 QHP_SECT_FILTER_ATTRS =
1445
1446 # The QHG_LOCATION tag can be used to specify the location of Qt's
1447 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1448 # generated .qhp file.
1449 # This tag requires that the tag GENERATE_QHP is set to YES.
1450
1451 QHG_LOCATION =
1452
1453 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1454 # generated, together with the HTML files, they form an Eclipse help plugin. To
1455 # install this plugin and make it available under the help contents menu in
1456 # Eclipse, the contents of the directory containing the HTML and XML files needs
1457 # to be copied into the plugins directory of eclipse. The name of the directory
1458 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1459 # After copying Eclipse needs to be restarted before the help appears.
1460 # The default value is: NO.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1462
1463 GENERATE_ECLIPSEHELP = NO
1464
1465 # A unique identifier for the Eclipse help plugin. When installing the plugin
1466 # the directory name containing the HTML and XML files should also have this
1467 # name. Each documentation set should have its own identifier.
1468 # The default value is: org.doxygen.Project.
1469 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1470
1471 ECLIPSE_DOC_ID = org.doxygen.Project
1472
1473 # If you want full control over the layout of the generated HTML pages it might
1474 # be necessary to disable the index and replace it with your own. The
1475 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1476 # of each HTML page. A value of NO enables the index and the value YES disables
1477 # it. Since the tabs in the index contain the same information as the navigation
1478 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1479 # The default value is: NO.
1480 # This tag requires that the tag GENERATE_HTML is set to YES.
1481
1482 DISABLE_INDEX = NO
1483
1484 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1485 # structure should be generated to display hierarchical information. If the tag
1486 # value is set to YES, a side panel will be generated containing a tree-like
1487 # index structure (just like the one that is generated for HTML Help). For this
1488 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1489 # (i.e. any modern browser). Windows users are probably better off using the
1490 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1491 # further fine-tune the look of the index. As an example, the default style
1492 # sheet generated by doxygen has an example that shows how to put an image at
1493 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1494 # the same information as the tab index, you could consider setting
1495 # DISABLE_INDEX to YES when enabling this option.
1496 # The default value is: NO.
1497 # This tag requires that the tag GENERATE_HTML is set to YES.
1498
1499 GENERATE_TREEVIEW = NO
1500
1501 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1502 # doxygen will group on one line in the generated HTML documentation.
1503 #
1504 # Note that a value of 0 will completely suppress the enum values from appearing
1505 # in the overview section.
1506 # Minimum value: 0, maximum value: 20, default value: 4.
1507 # This tag requires that the tag GENERATE_HTML is set to YES.
1508
1509 ENUM_VALUES_PER_LINE = 4
1510
1511 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1512 # to set the initial width (in pixels) of the frame in which the tree is shown.
1513 # Minimum value: 0, maximum value: 1500, default value: 250.
1514 # This tag requires that the tag GENERATE_HTML is set to YES.
1515
1516 TREEVIEW_WIDTH = 250
1517
1518 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1519 # external symbols imported via tag files in a separate window.
1520 # The default value is: NO.
1521 # This tag requires that the tag GENERATE_HTML is set to YES.
1522
1523 EXT_LINKS_IN_WINDOW = NO
1524
1525 # Use this tag to change the font size of LaTeX formulas included as images in
1526 # the HTML documentation. When you change the font size after a successful
1527 # doxygen run you need to manually remove any form_*.png images from the HTML
1528 # output directory to force them to be regenerated.
1529 # Minimum value: 8, maximum value: 50, default value: 10.
1530 # This tag requires that the tag GENERATE_HTML is set to YES.
1531
1532 FORMULA_FONTSIZE = 10
1533
1534 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1535 # generated for formulas are transparent PNGs. Transparent PNGs are not
1536 # supported properly for IE 6.0, but are supported on all modern browsers.
1537 #
1538 # Note that when changing this option you need to delete any form_*.png files in
1539 # the HTML output directory before the changes have effect.
1540 # The default value is: YES.
1541 # This tag requires that the tag GENERATE_HTML is set to YES.
1542
1543 FORMULA_TRANSPARENT = YES
1544
1545 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1546 # https://www.mathjax.org) which uses client side Javascript for the rendering
1547 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1548 # installed or if you want to formulas look prettier in the HTML output. When
1549 # enabled you may also need to install MathJax separately and configure the path
1550 # to it using the MATHJAX_RELPATH option.
1551 # The default value is: NO.
1552 # This tag requires that the tag GENERATE_HTML is set to YES.
1553
1554 USE_MATHJAX = NO
1555
1556 # When MathJax is enabled you can set the default output format to be used for
1557 # the MathJax output. See the MathJax site (see:
1558 # http://docs.mathjax.org/en/latest/output.html) for more details.
1559 # Possible values are: HTML-CSS (which is slower, but has the best
1560 # compatibility), NativeMML (i.e. MathML) and SVG.
1561 # The default value is: HTML-CSS.
1562 # This tag requires that the tag USE_MATHJAX is set to YES.
1563
1564 MATHJAX_FORMAT = HTML-CSS
1565
1566 # When MathJax is enabled you need to specify the location relative to the HTML
1567 # output directory using the MATHJAX_RELPATH option. The destination directory
1568 # should contain the MathJax.js script. For instance, if the mathjax directory
1569 # is located at the same level as the HTML output directory, then
1570 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1571 # Content Delivery Network so you can quickly see the result without installing
1572 # MathJax. However, it is strongly recommended to install a local copy of
1573 # MathJax from https://www.mathjax.org before deployment.
1574 # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1575 # This tag requires that the tag USE_MATHJAX is set to YES.
1576
1577 MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1578
1579 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1580 # extension names that should be enabled during MathJax rendering. For example
1581 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1582 # This tag requires that the tag USE_MATHJAX is set to YES.
1583
1584 MATHJAX_EXTENSIONS =
1585
1586 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1587 # of code that will be used on startup of the MathJax code. See the MathJax site
1588 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1589 # example see the documentation.
1590 # This tag requires that the tag USE_MATHJAX is set to YES.
1591
1592 MATHJAX_CODEFILE =
1593
1594 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1595 # the HTML output. The underlying search engine uses javascript and DHTML and
1596 # should work on any modern browser. Note that when using HTML help
1597 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1598 # there is already a search function so this one should typically be disabled.
1599 # For large projects the javascript based search engine can be slow, then
1600 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1601 # search using the keyboard; to jump to the search box use <access key> + S
1602 # (what the <access key> is depends on the OS and browser, but it is typically
1603 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1604 # key> to jump into the search results window, the results can be navigated
1605 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1606 # the search. The filter options can be selected when the cursor is inside the
1607 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1608 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1609 # option.
1610 # The default value is: YES.
1611 # This tag requires that the tag GENERATE_HTML is set to YES.
1612
1613 SEARCHENGINE = YES
1614
1615 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1616 # implemented using a web server instead of a web client using Javascript. There
1617 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1618 # setting. When disabled, doxygen will generate a PHP script for searching and
1619 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1620 # and searching needs to be provided by external tools. See the section
1621 # "External Indexing and Searching" for details.
1622 # The default value is: NO.
1623 # This tag requires that the tag SEARCHENGINE is set to YES.
1624
1625 SERVER_BASED_SEARCH = NO
1626
1627 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1628 # script for searching. Instead the search results are written to an XML file
1629 # which needs to be processed by an external indexer. Doxygen will invoke an
1630 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1631 # search results.
1632 #
1633 # Doxygen ships with an example indexer (doxyindexer) and search engine
1634 # (doxysearch.cgi) which are based on the open source search engine library
1635 # Xapian (see: https://xapian.org/).
1636 #
1637 # See the section "External Indexing and Searching" for details.
1638 # The default value is: NO.
1639 # This tag requires that the tag SEARCHENGINE is set to YES.
1640
1641 EXTERNAL_SEARCH = NO
1642
1643 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1644 # which will return the search results when EXTERNAL_SEARCH is enabled.
1645 #
1646 # Doxygen ships with an example indexer (doxyindexer) and search engine
1647 # (doxysearch.cgi) which are based on the open source search engine library
1648 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1649 # Searching" for details.
1650 # This tag requires that the tag SEARCHENGINE is set to YES.
1651
1652 SEARCHENGINE_URL =
1653
1654 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1655 # search data is written to a file for indexing by an external tool. With the
1656 # SEARCHDATA_FILE tag the name of this file can be specified.
1657 # The default file is: searchdata.xml.
1658 # This tag requires that the tag SEARCHENGINE is set to YES.
1659
1660 SEARCHDATA_FILE = searchdata.xml
1661
1662 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1663 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1664 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1665 # projects and redirect the results back to the right project.
1666 # This tag requires that the tag SEARCHENGINE is set to YES.
1667
1668 EXTERNAL_SEARCH_ID =
1669
1670 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1671 # projects other than the one defined by this configuration file, but that are
1672 # all added to the same external search index. Each project needs to have a
1673 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1674 # to a relative location where the documentation can be found. The format is:
1675 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1676 # This tag requires that the tag SEARCHENGINE is set to YES.
1677
1678 EXTRA_SEARCH_MAPPINGS =
1679
1680 #---------------------------------------------------------------------------
1681 # Configuration options related to the LaTeX output
1682 #---------------------------------------------------------------------------
1683
1684 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1685 # The default value is: YES.
1686
1687 GENERATE_LATEX = YES
1688
1689 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1690 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1691 # it.
1692 # The default directory is: latex.
1693 # This tag requires that the tag GENERATE_LATEX is set to YES.
1694
1695 LATEX_OUTPUT = latex
1696
1697 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1698 # invoked.
1699 #
1700 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1701 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1702 # chosen this is overwritten by pdflatex. For specific output languages the
1703 # default can have been set differently, this depends on the implementation of
1704 # the output language.
1705 # This tag requires that the tag GENERATE_LATEX is set to YES.
1706
1707 LATEX_CMD_NAME =
1708
1709 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1710 # index for LaTeX.
1711 # Note: This tag is used in the Makefile / make.bat.
1712 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1713 # (.tex).
1714 # The default file is: makeindex.
1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
1716
1717 MAKEINDEX_CMD_NAME = makeindex
1718
1719 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1720 # generate index for LaTeX.
1721 # Note: This tag is used in the generated output file (.tex).
1722 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1723 # The default value is: \makeindex.
1724 # This tag requires that the tag GENERATE_LATEX is set to YES.
1725
1726 LATEX_MAKEINDEX_CMD = \makeindex
1727
1728 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1729 # documents. This may be useful for small projects and may help to save some
1730 # trees in general.
1731 # The default value is: NO.
1732 # This tag requires that the tag GENERATE_LATEX is set to YES.
1733
1734 COMPACT_LATEX = NO
1735
1736 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1737 # printer.
1738 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1739 # 14 inches) and executive (7.25 x 10.5 inches).
1740 # The default value is: a4.
1741 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742
1743 PAPER_TYPE = a4
1744
1745 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1746 # that should be included in the LaTeX output. The package can be specified just
1747 # by its name or with the correct syntax as to be used with the LaTeX
1748 # \usepackage command. To get the times font for instance you can specify :
1749 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1750 # To use the option intlimits with the amsmath package you can specify:
1751 # EXTRA_PACKAGES=[intlimits]{amsmath}
1752 # If left blank no extra packages will be included.
1753 # This tag requires that the tag GENERATE_LATEX is set to YES.
1754
1755 EXTRA_PACKAGES =
1756
1757 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1758 # generated LaTeX document. The header should contain everything until the first
1759 # chapter. If it is left blank doxygen will generate a standard header. See
1760 # section "Doxygen usage" for information on how to let doxygen write the
1761 # default header to a separate file.
1762 #
1763 # Note: Only use a user-defined header if you know what you are doing! The
1764 # following commands have a special meaning inside the header: $title,
1765 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1766 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1767 # string, for the replacement values of the other commands the user is referred
1768 # to HTML_HEADER.
1769 # This tag requires that the tag GENERATE_LATEX is set to YES.
1770
1771 LATEX_HEADER =
1772
1773 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1774 # generated LaTeX document. The footer should contain everything after the last
1775 # chapter. If it is left blank doxygen will generate a standard footer. See
1776 # LATEX_HEADER for more information on how to generate a default footer and what
1777 # special commands can be used inside the footer.
1778 #
1779 # Note: Only use a user-defined footer if you know what you are doing!
1780 # This tag requires that the tag GENERATE_LATEX is set to YES.
1781
1782 LATEX_FOOTER =
1783
1784 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1785 # LaTeX style sheets that are included after the standard style sheets created
1786 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1787 # will copy the style sheet files to the output directory.
1788 # Note: The order of the extra style sheet files is of importance (e.g. the last
1789 # style sheet in the list overrules the setting of the previous ones in the
1790 # list).
1791 # This tag requires that the tag GENERATE_LATEX is set to YES.
1792
1793 LATEX_EXTRA_STYLESHEET =
1794
1795 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1796 # other source files which should be copied to the LATEX_OUTPUT output
1797 # directory. Note that the files will be copied as-is; there are no commands or
1798 # markers available.
1799 # This tag requires that the tag GENERATE_LATEX is set to YES.
1800
1801 LATEX_EXTRA_FILES =
1802
1803 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1804 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1805 # contain links (just like the HTML output) instead of page references. This
1806 # makes the output suitable for online browsing using a PDF viewer.
1807 # The default value is: YES.
1808 # This tag requires that the tag GENERATE_LATEX is set to YES.
1809
1810 PDF_HYPERLINKS = YES
1811
1812 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1813 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1814 # higher quality PDF documentation.
1815 # The default value is: YES.
1816 # This tag requires that the tag GENERATE_LATEX is set to YES.
1817
1818 USE_PDFLATEX = YES
1819
1820 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1821 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1822 # if errors occur, instead of asking the user for help. This option is also used
1823 # when generating formulas in HTML.
1824 # The default value is: NO.
1825 # This tag requires that the tag GENERATE_LATEX is set to YES.
1826
1827 LATEX_BATCHMODE = NO
1828
1829 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1830 # index chapters (such as File Index, Compound Index, etc.) in the output.
1831 # The default value is: NO.
1832 # This tag requires that the tag GENERATE_LATEX is set to YES.
1833
1834 LATEX_HIDE_INDICES = NO
1835
1836 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1837 # code with syntax highlighting in the LaTeX output.
1838 #
1839 # Note that which sources are shown also depends on other settings such as
1840 # SOURCE_BROWSER.
1841 # The default value is: NO.
1842 # This tag requires that the tag GENERATE_LATEX is set to YES.
1843
1844 LATEX_SOURCE_CODE = NO
1845
1846 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1847 # bibliography, e.g. plainnat, or ieeetr. See
1848 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1849 # The default value is: plain.
1850 # This tag requires that the tag GENERATE_LATEX is set to YES.
1851
1852 LATEX_BIB_STYLE = plain
1853
1854 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1855 # page will contain the date and time when the page was generated. Setting this
1856 # to NO can help when comparing the output of multiple runs.
1857 # The default value is: NO.
1858 # This tag requires that the tag GENERATE_LATEX is set to YES.
1859
1860 LATEX_TIMESTAMP = NO
1861
1862 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1863 # path from which the emoji images will be read. If a relative path is entered,
1864 # it will be relative to the LATEX_OUTPUT directory. If left blank the
1865 # LATEX_OUTPUT directory will be used.
1866 # This tag requires that the tag GENERATE_LATEX is set to YES.
1867
1868 LATEX_EMOJI_DIRECTORY =
1869
1870 #---------------------------------------------------------------------------
1871 # Configuration options related to the RTF output
1872 #---------------------------------------------------------------------------
1873
1874 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1875 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1876 # readers/editors.
1877 # The default value is: NO.
1878
1879 GENERATE_RTF = NO
1880
1881 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1882 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1883 # it.
1884 # The default directory is: rtf.
1885 # This tag requires that the tag GENERATE_RTF is set to YES.
1886
1887 RTF_OUTPUT = rtf
1888
1889 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1890 # documents. This may be useful for small projects and may help to save some
1891 # trees in general.
1892 # The default value is: NO.
1893 # This tag requires that the tag GENERATE_RTF is set to YES.
1894
1895 COMPACT_RTF = NO
1896
1897 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1898 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1899 # output) instead of page references. This makes the output suitable for online
1900 # browsing using Word or some other Word compatible readers that support those
1901 # fields.
1902 #
1903 # Note: WordPad (write) and others do not support links.
1904 # The default value is: NO.
1905 # This tag requires that the tag GENERATE_RTF is set to YES.
1906
1907 RTF_HYPERLINKS = NO
1908
1909 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1910 # configuration file, i.e. a series of assignments. You only have to provide
1911 # replacements, missing definitions are set to their default value.
1912 #
1913 # See also section "Doxygen usage" for information on how to generate the
1914 # default style sheet that doxygen normally uses.
1915 # This tag requires that the tag GENERATE_RTF is set to YES.
1916
1917 RTF_STYLESHEET_FILE =
1918
1919 # Set optional variables used in the generation of an RTF document. Syntax is
1920 # similar to doxygen's configuration file. A template extensions file can be
1921 # generated using doxygen -e rtf extensionFile.
1922 # This tag requires that the tag GENERATE_RTF is set to YES.
1923
1924 RTF_EXTENSIONS_FILE =
1925
1926 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1927 # with syntax highlighting in the RTF output.
1928 #
1929 # Note that which sources are shown also depends on other settings such as
1930 # SOURCE_BROWSER.
1931 # The default value is: NO.
1932 # This tag requires that the tag GENERATE_RTF is set to YES.
1933
1934 RTF_SOURCE_CODE = NO
1935
1936 #---------------------------------------------------------------------------
1937 # Configuration options related to the man page output
1938 #---------------------------------------------------------------------------
1939
1940 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1941 # classes and files.
1942 # The default value is: NO.
1943
1944 GENERATE_MAN = NO
1945
1946 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1947 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1948 # it. A directory man3 will be created inside the directory specified by
1949 # MAN_OUTPUT.
1950 # The default directory is: man.
1951 # This tag requires that the tag GENERATE_MAN is set to YES.
1952
1953 MAN_OUTPUT = man
1954
1955 # The MAN_EXTENSION tag determines the extension that is added to the generated
1956 # man pages. In case the manual section does not start with a number, the number
1957 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1958 # optional.
1959 # The default value is: .3.
1960 # This tag requires that the tag GENERATE_MAN is set to YES.
1961
1962 MAN_EXTENSION = .3
1963
1964 # The MAN_SUBDIR tag determines the name of the directory created within
1965 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1966 # MAN_EXTENSION with the initial . removed.
1967 # This tag requires that the tag GENERATE_MAN is set to YES.
1968
1969 MAN_SUBDIR =
1970
1971 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1972 # will generate one additional man file for each entity documented in the real
1973 # man page(s). These additional files only source the real man page, but without
1974 # them the man command would be unable to find the correct page.
1975 # The default value is: NO.
1976 # This tag requires that the tag GENERATE_MAN is set to YES.
1977
1978 MAN_LINKS = NO
1979
1980 #---------------------------------------------------------------------------
1981 # Configuration options related to the XML output
1982 #---------------------------------------------------------------------------
1983
1984 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1985 # captures the structure of the code including all documentation.
1986 # The default value is: NO.
1987
1988 GENERATE_XML = NO
1989
1990 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1991 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1992 # it.
1993 # The default directory is: xml.
1994 # This tag requires that the tag GENERATE_XML is set to YES.
1995
1996 XML_OUTPUT = xml
1997
1998 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1999 # listings (including syntax highlighting and cross-referencing information) to
2000 # the XML output. Note that enabling this will significantly increase the size
2001 # of the XML output.
2002 # The default value is: YES.
2003 # This tag requires that the tag GENERATE_XML is set to YES.
2004
2005 XML_PROGRAMLISTING = YES
2006
2007 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2008 # namespace members in file scope as well, matching the HTML output.
2009 # The default value is: NO.
2010 # This tag requires that the tag GENERATE_XML is set to YES.
2011
2012 XML_NS_MEMB_FILE_SCOPE = NO
2013
2014 #---------------------------------------------------------------------------
2015 # Configuration options related to the DOCBOOK output
2016 #---------------------------------------------------------------------------
2017
2018 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2019 # that can be used to generate PDF.
2020 # The default value is: NO.
2021
2022 GENERATE_DOCBOOK = NO
2023
2024 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2025 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2026 # front of it.
2027 # The default directory is: docbook.
2028 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2029
2030 DOCBOOK_OUTPUT = docbook
2031
2032 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2033 # program listings (including syntax highlighting and cross-referencing
2034 # information) to the DOCBOOK output. Note that enabling this will significantly
2035 # increase the size of the DOCBOOK output.
2036 # The default value is: NO.
2037 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2038
2039 DOCBOOK_PROGRAMLISTING = NO
2040
2041 #---------------------------------------------------------------------------
2042 # Configuration options for the AutoGen Definitions output
2043 #---------------------------------------------------------------------------
2044
2045 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2046 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2047 # the structure of the code including all documentation. Note that this feature
2048 # is still experimental and incomplete at the moment.
2049 # The default value is: NO.
2050
2051 GENERATE_AUTOGEN_DEF = NO
2052
2053 #---------------------------------------------------------------------------
2054 # Configuration options related to the Perl module output
2055 #---------------------------------------------------------------------------
2056
2057 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2058 # file that captures the structure of the code including all documentation.
2059 #
2060 # Note that this feature is still experimental and incomplete at the moment.
2061 # The default value is: NO.
2062
2063 GENERATE_PERLMOD = NO
2064
2065 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2066 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2067 # output from the Perl module output.
2068 # The default value is: NO.
2069 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2070
2071 PERLMOD_LATEX = NO
2072
2073 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2074 # formatted so it can be parsed by a human reader. This is useful if you want to
2075 # understand what is going on. On the other hand, if this tag is set to NO, the
2076 # size of the Perl module output will be much smaller and Perl will parse it
2077 # just the same.
2078 # The default value is: YES.
2079 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2080
2081 PERLMOD_PRETTY = YES
2082
2083 # The names of the make variables in the generated doxyrules.make file are
2084 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2085 # so different doxyrules.make files included by the same Makefile don't
2086 # overwrite each other's variables.
2087 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2088
2089 PERLMOD_MAKEVAR_PREFIX =
2090
2091 #---------------------------------------------------------------------------
2092 # Configuration options related to the preprocessor
2093 #---------------------------------------------------------------------------
2094
2095 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2096 # C-preprocessor directives found in the sources and include files.
2097 # The default value is: YES.
2098
2099 ENABLE_PREPROCESSING = YES
2100
2101 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2102 # in the source code. If set to NO, only conditional compilation will be
2103 # performed. Macro expansion can be done in a controlled way by setting
2104 # EXPAND_ONLY_PREDEF to YES.
2105 # The default value is: NO.
2106 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2107
2108 MACRO_EXPANSION = NO
2109
2110 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2111 # the macro expansion is limited to the macros specified with the PREDEFINED and
2112 # EXPAND_AS_DEFINED tags.
2113 # The default value is: NO.
2114 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2115
2116 EXPAND_ONLY_PREDEF = NO
2117
2118 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2119 # INCLUDE_PATH will be searched if a #include is found.
2120 # The default value is: YES.
2121 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2122
2123 SEARCH_INCLUDES = YES
2124
2125 # The INCLUDE_PATH tag can be used to specify one or more directories that
2126 # contain include files that are not input files but should be processed by the
2127 # preprocessor.
2128 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2129
2130 INCLUDE_PATH =
2131
2132 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2133 # patterns (like *.h and *.hpp) to filter out the header-files in the
2134 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2135 # used.
2136 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2137
2138 INCLUDE_FILE_PATTERNS =
2139
2140 # The PREDEFINED tag can be used to specify one or more macro names that are
2141 # defined before the preprocessor is started (similar to the -D option of e.g.
2142 # gcc). The argument of the tag is a list of macros of the form: name or
2143 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2144 # is assumed. To prevent a macro definition from being undefined via #undef or
2145 # recursively expanded use the := operator instead of the = operator.
2146 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2147
2148 PREDEFINED =
2149
2150 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2151 # tag can be used to specify a list of macro names that should be expanded. The
2152 # macro definition that is found in the sources will be used. Use the PREDEFINED
2153 # tag if you want to use a different macro definition that overrules the
2154 # definition found in the source code.
2155 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2156
2157 EXPAND_AS_DEFINED =
2158
2159 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2160 # remove all references to function-like macros that are alone on a line, have
2161 # an all uppercase name, and do not end with a semicolon. Such function macros
2162 # are typically used for boiler-plate code, and will confuse the parser if not
2163 # removed.
2164 # The default value is: YES.
2165 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2166
2167 SKIP_FUNCTION_MACROS = YES
2168
2169 #---------------------------------------------------------------------------
2170 # Configuration options related to external references
2171 #---------------------------------------------------------------------------
2172
2173 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2174 # file the location of the external documentation should be added. The format of
2175 # a tag file without this location is as follows:
2176 # TAGFILES = file1 file2 ...
2177 # Adding location for the tag files is done as follows:
2178 # TAGFILES = file1=loc1 "file2 = loc2" ...
2179 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2180 # section "Linking to external documentation" for more information about the use
2181 # of tag files.
2182 # Note: Each tag file must have a unique name (where the name does NOT include
2183 # the path). If a tag file is not located in the directory in which doxygen is
2184 # run, you must also specify the path to the tagfile here.
2185
2186 TAGFILES =
2187
2188 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2189 # tag file that is based on the input files it reads. See section "Linking to
2190 # external documentation" for more information about the usage of tag files.
2191
2192 GENERATE_TAGFILE =
2193
2194 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2195 # the class index. If set to NO, only the inherited external classes will be
2196 # listed.
2197 # The default value is: NO.
2198
2199 ALLEXTERNALS = NO
2200
2201 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2202 # in the modules index. If set to NO, only the current project's groups will be
2203 # listed.
2204 # The default value is: YES.
2205
2206 EXTERNAL_GROUPS = YES
2207
2208 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2209 # the related pages index. If set to NO, only the current project's pages will
2210 # be listed.
2211 # The default value is: YES.
2212
2213 EXTERNAL_PAGES = YES
2214
2215 # The PERL_PATH should be the absolute path and name of the perl script
2216 # interpreter (i.e. the result of 'which perl').
2217 # The default file (with absolute path) is: /usr/bin/perl.
2218
2219 PERL_PATH = /usr/bin/perl
2220
2221 #---------------------------------------------------------------------------
2222 # Configuration options related to the dot tool
2223 #---------------------------------------------------------------------------
2224
2225 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2226 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2227 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2228 # disabled, but it is recommended to install and use dot, since it yields more
2229 # powerful graphs.
2230 # The default value is: YES.
2231
2232 CLASS_DIAGRAMS = YES
2233
2234 # You can define message sequence charts within doxygen comments using the \msc
2235 # command. Doxygen will then run the mscgen tool (see:
2236 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2237 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2238 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2239 # default search path.
2240
2241 MSCGEN_PATH =
2242
2243 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2244 # then run dia to produce the diagram and insert it in the documentation. The
2245 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2246 # If left empty dia is assumed to be found in the default search path.
2247
2248 DIA_PATH =
2249
2250 # If set to YES the inheritance and collaboration graphs will hide inheritance
2251 # and usage relations if the target is undocumented or is not a class.
2252 # The default value is: YES.
2253
2254 HIDE_UNDOC_RELATIONS = YES
2255
2256 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2257 # available from the path. This tool is part of Graphviz (see:
2258 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2259 # Bell Labs. The other options in this section have no effect if this option is
2260 # set to NO
2261 # The default value is: NO.
2262
2263 HAVE_DOT = NO
2264
2265 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2266 # to run in parallel. When set to 0 doxygen will base this on the number of
2267 # processors available in the system. You can set it explicitly to a value
2268 # larger than 0 to get control over the balance between CPU load and processing
2269 # speed.
2270 # Minimum value: 0, maximum value: 32, default value: 0.
2271 # This tag requires that the tag HAVE_DOT is set to YES.
2272
2273 DOT_NUM_THREADS = 0
2274
2275 # When you want a differently looking font in the dot files that doxygen
2276 # generates you can specify the font name using DOT_FONTNAME. You need to make
2277 # sure dot is able to find the font, which can be done by putting it in a
2278 # standard location or by setting the DOTFONTPATH environment variable or by
2279 # setting DOT_FONTPATH to the directory containing the font.
2280 # The default value is: Helvetica.
2281 # This tag requires that the tag HAVE_DOT is set to YES.
2282
2283 DOT_FONTNAME = Helvetica
2284
2285 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2286 # dot graphs.
2287 # Minimum value: 4, maximum value: 24, default value: 10.
2288 # This tag requires that the tag HAVE_DOT is set to YES.
2289
2290 DOT_FONTSIZE = 10
2291
2292 # By default doxygen will tell dot to use the default font as specified with
2293 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2294 # the path where dot can find it using this tag.
2295 # This tag requires that the tag HAVE_DOT is set to YES.
2296
2297 DOT_FONTPATH =
2298
2299 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2300 # each documented class showing the direct and indirect inheritance relations.
2301 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2302 # The default value is: YES.
2303 # This tag requires that the tag HAVE_DOT is set to YES.
2304
2305 CLASS_GRAPH = YES
2306
2307 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2308 # graph for each documented class showing the direct and indirect implementation
2309 # dependencies (inheritance, containment, and class references variables) of the
2310 # class with other documented classes.
2311 # The default value is: YES.
2312 # This tag requires that the tag HAVE_DOT is set to YES.
2313
2314 COLLABORATION_GRAPH = YES
2315
2316 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2317 # groups, showing the direct groups dependencies.
2318 # The default value is: YES.
2319 # This tag requires that the tag HAVE_DOT is set to YES.
2320
2321 GROUP_GRAPHS = YES
2322
2323 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2324 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2325 # Language.
2326 # The default value is: NO.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2328
2329 UML_LOOK = NO
2330
2331 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2332 # class node. If there are many fields or methods and many nodes the graph may
2333 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2334 # number of items for each type to make the size more manageable. Set this to 0
2335 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2336 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2337 # but if the number exceeds 15, the total amount of fields shown is limited to
2338 # 10.
2339 # Minimum value: 0, maximum value: 100, default value: 10.
2340 # This tag requires that the tag HAVE_DOT is set to YES.
2341
2342 UML_LIMIT_NUM_FIELDS = 10
2343
2344 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2345 # collaboration graphs will show the relations between templates and their
2346 # instances.
2347 # The default value is: NO.
2348 # This tag requires that the tag HAVE_DOT is set to YES.
2349
2350 TEMPLATE_RELATIONS = NO
2351
2352 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2353 # YES then doxygen will generate a graph for each documented file showing the
2354 # direct and indirect include dependencies of the file with other documented
2355 # files.
2356 # The default value is: YES.
2357 # This tag requires that the tag HAVE_DOT is set to YES.
2358
2359 INCLUDE_GRAPH = YES
2360
2361 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2362 # set to YES then doxygen will generate a graph for each documented file showing
2363 # the direct and indirect include dependencies of the file with other documented
2364 # files.
2365 # The default value is: YES.
2366 # This tag requires that the tag HAVE_DOT is set to YES.
2367
2368 INCLUDED_BY_GRAPH = YES
2369
2370 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2371 # dependency graph for every global function or class method.
2372 #
2373 # Note that enabling this option will significantly increase the time of a run.
2374 # So in most cases it will be better to enable call graphs for selected
2375 # functions only using the \callgraph command. Disabling a call graph can be
2376 # accomplished by means of the command \hidecallgraph.
2377 # The default value is: NO.
2378 # This tag requires that the tag HAVE_DOT is set to YES.
2379
2380 CALL_GRAPH = NO
2381
2382 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2383 # dependency graph for every global function or class method.
2384 #
2385 # Note that enabling this option will significantly increase the time of a run.
2386 # So in most cases it will be better to enable caller graphs for selected
2387 # functions only using the \callergraph command. Disabling a caller graph can be
2388 # accomplished by means of the command \hidecallergraph.
2389 # The default value is: NO.
2390 # This tag requires that the tag HAVE_DOT is set to YES.
2391
2392 CALLER_GRAPH = NO
2393
2394 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2395 # hierarchy of all classes instead of a textual one.
2396 # The default value is: YES.
2397 # This tag requires that the tag HAVE_DOT is set to YES.
2398
2399 GRAPHICAL_HIERARCHY = YES
2400
2401 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2402 # dependencies a directory has on other directories in a graphical way. The
2403 # dependency relations are determined by the #include relations between the
2404 # files in the directories.
2405 # The default value is: YES.
2406 # This tag requires that the tag HAVE_DOT is set to YES.
2407
2408 DIRECTORY_GRAPH = YES
2409
2410 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2411 # generated by dot. For an explanation of the image formats see the section
2412 # output formats in the documentation of the dot tool (Graphviz (see:
2413 # http://www.graphviz.org/)).
2414 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2415 # to make the SVG files visible in IE 9+ (other browsers do not have this
2416 # requirement).
2417 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2418 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2419 # png:gdiplus:gdiplus.
2420 # The default value is: png.
2421 # This tag requires that the tag HAVE_DOT is set to YES.
2422
2423 DOT_IMAGE_FORMAT = png
2424
2425 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2426 # enable generation of interactive SVG images that allow zooming and panning.
2427 #
2428 # Note that this requires a modern browser other than Internet Explorer. Tested
2429 # and working are Firefox, Chrome, Safari, and Opera.
2430 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2431 # the SVG files visible. Older versions of IE do not have SVG support.
2432 # The default value is: NO.
2433 # This tag requires that the tag HAVE_DOT is set to YES.
2434
2435 INTERACTIVE_SVG = NO
2436
2437 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2438 # found. If left blank, it is assumed the dot tool can be found in the path.
2439 # This tag requires that the tag HAVE_DOT is set to YES.
2440
2441 DOT_PATH =
2442
2443 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2444 # contain dot files that are included in the documentation (see the \dotfile
2445 # command).
2446 # This tag requires that the tag HAVE_DOT is set to YES.
2447
2448 DOTFILE_DIRS =
2449
2450 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2451 # contain msc files that are included in the documentation (see the \mscfile
2452 # command).
2453
2454 MSCFILE_DIRS =
2455
2456 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2457 # contain dia files that are included in the documentation (see the \diafile
2458 # command).
2459
2460 DIAFILE_DIRS =
2461
2462 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2463 # path where java can find the plantuml.jar file. If left blank, it is assumed
2464 # PlantUML is not used or called during a preprocessing step. Doxygen will
2465 # generate a warning when it encounters a \startuml command in this case and
2466 # will not generate output for the diagram.
2467
2468 PLANTUML_JAR_PATH =
2469
2470 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2471 # configuration file for plantuml.
2472
2473 PLANTUML_CFG_FILE =
2474
2475 # When using plantuml, the specified paths are searched for files specified by
2476 # the !include statement in a plantuml block.
2477
2478 PLANTUML_INCLUDE_PATH =
2479
2480 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2481 # that will be shown in the graph. If the number of nodes in a graph becomes
2482 # larger than this value, doxygen will truncate the graph, which is visualized
2483 # by representing a node as a red box. Note that doxygen if the number of direct
2484 # children of the root node in a graph is already larger than
2485 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2486 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2487 # Minimum value: 0, maximum value: 10000, default value: 50.
2488 # This tag requires that the tag HAVE_DOT is set to YES.
2489
2490 DOT_GRAPH_MAX_NODES = 50
2491
2492 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2493 # generated by dot. A depth value of 3 means that only nodes reachable from the
2494 # root by following a path via at most 3 edges will be shown. Nodes that lay
2495 # further from the root node will be omitted. Note that setting this option to 1
2496 # or 2 may greatly reduce the computation time needed for large code bases. Also
2497 # note that the size of a graph can be further restricted by
2498 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2499 # Minimum value: 0, maximum value: 1000, default value: 0.
2500 # This tag requires that the tag HAVE_DOT is set to YES.
2501
2502 MAX_DOT_GRAPH_DEPTH = 0
2503
2504 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2505 # background. This is disabled by default, because dot on Windows does not seem
2506 # to support this out of the box.
2507 #
2508 # Warning: Depending on the platform used, enabling this option may lead to
2509 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2510 # read).
2511 # The default value is: NO.
2512 # This tag requires that the tag HAVE_DOT is set to YES.
2513
2514 DOT_TRANSPARENT = NO
2515
2516 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2517 # files in one run (i.e. multiple -o and -T options on the command line). This
2518 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2519 # this, this feature is disabled by default.
2520 # The default value is: NO.
2521 # This tag requires that the tag HAVE_DOT is set to YES.
2522
2523 DOT_MULTI_TARGETS = NO
2524
2525 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2526 # explaining the meaning of the various boxes and arrows in the dot generated
2527 # graphs.
2528 # The default value is: YES.
2529 # This tag requires that the tag HAVE_DOT is set to YES.
2530
2531 GENERATE_LEGEND = YES
2532
2533 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2534 # files that are used to generate the various graphs.
2535 # The default value is: YES.
2536 # This tag requires that the tag HAVE_DOT is set to YES.
2537
2538 DOT_CLEANUP = YES