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