Warning, /games/granatier/src/Doxyfile is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.5.5
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 hash (#) is considered a comment and will be ignored
0007 # The format is:
0008 # TAG = value [value, ...]
0009 # For lists items can also be appended using:
0010 # TAG += value [value, ...]
0011 # Values that contain spaces should be placed between quotes (" ")
0012
0013 #---------------------------------------------------------------------------
0014 # Project related configuration options
0015 #---------------------------------------------------------------------------
0016
0017 # This tag specifies the encoding used for all characters in the config file
0018 # that follow. The default is UTF-8 which is also the encoding used for all
0019 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0020 # iconv built into libc) for the transcoding. See
0021 # http://www.gnu.org/software/libiconv for the list of possible encodings.
0022
0023 DOXYFILE_ENCODING = UTF-8
0024
0025 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0026 # by quotes) that should identify the project.
0027
0028 PROJECT_NAME = Granatier
0029
0030 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0031 # This could be handy for archiving the generated documentation or
0032 # if some version control system is used.
0033
0034 PROJECT_NUMBER = 0.0.1
0035
0036 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0037 # base path where the generated documentation will be put.
0038 # If a relative path is entered, it will be relative to the location
0039 # where doxygen was started. If left blank the current directory will be used.
0040
0041 OUTPUT_DIRECTORY = doc
0042
0043 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
0044 # 4096 sub-directories (in 2 levels) under the output directory of each output
0045 # format and will distribute the generated files over these directories.
0046 # Enabling this option can be useful when feeding doxygen a huge amount of
0047 # source files, where putting all generated files in the same directory would
0048 # otherwise cause performance problems for the file system.
0049
0050 CREATE_SUBDIRS = NO
0051
0052 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0053 # documentation generated by doxygen is written. Doxygen will use this
0054 # information to generate all constant output in the proper language.
0055 # The default language is English, other supported languages are:
0056 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
0057 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
0058 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
0059 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
0060 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
0061 # and Ukrainian.
0062
0063 OUTPUT_LANGUAGE = English
0064
0065 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0066 # include brief member descriptions after the members that are listed in
0067 # the file and class documentation (similar to JavaDoc).
0068 # Set to NO to disable this.
0069
0070 BRIEF_MEMBER_DESC = YES
0071
0072 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0073 # the brief description of a member or function before the detailed description.
0074 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0075 # brief descriptions will be completely suppressed.
0076
0077 REPEAT_BRIEF = YES
0078
0079 # This tag implements a quasi-intelligent brief description abbreviator
0080 # that is used to form the text in various listings. Each string
0081 # in this list, if found as the leading text of the brief description, will be
0082 # stripped from the text and the result after processing the whole list, is
0083 # used as the annotated text. Otherwise, the brief description is used as-is.
0084 # If left blank, the following values are used ("$name" is automatically
0085 # replaced with the name of the entity): "The $name class" "The $name widget"
0086 # "The $name file" "is" "provides" "specifies" "contains"
0087 # "represents" "a" "an" "the"
0088
0089 ABBREVIATE_BRIEF =
0090
0091 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0092 # Doxygen will generate a detailed section even if there is only a brief
0093 # description.
0094
0095 ALWAYS_DETAILED_SEC = NO
0096
0097 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0098 # inherited members of a class in the documentation of that class as if those
0099 # members were ordinary class members. Constructors, destructors and assignment
0100 # operators of the base classes will not be shown.
0101
0102 INLINE_INHERITED_MEMB = NO
0103
0104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0105 # path before files name in the file list and in the header files. If set
0106 # to NO the shortest path that makes the file name unique will be used.
0107
0108 FULL_PATH_NAMES = YES
0109
0110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0111 # can be used to strip a user-defined part of the path. Stripping is
0112 # only done if one of the specified strings matches the left-hand part of
0113 # the path. The tag can be used to show relative paths in the file list.
0114 # If left blank the directory from which doxygen is run is used as the
0115 # path to strip.
0116
0117 STRIP_FROM_PATH =
0118
0119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
0120 # the path mentioned in the documentation of a class, which tells
0121 # the reader which header file to include in order to use a class.
0122 # If left blank only the name of the header file containing the class
0123 # definition is used. Otherwise one should specify the include paths that
0124 # are normally passed to the compiler using the -I flag.
0125
0126 STRIP_FROM_INC_PATH =
0127
0128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0129 # (but less readable) file names. This can be useful is your file systems
0130 # doesn't support long names like on DOS, Mac, or CD-ROM.
0131
0132 SHORT_NAMES = NO
0133
0134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0135 # will interpret the first line (until the first dot) of a JavaDoc-style
0136 # comment as the brief description. If set to NO, the JavaDoc
0137 # comments will behave just like regular Qt-style comments
0138 # (thus requiring an explicit @brief command for a brief description.)
0139
0140 JAVADOC_AUTOBRIEF = NO
0141
0142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
0143 # interpret the first line (until the first dot) of a Qt-style
0144 # comment as the brief description. If set to NO, the comments
0145 # will behave just like regular Qt-style comments (thus requiring
0146 # an explicit \brief command for a brief description.)
0147
0148 QT_AUTOBRIEF = NO
0149
0150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0152 # comments) as a brief description. This used to be the default behaviour.
0153 # The new default is to treat a multi-line C++ comment block as a detailed
0154 # description. Set this tag to YES if you prefer the old behaviour instead.
0155
0156 MULTILINE_CPP_IS_BRIEF = NO
0157
0158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
0159 # will output the detailed description near the top, like JavaDoc.
0160 # If set to NO, the detailed description appears after the member
0161 # documentation.
0162
0163 DETAILS_AT_TOP = NO
0164
0165 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0166 # member inherits the documentation from any documented member that it
0167 # re-implements.
0168
0169 INHERIT_DOCS = YES
0170
0171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
0172 # a new page for each member. If set to NO, the documentation of a member will
0173 # be part of the file/class/namespace that contains it.
0174
0175 SEPARATE_MEMBER_PAGES = NO
0176
0177 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0178 # Doxygen uses this value to replace tabs by spaces in code fragments.
0179
0180 TAB_SIZE = 8
0181
0182 # This tag can be used to specify a number of aliases that acts
0183 # as commands in the documentation. An alias has the form "name=value".
0184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0185 # put the command \sideeffect (or @sideeffect) in the documentation, which
0186 # will result in a user-defined paragraph with heading "Side Effects:".
0187 # You can put \n's in the value part of an alias to insert newlines.
0188
0189 ALIASES =
0190
0191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
0192 # sources only. Doxygen will then generate output that is more tailored for C.
0193 # For instance, some of the names that are used will be different. The list
0194 # of all members will be omitted, etc.
0195
0196 OPTIMIZE_OUTPUT_FOR_C = NO
0197
0198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
0199 # sources only. Doxygen will then generate output that is more tailored for
0200 # Java. For instance, namespaces will be presented as packages, qualified
0201 # scopes will look different, etc.
0202
0203 OPTIMIZE_OUTPUT_JAVA = NO
0204
0205 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0206 # sources only. Doxygen will then generate output that is more tailored for
0207 # Fortran.
0208
0209 OPTIMIZE_FOR_FORTRAN = NO
0210
0211 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0212 # sources. Doxygen will then generate output that is tailored for
0213 # VHDL.
0214
0215 OPTIMIZE_OUTPUT_VHDL = NO
0216
0217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0218 # to include (a tag file for) the STL sources as input, then you should
0219 # set this tag to YES in order to let doxygen match functions declarations and
0220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
0221 # func(std::string) {}). This also make the inheritance and collaboration
0222 # diagrams that involve STL classes more complete and accurate.
0223
0224 BUILTIN_STL_SUPPORT = NO
0225
0226 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0227 # enable parsing support.
0228
0229 CPP_CLI_SUPPORT = NO
0230
0231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
0232 # Doxygen will parse them like normal C++ but will assume all classes use public
0233 # instead of private inheritance when no explicit protection keyword is present.
0234
0235 SIP_SUPPORT = NO
0236
0237 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0238 # tag is set to YES, then doxygen will reuse the documentation of the first
0239 # member in the group (if any) for the other members of the group. By default
0240 # all members of a group must be documented explicitly.
0241
0242 DISTRIBUTE_GROUP_DOC = NO
0243
0244 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0245 # the same type (for instance a group of public functions) to be put as a
0246 # subgroup of that type (e.g. under the Public Functions section). Set it to
0247 # NO to prevent subgrouping. Alternatively, this can be done per class using
0248 # the \nosubgrouping command.
0249
0250 SUBGROUPING = YES
0251
0252 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
0253 # is documented as struct, union, or enum with the name of the typedef. So
0254 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0255 # with name TypeT. When disabled the typedef will appear as a member of a file,
0256 # namespace, or class. And the struct will be named TypeS. This can typically
0257 # be useful for C code in case the coding convention dictates that all compound
0258 # types are typedef'ed and only the typedef is referenced, never the tag name.
0259
0260 TYPEDEF_HIDES_STRUCT = NO
0261
0262 #---------------------------------------------------------------------------
0263 # Build related configuration options
0264 #---------------------------------------------------------------------------
0265
0266 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0267 # documentation are documented, even if no documentation was available.
0268 # Private class members and static file members will be hidden unless
0269 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0270
0271 EXTRACT_ALL = NO
0272
0273 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0274 # will be included in the documentation.
0275
0276 EXTRACT_PRIVATE = NO
0277
0278 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0279 # will be included in the documentation.
0280
0281 EXTRACT_STATIC = NO
0282
0283 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0284 # defined locally in source files will be included in the documentation.
0285 # If set to NO only classes defined in header files are included.
0286
0287 EXTRACT_LOCAL_CLASSES = YES
0288
0289 # This flag is only useful for Objective-C code. When set to YES local
0290 # methods, which are defined in the implementation section but not in
0291 # the interface are included in the documentation.
0292 # If set to NO (the default) only methods in the interface are included.
0293
0294 EXTRACT_LOCAL_METHODS = NO
0295
0296 # If this flag is set to YES, the members of anonymous namespaces will be
0297 # extracted and appear in the documentation as a namespace called
0298 # 'anonymous_namespace{file}', where file will be replaced with the base
0299 # name of the file that contains the anonymous namespace. By default
0300 # anonymous namespace are hidden.
0301
0302 EXTRACT_ANON_NSPACES = NO
0303
0304 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0305 # undocumented members of documented classes, files or namespaces.
0306 # If set to NO (the default) these members will be included in the
0307 # various overviews, but no documentation section is generated.
0308 # This option has no effect if EXTRACT_ALL is enabled.
0309
0310 HIDE_UNDOC_MEMBERS = NO
0311
0312 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0313 # undocumented classes that are normally visible in the class hierarchy.
0314 # If set to NO (the default) these classes will be included in the various
0315 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0316
0317 HIDE_UNDOC_CLASSES = NO
0318
0319 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0320 # friend (class|struct|union) declarations.
0321 # If set to NO (the default) these declarations will be included in the
0322 # documentation.
0323
0324 HIDE_FRIEND_COMPOUNDS = NO
0325
0326 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0327 # documentation blocks found inside the body of a function.
0328 # If set to NO (the default) these blocks will be appended to the
0329 # function's detailed documentation block.
0330
0331 HIDE_IN_BODY_DOCS = NO
0332
0333 # The INTERNAL_DOCS tag determines if documentation
0334 # that is typed after a \internal command is included. If the tag is set
0335 # to NO (the default) then the documentation will be excluded.
0336 # Set it to YES to include the internal documentation.
0337
0338 INTERNAL_DOCS = NO
0339
0340 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0341 # file names in lower-case letters. If set to YES upper-case letters are also
0342 # allowed. This is useful if you have classes or files whose names only differ
0343 # in case and if your file system supports case sensitive file names. Windows
0344 # and Mac users are advised to set this option to NO.
0345
0346 CASE_SENSE_NAMES = YES
0347
0348 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0349 # will show members with their full class and namespace scopes in the
0350 # documentation. If set to YES the scope will be hidden.
0351
0352 HIDE_SCOPE_NAMES = NO
0353
0354 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0355 # will put a list of the files that are included by a file in the documentation
0356 # of that file.
0357
0358 SHOW_INCLUDE_FILES = YES
0359
0360 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0361 # is inserted in the documentation for inline members.
0362
0363 INLINE_INFO = YES
0364
0365 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0366 # will sort the (detailed) documentation of file and class members
0367 # alphabetically by member name. If set to NO the members will appear in
0368 # declaration order.
0369
0370 SORT_MEMBER_DOCS = YES
0371
0372 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
0373 # brief documentation of file, namespace and class members alphabetically
0374 # by member name. If set to NO (the default) the members will appear in
0375 # declaration order.
0376
0377 SORT_BRIEF_DOCS = NO
0378
0379 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
0380 # hierarchy of group names into alphabetical order. If set to NO (the default)
0381 # the group names will appear in their defined order.
0382
0383 SORT_GROUP_NAMES = NO
0384
0385 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
0386 # sorted by fully-qualified names, including namespaces. If set to
0387 # NO (the default), the class list will be sorted only by class name,
0388 # not including the namespace part.
0389 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0390 # Note: This option applies only to the class list, not to the
0391 # alphabetical list.
0392
0393 SORT_BY_SCOPE_NAME = NO
0394
0395 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0396 # disable (NO) the todo list. This list is created by putting \todo
0397 # commands in the documentation.
0398
0399 GENERATE_TODOLIST = YES
0400
0401 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0402 # disable (NO) the test list. This list is created by putting \test
0403 # commands in the documentation.
0404
0405 GENERATE_TESTLIST = YES
0406
0407 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0408 # disable (NO) the bug list. This list is created by putting \bug
0409 # commands in the documentation.
0410
0411 GENERATE_BUGLIST = YES
0412
0413 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0414 # disable (NO) the deprecated list. This list is created by putting
0415 # \deprecated commands in the documentation.
0416
0417 GENERATE_DEPRECATEDLIST= YES
0418
0419 # The ENABLED_SECTIONS tag can be used to enable conditional
0420 # documentation sections, marked by \if sectionname ... \endif.
0421
0422 ENABLED_SECTIONS =
0423
0424 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0425 # the initial value of a variable or define consists of for it to appear in
0426 # the documentation. If the initializer consists of more lines than specified
0427 # here it will be hidden. Use a value of 0 to hide initializers completely.
0428 # The appearance of the initializer of individual variables and defines in the
0429 # documentation can be controlled using \showinitializer or \hideinitializer
0430 # command in the documentation regardless of this setting.
0431
0432 MAX_INITIALIZER_LINES = 30
0433
0434 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0435 # at the bottom of the documentation of classes and structs. If set to YES the
0436 # list will mention the files that were used to generate the documentation.
0437
0438 SHOW_USED_FILES = YES
0439
0440 # If the sources in your project are distributed over multiple directories
0441 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
0442 # in the documentation. The default is NO.
0443
0444 SHOW_DIRECTORIES = NO
0445
0446 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0447 # doxygen should invoke to get the current version for each file (typically from
0448 # the version control system). Doxygen will invoke the program by executing (via
0449 # popen()) the command <command> <input-file>, where <command> is the value of
0450 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
0451 # provided by doxygen. Whatever the program writes to standard output
0452 # is used as the file version. See the manual for examples.
0453
0454 FILE_VERSION_FILTER =
0455
0456 #---------------------------------------------------------------------------
0457 # configuration options related to warning and progress messages
0458 #---------------------------------------------------------------------------
0459
0460 # The QUIET tag can be used to turn on/off the messages that are generated
0461 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0462
0463 QUIET = NO
0464
0465 # The WARNINGS tag can be used to turn on/off the warning messages that are
0466 # generated by doxygen. Possible values are YES and NO. If left blank
0467 # NO is used.
0468
0469 WARNINGS = YES
0470
0471 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0472 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0473 # automatically be disabled.
0474
0475 WARN_IF_UNDOCUMENTED = YES
0476
0477 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0478 # potential errors in the documentation, such as not documenting some
0479 # parameters in a documented function, or documenting parameters that
0480 # don't exist or using markup commands wrongly.
0481
0482 WARN_IF_DOC_ERROR = YES
0483
0484 # This WARN_NO_PARAMDOC option can be abled to get warnings for
0485 # functions that are documented, but have no documentation for their parameters
0486 # or return value. If set to NO (the default) doxygen will only warn about
0487 # wrong or incomplete parameter documentation, but not about the absence of
0488 # documentation.
0489
0490 WARN_NO_PARAMDOC = NO
0491
0492 # The WARN_FORMAT tag determines the format of the warning messages that
0493 # doxygen can produce. The string should contain the $file, $line, and $text
0494 # tags, which will be replaced by the file and line number from which the
0495 # warning originated and the warning text. Optionally the format may contain
0496 # $version, which will be replaced by the version of the file (if it could
0497 # be obtained via FILE_VERSION_FILTER)
0498
0499 WARN_FORMAT = "$file:$line: $text"
0500
0501 # The WARN_LOGFILE tag can be used to specify a file to which warning
0502 # and error messages should be written. If left blank the output is written
0503 # to stderr.
0504
0505 WARN_LOGFILE =
0506
0507 #---------------------------------------------------------------------------
0508 # configuration options related to the input files
0509 #---------------------------------------------------------------------------
0510
0511 # The INPUT tag can be used to specify the files and/or directories that contain
0512 # documented source files. You may enter file names like "myfile.cpp" or
0513 # directories like "/usr/src/myproject". Separate the files or directories
0514 # with spaces.
0515
0516 INPUT =
0517
0518 # This tag can be used to specify the character encoding of the source files
0519 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
0520 # also the default input encoding. Doxygen uses libiconv (or the iconv built
0521 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
0522 # the list of possible encodings.
0523
0524 INPUT_ENCODING = UTF-8
0525
0526 # If the value of the INPUT tag contains directories, you can use the
0527 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0528 # and *.h) to filter out the source-files in the directories. If left
0529 # blank the following patterns are tested:
0530 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
0531 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
0532
0533 FILE_PATTERNS =
0534
0535 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0536 # should be searched for input files as well. Possible values are YES and NO.
0537 # If left blank NO is used.
0538
0539 RECURSIVE = NO
0540
0541 # The EXCLUDE tag can be used to specify files and/or directories that should
0542 # excluded from the INPUT source files. This way you can easily exclude a
0543 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0544
0545 EXCLUDE =
0546
0547 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
0548 # directories that are symbolic links (a Unix filesystem feature) are excluded
0549 # from the input.
0550
0551 EXCLUDE_SYMLINKS = NO
0552
0553 # If the value of the INPUT tag contains directories, you can use the
0554 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0555 # certain files from those directories. Note that the wildcards are matched
0556 # against the file with absolute path, so to exclude all test directories
0557 # for example use the pattern */test/*
0558
0559 EXCLUDE_PATTERNS =
0560
0561 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0562 # (namespaces, classes, functions, etc.) that should be excluded from the
0563 # output. The symbol name can be a fully qualified name, a word, or if the
0564 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0565 # AClass::ANamespace, ANamespace::*Test
0566
0567 EXCLUDE_SYMBOLS =
0568
0569 # The EXAMPLE_PATH tag can be used to specify one or more files or
0570 # directories that contain example code fragments that are included (see
0571 # the \include command).
0572
0573 EXAMPLE_PATH =
0574
0575 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0576 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0577 # and *.h) to filter out the source-files in the directories. If left
0578 # blank all files are included.
0579
0580 EXAMPLE_PATTERNS =
0581
0582 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0583 # searched for input files to be used with the \include or \dontinclude
0584 # commands irrespective of the value of the RECURSIVE tag.
0585 # Possible values are YES and NO. If left blank NO is used.
0586
0587 EXAMPLE_RECURSIVE = NO
0588
0589 # The IMAGE_PATH tag can be used to specify one or more files or
0590 # directories that contain image that are included in the documentation (see
0591 # the \image command).
0592
0593 IMAGE_PATH =
0594
0595 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0596 # invoke to filter for each input file. Doxygen will invoke the filter program
0597 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0598 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0599 # input file. Doxygen will then use the output that the filter program writes
0600 # to standard output. If FILTER_PATTERNS is specified, this tag will be
0601 # ignored.
0602
0603 INPUT_FILTER =
0604
0605 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0606 # basis. Doxygen will compare the file name with each pattern and apply the
0607 # filter if there is a match. The filters are a list of the form:
0608 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
0609 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
0610 # is applied to all files.
0611
0612 FILTER_PATTERNS =
0613
0614 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0615 # INPUT_FILTER) will be used to filter the input files when producing source
0616 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0617
0618 FILTER_SOURCE_FILES = NO
0619
0620 #---------------------------------------------------------------------------
0621 # configuration options related to source browsing
0622 #---------------------------------------------------------------------------
0623
0624 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0625 # be generated. Documented entities will be cross-referenced with these sources.
0626 # Note: To get rid of all source code in the generated output, make sure also
0627 # VERBATIM_HEADERS is set to NO.
0628
0629 SOURCE_BROWSER = NO
0630
0631 # Setting the INLINE_SOURCES tag to YES will include the body
0632 # of functions and classes directly in the documentation.
0633
0634 INLINE_SOURCES = NO
0635
0636 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0637 # doxygen to hide any special comment blocks from generated source code
0638 # fragments. Normal C and C++ comments will always remain visible.
0639
0640 STRIP_CODE_COMMENTS = YES
0641
0642 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
0643 # then for each documented function all documented
0644 # functions referencing it will be listed.
0645
0646 REFERENCED_BY_RELATION = YES
0647
0648 # If the REFERENCES_RELATION tag is set to YES (the default)
0649 # then for each documented function all documented entities
0650 # called/used by that function will be listed.
0651
0652 REFERENCES_RELATION = YES
0653
0654 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
0655 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
0656 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
0657 # link to the source code. Otherwise they will link to the documentstion.
0658
0659 REFERENCES_LINK_SOURCE = YES
0660
0661 # If the USE_HTAGS tag is set to YES then the references to source code
0662 # will point to the HTML generated by the htags(1) tool instead of doxygen
0663 # built-in source browser. The htags tool is part of GNU's global source
0664 # tagging system (see http://www.gnu.org/software/global/global.html). You
0665 # will need version 4.8.6 or higher.
0666
0667 USE_HTAGS = NO
0668
0669 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0670 # will generate a verbatim copy of the header file for each class for
0671 # which an include is specified. Set to NO to disable this.
0672
0673 VERBATIM_HEADERS = YES
0674
0675 #---------------------------------------------------------------------------
0676 # configuration options related to the alphabetical class index
0677 #---------------------------------------------------------------------------
0678
0679 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0680 # of all compounds will be generated. Enable this if the project
0681 # contains a lot of classes, structs, unions or interfaces.
0682
0683 ALPHABETICAL_INDEX = NO
0684
0685 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0686 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0687 # in which this list will be split (can be a number in the range [1..20])
0688
0689 COLS_IN_ALPHA_INDEX = 5
0690
0691 # In case all classes in a project start with a common prefix, all
0692 # classes will be put under the same header in the alphabetical index.
0693 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0694 # should be ignored while generating the index headers.
0695
0696 IGNORE_PREFIX =
0697
0698 #---------------------------------------------------------------------------
0699 # configuration options related to the HTML output
0700 #---------------------------------------------------------------------------
0701
0702 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0703 # generate HTML output.
0704
0705 GENERATE_HTML = YES
0706
0707 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0708 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0709 # put in front of it. If left blank `html' will be used as the default path.
0710
0711 HTML_OUTPUT = html
0712
0713 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0714 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0715 # doxygen will generate files with .html extension.
0716
0717 HTML_FILE_EXTENSION = .html
0718
0719 # The HTML_HEADER tag can be used to specify a personal HTML header for
0720 # each generated HTML page. If it is left blank doxygen will generate a
0721 # standard header.
0722
0723 HTML_HEADER =
0724
0725 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0726 # each generated HTML page. If it is left blank doxygen will generate a
0727 # standard footer.
0728
0729 HTML_FOOTER =
0730
0731 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0732 # style sheet that is used by each HTML page. It can be used to
0733 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0734 # will generate a default style sheet. Note that doxygen will try to copy
0735 # the style sheet file to the HTML output directory, so don't put your own
0736 # stylesheet in the HTML output directory as well, or it will be erased!
0737
0738 HTML_STYLESHEET =
0739
0740 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0741 # files or namespaces will be aligned in HTML using tables. If set to
0742 # NO a bullet list will be used.
0743
0744 HTML_ALIGN_MEMBERS = YES
0745
0746 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0747 # will be generated that can be used as input for tools like the
0748 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
0749 # of the generated HTML documentation.
0750
0751 GENERATE_HTMLHELP = NO
0752
0753 # If the GENERATE_DOCSET tag is set to YES, additional index files
0754 # will be generated that can be used as input for Apple's Xcode 3
0755 # integrated development environment, introduced with OSX 10.5 (Leopard).
0756 # To create a documentation set, doxygen will generate a Makefile in the
0757 # HTML output directory. Running make will produce the docset in that
0758 # directory and running "make install" will install the docset in
0759 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
0760 # it at startup.
0761
0762 GENERATE_DOCSET = NO
0763
0764 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
0765 # feed. A documentation feed provides an umbrella under which multiple
0766 # documentation sets from a single provider (such as a company or product suite)
0767 # can be grouped.
0768
0769 DOCSET_FEEDNAME = "Doxygen generated docs"
0770
0771 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
0772 # should uniquely identify the documentation set bundle. This should be a
0773 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
0774 # will append .docset to the name.
0775
0776 DOCSET_BUNDLE_ID = org.doxygen.Project
0777
0778 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
0779 # documentation will contain sections that can be hidden and shown after the
0780 # page has loaded. For this to work a browser that supports
0781 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
0782 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
0783
0784 HTML_DYNAMIC_SECTIONS = NO
0785
0786 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0787 # be used to specify the file name of the resulting .chm file. You
0788 # can add a path in front of the file if the result should not be
0789 # written to the html output directory.
0790
0791 CHM_FILE =
0792
0793 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0794 # be used to specify the location (absolute path including file name) of
0795 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0796 # the HTML help compiler on the generated index.hhp.
0797
0798 HHC_LOCATION =
0799
0800 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0801 # controls if a separate .chi index file is generated (YES) or that
0802 # it should be included in the master .chm file (NO).
0803
0804 GENERATE_CHI = NO
0805
0806 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0807 # controls whether a binary table of contents is generated (YES) or a
0808 # normal table of contents (NO) in the .chm file.
0809
0810 BINARY_TOC = NO
0811
0812 # The TOC_EXPAND flag can be set to YES to add extra items for group members
0813 # to the contents of the HTML help documentation and to the tree view.
0814
0815 TOC_EXPAND = NO
0816
0817 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
0818 # top of each HTML page. The value NO (the default) enables the index and
0819 # the value YES disables it.
0820
0821 DISABLE_INDEX = NO
0822
0823 # This tag can be used to set the number of enum values (range [1..20])
0824 # that doxygen will group on one line in the generated HTML documentation.
0825
0826 ENUM_VALUES_PER_LINE = 4
0827
0828 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
0829 # generated containing a tree-like index structure (just like the one that
0830 # is generated for HTML Help). For this to work a browser that supports
0831 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
0832 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
0833 # probably better off using the HTML help feature.
0834
0835 GENERATE_TREEVIEW = NO
0836
0837 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
0838 # used to set the initial width (in pixels) of the frame in which the tree
0839 # is shown.
0840
0841 TREEVIEW_WIDTH = 250
0842
0843 #---------------------------------------------------------------------------
0844 # configuration options related to the LaTeX output
0845 #---------------------------------------------------------------------------
0846
0847 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
0848 # generate Latex output.
0849
0850 GENERATE_LATEX = YES
0851
0852 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
0853 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0854 # put in front of it. If left blank `latex' will be used as the default path.
0855
0856 LATEX_OUTPUT = latex
0857
0858 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
0859 # invoked. If left blank `latex' will be used as the default command name.
0860
0861 LATEX_CMD_NAME = latex
0862
0863 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
0864 # generate index for LaTeX. If left blank `makeindex' will be used as the
0865 # default command name.
0866
0867 MAKEINDEX_CMD_NAME = makeindex
0868
0869 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
0870 # LaTeX documents. This may be useful for small projects and may help to
0871 # save some trees in general.
0872
0873 COMPACT_LATEX = NO
0874
0875 # The PAPER_TYPE tag can be used to set the paper type that is used
0876 # by the printer. Possible values are: a4, a4wide, letter, legal and
0877 # executive. If left blank a4wide will be used.
0878
0879 PAPER_TYPE = a4wide
0880
0881 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
0882 # packages that should be included in the LaTeX output.
0883
0884 EXTRA_PACKAGES =
0885
0886 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
0887 # the generated latex document. The header should contain everything until
0888 # the first chapter. If it is left blank doxygen will generate a
0889 # standard header. Notice: only use this tag if you know what you are doing!
0890
0891 LATEX_HEADER =
0892
0893 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
0894 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
0895 # contain links (just like the HTML output) instead of page references
0896 # This makes the output suitable for online browsing using a pdf viewer.
0897
0898 PDF_HYPERLINKS = NO
0899
0900 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
0901 # plain latex in the generated Makefile. Set this option to YES to get a
0902 # higher quality PDF documentation.
0903
0904 USE_PDFLATEX = NO
0905
0906 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
0907 # command to the generated LaTeX files. This will instruct LaTeX to keep
0908 # running if errors occur, instead of asking the user for help.
0909 # This option is also used when generating formulas in HTML.
0910
0911 LATEX_BATCHMODE = NO
0912
0913 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
0914 # include the index chapters (such as File Index, Compound Index, etc.)
0915 # in the output.
0916
0917 LATEX_HIDE_INDICES = NO
0918
0919 #---------------------------------------------------------------------------
0920 # configuration options related to the RTF output
0921 #---------------------------------------------------------------------------
0922
0923 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
0924 # The RTF output is optimized for Word 97 and may not look very pretty with
0925 # other RTF readers or editors.
0926
0927 GENERATE_RTF = NO
0928
0929 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
0930 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0931 # put in front of it. If left blank `rtf' will be used as the default path.
0932
0933 RTF_OUTPUT = rtf
0934
0935 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
0936 # RTF documents. This may be useful for small projects and may help to
0937 # save some trees in general.
0938
0939 COMPACT_RTF = NO
0940
0941 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
0942 # will contain hyperlink fields. The RTF file will
0943 # contain links (just like the HTML output) instead of page references.
0944 # This makes the output suitable for online browsing using WORD or other
0945 # programs which support those fields.
0946 # Note: wordpad (write) and others do not support links.
0947
0948 RTF_HYPERLINKS = NO
0949
0950 # Load stylesheet definitions from file. Syntax is similar to doxygen's
0951 # config file, i.e. a series of assignments. You only have to provide
0952 # replacements, missing definitions are set to their default value.
0953
0954 RTF_STYLESHEET_FILE =
0955
0956 # Set optional variables used in the generation of an rtf document.
0957 # Syntax is similar to doxygen's config file.
0958
0959 RTF_EXTENSIONS_FILE =
0960
0961 #---------------------------------------------------------------------------
0962 # configuration options related to the man page output
0963 #---------------------------------------------------------------------------
0964
0965 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
0966 # generate man pages
0967
0968 GENERATE_MAN = NO
0969
0970 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
0971 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0972 # put in front of it. If left blank `man' will be used as the default path.
0973
0974 MAN_OUTPUT = man
0975
0976 # The MAN_EXTENSION tag determines the extension that is added to
0977 # the generated man pages (default is the subroutine's section .3)
0978
0979 MAN_EXTENSION = .3
0980
0981 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
0982 # then it will generate one additional man file for each entity
0983 # documented in the real man page(s). These additional files
0984 # only source the real man page, but without them the man command
0985 # would be unable to find the correct page. The default is NO.
0986
0987 MAN_LINKS = NO
0988
0989 #---------------------------------------------------------------------------
0990 # configuration options related to the XML output
0991 #---------------------------------------------------------------------------
0992
0993 # If the GENERATE_XML tag is set to YES Doxygen will
0994 # generate an XML file that captures the structure of
0995 # the code including all documentation.
0996
0997 GENERATE_XML = NO
0998
0999 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1000 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1001 # put in front of it. If left blank `xml' will be used as the default path.
1002
1003 XML_OUTPUT = xml
1004
1005 # The XML_SCHEMA tag can be used to specify an XML schema,
1006 # which can be used by a validating XML parser to check the
1007 # syntax of the XML files.
1008
1009 XML_SCHEMA =
1010
1011 # The XML_DTD tag can be used to specify an XML DTD,
1012 # which can be used by a validating XML parser to check the
1013 # syntax of the XML files.
1014
1015 XML_DTD =
1016
1017 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1018 # dump the program listings (including syntax highlighting
1019 # and cross-referencing information) to the XML output. Note that
1020 # enabling this will significantly increase the size of the XML output.
1021
1022 XML_PROGRAMLISTING = YES
1023
1024 #---------------------------------------------------------------------------
1025 # configuration options for the AutoGen Definitions output
1026 #---------------------------------------------------------------------------
1027
1028 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1029 # generate an AutoGen Definitions (see autogen.sf.net) file
1030 # that captures the structure of the code including all
1031 # documentation. Note that this feature is still experimental
1032 # and incomplete at the moment.
1033
1034 GENERATE_AUTOGEN_DEF = NO
1035
1036 #---------------------------------------------------------------------------
1037 # configuration options related to the Perl module output
1038 #---------------------------------------------------------------------------
1039
1040 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1041 # generate a Perl module file that captures the structure of
1042 # the code including all documentation. Note that this
1043 # feature is still experimental and incomplete at the
1044 # moment.
1045
1046 GENERATE_PERLMOD = NO
1047
1048 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1049 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1050 # to generate PDF and DVI output from the Perl module output.
1051
1052 PERLMOD_LATEX = NO
1053
1054 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1055 # nicely formatted so it can be parsed by a human reader. This is useful
1056 # if you want to understand what is going on. On the other hand, if this
1057 # tag is set to NO the size of the Perl module output will be much smaller
1058 # and Perl will parse it just the same.
1059
1060 PERLMOD_PRETTY = YES
1061
1062 # The names of the make variables in the generated doxyrules.make file
1063 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1064 # This is useful so different doxyrules.make files included by the same
1065 # Makefile don't overwrite each other's variables.
1066
1067 PERLMOD_MAKEVAR_PREFIX =
1068
1069 #---------------------------------------------------------------------------
1070 # Configuration options related to the preprocessor
1071 #---------------------------------------------------------------------------
1072
1073 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1074 # evaluate all C-preprocessor directives found in the sources and include
1075 # files.
1076
1077 ENABLE_PREPROCESSING = YES
1078
1079 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1080 # names in the source code. If set to NO (the default) only conditional
1081 # compilation will be performed. Macro expansion can be done in a controlled
1082 # way by setting EXPAND_ONLY_PREDEF to YES.
1083
1084 MACRO_EXPANSION = NO
1085
1086 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1087 # then the macro expansion is limited to the macros specified with the
1088 # PREDEFINED and EXPAND_AS_DEFINED tags.
1089
1090 EXPAND_ONLY_PREDEF = NO
1091
1092 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1093 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1094
1095 SEARCH_INCLUDES = YES
1096
1097 # The INCLUDE_PATH tag can be used to specify one or more directories that
1098 # contain include files that are not input files but should be processed by
1099 # the preprocessor.
1100
1101 INCLUDE_PATH =
1102
1103 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1104 # patterns (like *.h and *.hpp) to filter out the header-files in the
1105 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1106 # be used.
1107
1108 INCLUDE_FILE_PATTERNS =
1109
1110 # The PREDEFINED tag can be used to specify one or more macro names that
1111 # are defined before the preprocessor is started (similar to the -D option of
1112 # gcc). The argument of the tag is a list of macros of the form: name
1113 # or name=definition (no spaces). If the definition and the = are
1114 # omitted =1 is assumed. To prevent a macro definition from being
1115 # undefined via #undef or recursively expanded use the := operator
1116 # instead of the = operator.
1117
1118 PREDEFINED =
1119
1120 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1121 # this tag can be used to specify a list of macro names that should be expanded.
1122 # The macro definition that is found in the sources will be used.
1123 # Use the PREDEFINED tag if you want to use a different macro definition.
1124
1125 EXPAND_AS_DEFINED =
1126
1127 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1128 # doxygen's preprocessor will remove all function-like macros that are alone
1129 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1130 # function macros are typically used for boiler-plate code, and will confuse
1131 # the parser if not removed.
1132
1133 SKIP_FUNCTION_MACROS = YES
1134
1135 #---------------------------------------------------------------------------
1136 # Configuration::additions related to external references
1137 #---------------------------------------------------------------------------
1138
1139 # The TAGFILES option can be used to specify one or more tagfiles.
1140 # Optionally an initial location of the external documentation
1141 # can be added for each tagfile. The format of a tag file without
1142 # this location is as follows:
1143 # TAGFILES = file1 file2 ...
1144 # Adding location for the tag files is done as follows:
1145 # TAGFILES = file1=loc1 "file2 = loc2" ...
1146 # where "loc1" and "loc2" can be relative or absolute paths or
1147 # URLs. If a location is present for each tag, the installdox tool
1148 # does not have to be run to correct the links.
1149 # Note that each tag file must have a unique name
1150 # (where the name does NOT include the path)
1151 # If a tag file is not located in the directory in which doxygen
1152 # is run, you must also specify the path to the tagfile here.
1153
1154 TAGFILES =
1155
1156 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1157 # a tag file that is based on the input files it reads.
1158
1159 GENERATE_TAGFILE =
1160
1161 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1162 # in the class index. If set to NO only the inherited external classes
1163 # will be listed.
1164
1165 ALLEXTERNALS = NO
1166
1167 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1168 # in the modules index. If set to NO, only the current project's groups will
1169 # be listed.
1170
1171 EXTERNAL_GROUPS = YES
1172
1173 # The PERL_PATH should be the absolute path and name of the perl script
1174 # interpreter (i.e. the result of `which perl').
1175
1176 PERL_PATH = /usr/bin/perl
1177
1178 #---------------------------------------------------------------------------
1179 # Configuration options related to the dot tool
1180 #---------------------------------------------------------------------------
1181
1182 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1183 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1184 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1185 # this option is superseded by the HAVE_DOT option below. This is only a
1186 # fallback. It is recommended to install and use dot, since it yields more
1187 # powerful graphs.
1188
1189 CLASS_DIAGRAMS = YES
1190
1191 # You can define message sequence charts within doxygen comments using the \msc
1192 # command. Doxygen will then run the mscgen tool (see
1193 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1194 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1195 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1196 # default search path.
1197
1198 MSCGEN_PATH =
1199
1200 # If set to YES, the inheritance and collaboration graphs will hide
1201 # inheritance and usage relations if the target is undocumented
1202 # or is not a class.
1203
1204 HIDE_UNDOC_RELATIONS = YES
1205
1206 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1207 # available from the path. This tool is part of Graphviz, a graph visualization
1208 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1209 # have no effect if this option is set to NO (the default)
1210
1211 HAVE_DOT = NO
1212
1213 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1214 # will generate a graph for each documented class showing the direct and
1215 # indirect inheritance relations. Setting this tag to YES will force the
1216 # the CLASS_DIAGRAMS tag to NO.
1217
1218 CLASS_GRAPH = YES
1219
1220 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1221 # will generate a graph for each documented class showing the direct and
1222 # indirect implementation dependencies (inheritance, containment, and
1223 # class references variables) of the class with other documented classes.
1224
1225 COLLABORATION_GRAPH = YES
1226
1227 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1228 # will generate a graph for groups, showing the direct groups dependencies
1229
1230 GROUP_GRAPHS = YES
1231
1232 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1233 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1234 # Language.
1235
1236 UML_LOOK = NO
1237
1238 # If set to YES, the inheritance and collaboration graphs will show the
1239 # relations between templates and their instances.
1240
1241 TEMPLATE_RELATIONS = NO
1242
1243 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1244 # tags are set to YES then doxygen will generate a graph for each documented
1245 # file showing the direct and indirect include dependencies of the file with
1246 # other documented files.
1247
1248 INCLUDE_GRAPH = YES
1249
1250 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1251 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1252 # documented header file showing the documented files that directly or
1253 # indirectly include this file.
1254
1255 INCLUDED_BY_GRAPH = YES
1256
1257 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1258 # doxygen will generate a call dependency graph for every global function
1259 # or class method. Note that enabling this option will significantly increase
1260 # the time of a run. So in most cases it will be better to enable call graphs
1261 # for selected functions only using the \callgraph command.
1262
1263 CALL_GRAPH = NO
1264
1265 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1266 # doxygen will generate a caller dependency graph for every global function
1267 # or class method. Note that enabling this option will significantly increase
1268 # the time of a run. So in most cases it will be better to enable caller
1269 # graphs for selected functions only using the \callergraph command.
1270
1271 CALLER_GRAPH = NO
1272
1273 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1274 # will graphical hierarchy of all classes instead of a textual one.
1275
1276 GRAPHICAL_HIERARCHY = YES
1277
1278 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1279 # then doxygen will show the dependencies a directory has on other directories
1280 # in a graphical way. The dependency relations are determined by the #include
1281 # relations between the files in the directories.
1282
1283 DIRECTORY_GRAPH = YES
1284
1285 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1286 # generated by dot. Possible values are png, jpg, or gif
1287 # If left blank png will be used.
1288
1289 DOT_IMAGE_FORMAT = png
1290
1291 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1292 # found. If left blank, it is assumed the dot tool can be found in the path.
1293
1294 DOT_PATH =
1295
1296 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1297 # contain dot files that are included in the documentation (see the
1298 # \dotfile command).
1299
1300 DOTFILE_DIRS =
1301
1302 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1303 # nodes that will be shown in the graph. If the number of nodes in a graph
1304 # becomes larger than this value, doxygen will truncate the graph, which is
1305 # visualized by representing a node as a red box. Note that doxygen if the
1306 # number of direct children of the root node in a graph is already larger than
1307 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1308 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1309
1310 DOT_GRAPH_MAX_NODES = 50
1311
1312 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1313 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1314 # from the root by following a path via at most 3 edges will be shown. Nodes
1315 # that lay further from the root node will be omitted. Note that setting this
1316 # option to 1 or 2 may greatly reduce the computation time needed for large
1317 # code bases. Also note that the size of a graph can be further restricted by
1318 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1319
1320 MAX_DOT_GRAPH_DEPTH = 0
1321
1322 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1323 # background. This is enabled by default, which results in a transparent
1324 # background. Warning: Depending on the platform used, enabling this option
1325 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1326 # become hard to read).
1327
1328 DOT_TRANSPARENT = NO
1329
1330 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1331 # files in one run (i.e. multiple -o and -T options on the command line). This
1332 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1333 # support this, this feature is disabled by default.
1334
1335 DOT_MULTI_TARGETS = NO
1336
1337 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1338 # generate a legend page explaining the meaning of the various boxes and
1339 # arrows in the dot generated graphs.
1340
1341 GENERATE_LEGEND = YES
1342
1343 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1344 # remove the intermediate dot files that are used to generate
1345 # the various graphs.
1346
1347 DOT_CLEANUP = YES
1348
1349 #---------------------------------------------------------------------------
1350 # Configuration::additions related to the search engine
1351 #---------------------------------------------------------------------------
1352
1353 # The SEARCHENGINE tag specifies whether or not a search engine should be
1354 # used. If set to NO the values of all tags below this one will be ignored.
1355
1356 SEARCHENGINE = NO