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