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