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