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