Back to home page

EIC code displayed by LXR

 
 

    


Warning, /acts/docs/Doxyfile is written in an unsupported language. File is not indexed.

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