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