Mercurial > libpst
annotate Doxyfile @ 144:c0bf3cb16524
Added tag stable-0-6-28 for changeset fdc58ad2c758
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Tue, 24 Feb 2009 12:41:04 -0800 |
| parents | 7133b39975f7 |
| children | 03fbb0269f3c |
| rev | line source |
|---|---|
| 35 | 1 # Doxyfile 1.3.9.1 |
| 2 | |
| 3 # This file describes the settings to be used by the documentation system | |
| 4 # doxygen (www.doxygen.org) for a project | |
| 5 # | |
| 6 # All text after a hash (#) is considered a comment and will be ignored | |
| 7 # The format is: | |
| 8 # TAG = value [value, ...] | |
| 9 # For lists items can also be appended using: | |
| 10 # TAG += value [value, ...] | |
| 11 # Values that contain spaces should be placed between quotes (" ") | |
| 12 | |
| 13 #--------------------------------------------------------------------------- | |
| 14 # Project related configuration options | |
| 15 #--------------------------------------------------------------------------- | |
| 16 | |
| 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | |
| 18 # by quotes) that should identify the project. | |
| 19 | |
| 20 PROJECT_NAME = 'LibPst' | |
| 21 | |
| 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. | |
| 23 # This could be handy for archiving the generated documentation or | |
| 24 # if some version control system is used. | |
| 25 | |
| 26 PROJECT_NUMBER = | |
| 27 | |
| 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | |
| 29 # base path where the generated documentation will be put. | |
| 30 # If a relative path is entered, it will be relative to the location | |
| 31 # where doxygen was started. If left blank the current directory will be used. | |
| 32 | |
| 33 OUTPUT_DIRECTORY = | |
| 34 | |
| 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | |
| 36 # 4096 sub-directories (in 2 levels) under the output directory of each output | |
| 37 # format and will distribute the generated files over these directories. | |
| 38 # Enabling this option can be useful when feeding doxygen a huge amount of source | |
| 39 # files, where putting all generated files in the same directory would otherwise | |
| 40 # cause performance problems for the file system. | |
| 41 | |
| 42 CREATE_SUBDIRS = NO | |
| 43 | |
| 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all | |
| 45 # documentation generated by doxygen is written. Doxygen will use this | |
| 46 # information to generate all constant output in the proper language. | |
| 47 # The default language is English, other supported languages are: | |
| 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, | |
| 49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, | |
| 50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, | |
| 51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, | |
| 52 # Swedish, and Ukrainian. | |
| 53 | |
| 54 OUTPUT_LANGUAGE = English | |
| 55 | |
| 56 # This tag can be used to specify the encoding used in the generated output. | |
| 57 # The encoding is not always determined by the language that is chosen, | |
| 58 # but also whether or not the output is meant for Windows or non-Windows users. | |
| 59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES | |
| 60 # forces the Windows encoding (this is the default for the Windows binary), | |
| 61 # whereas setting the tag to NO uses a Unix-style encoding (the default for | |
| 62 # all platforms other than Windows). | |
| 63 | |
| 64 USE_WINDOWS_ENCODING = NO | |
| 65 | |
| 66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | |
| 67 # include brief member descriptions after the members that are listed in | |
| 68 # the file and class documentation (similar to JavaDoc). | |
| 69 # Set to NO to disable this. | |
| 70 | |
| 71 BRIEF_MEMBER_DESC = YES | |
| 72 | |
| 73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | |
| 74 # the brief description of a member or function before the detailed description. | |
| 75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | |
| 76 # brief descriptions will be completely suppressed. | |
| 77 | |
| 78 REPEAT_BRIEF = YES | |
| 79 | |
| 80 # This tag implements a quasi-intelligent brief description abbreviator | |
| 81 # that is used to form the text in various listings. Each string | |
| 82 # in this list, if found as the leading text of the brief description, will be | |
| 83 # stripped from the text and the result after processing the whole list, is used | |
| 84 # as the annotated text. Otherwise, the brief description is used as-is. If left | |
| 85 # blank, the following values are used ("$name" is automatically replaced with the | |
| 86 # name of the entity): "The $name class" "The $name widget" "The $name file" | |
| 87 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" | |
| 88 | |
| 89 ABBREVIATE_BRIEF = | |
| 90 | |
| 91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | |
| 92 # Doxygen will generate a detailed section even if there is only a brief | |
| 93 # description. | |
| 94 | |
| 95 ALWAYS_DETAILED_SEC = NO | |
| 96 | |
| 97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | |
| 98 # members of a class in the documentation of that class as if those members were | |
| 99 # ordinary class members. Constructors, destructors and assignment operators of | |
| 100 # the base classes will not be shown. | |
| 101 | |
| 102 INLINE_INHERITED_MEMB = NO | |
| 103 | |
| 104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | |
| 105 # path before files name in the file list and in the header files. If set | |
| 106 # to NO the shortest path that makes the file name unique will be used. | |
| 107 | |
| 108 FULL_PATH_NAMES = YES | |
| 109 | |
| 110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | |
| 111 # can be used to strip a user-defined part of the path. Stripping is | |
| 112 # only done if one of the specified strings matches the left-hand part of | |
| 113 # the path. The tag can be used to show relative paths in the file list. | |
| 114 # If left blank the directory from which doxygen is run is used as the | |
| 115 # path to strip. | |
| 116 | |
| 117 STRIP_FROM_PATH = | |
| 118 | |
| 119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | |
| 120 # the path mentioned in the documentation of a class, which tells | |
| 121 # the reader which header file to include in order to use a class. | |
| 122 # If left blank only the name of the header file containing the class | |
| 123 # definition is used. Otherwise one should specify the include paths that | |
| 124 # are normally passed to the compiler using the -I flag. | |
| 125 | |
| 126 STRIP_FROM_INC_PATH = . | |
| 127 | |
| 128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | |
| 129 # (but less readable) file names. This can be useful is your file systems | |
| 130 # doesn't support long names like on DOS, Mac, or CD-ROM. | |
| 131 | |
| 132 SHORT_NAMES = NO | |
| 133 | |
| 134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | |
| 135 # will interpret the first line (until the first dot) of a JavaDoc-style | |
| 136 # comment as the brief description. If set to NO, the JavaDoc | |
| 137 # comments will behave just like the Qt-style comments (thus requiring an | |
| 138 # explicit @brief command for a brief description. | |
| 139 | |
| 140 JAVADOC_AUTOBRIEF = YES | |
| 141 | |
| 142 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | |
| 143 # treat a multi-line C++ special comment block (i.e. a block of //! or /// | |
| 144 # comments) as a brief description. This used to be the default behaviour. | |
| 145 # The new default is to treat a multi-line C++ comment block as a detailed | |
| 146 # description. Set this tag to YES if you prefer the old behaviour instead. | |
| 147 | |
| 148 MULTILINE_CPP_IS_BRIEF = NO | |
| 149 | |
| 150 # If the DETAILS_AT_TOP tag is set to YES then Doxygen | |
| 151 # will output the detailed description near the top, like JavaDoc. | |
| 152 # If set to NO, the detailed description appears after the member | |
| 153 # documentation. | |
| 154 | |
| 155 DETAILS_AT_TOP = NO | |
| 156 | |
| 157 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | |
| 158 # member inherits the documentation from any documented member that it | |
| 159 # re-implements. | |
| 160 | |
| 161 INHERIT_DOCS = YES | |
| 162 | |
| 163 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
| 164 # tag is set to YES, then doxygen will reuse the documentation of the first | |
| 165 # member in the group (if any) for the other members of the group. By default | |
| 166 # all members of a group must be documented explicitly. | |
| 167 | |
| 168 DISTRIBUTE_GROUP_DOC = NO | |
| 169 | |
| 170 # The TAB_SIZE tag can be used to set the number of spaces in a tab. | |
| 171 # Doxygen uses this value to replace tabs by spaces in code fragments. | |
| 172 | |
| 173 TAB_SIZE = 4 | |
| 174 | |
| 175 # This tag can be used to specify a number of aliases that acts | |
| 176 # as commands in the documentation. An alias has the form "name=value". | |
| 177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to | |
| 178 # put the command \sideeffect (or @sideeffect) in the documentation, which | |
| 179 # will result in a user-defined paragraph with heading "Side Effects:". | |
| 180 # You can put \n's in the value part of an alias to insert newlines. | |
| 181 | |
| 182 ALIASES = | |
| 183 | |
| 184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | |
| 185 # only. Doxygen will then generate output that is more tailored for C. | |
| 186 # For instance, some of the names that are used will be different. The list | |
| 187 # of all members will be omitted, etc. | |
| 188 | |
| 50 | 189 OPTIMIZE_OUTPUT_FOR_C = YES |
| 35 | 190 |
| 191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | |
| 192 # only. Doxygen will then generate output that is more tailored for Java. | |
| 193 # For instance, namespaces will be presented as packages, qualified scopes | |
| 194 # will look different, etc. | |
| 195 | |
| 196 OPTIMIZE_OUTPUT_JAVA = NO | |
| 197 | |
| 198 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | |
| 199 # the same type (for instance a group of public functions) to be put as a | |
| 200 # subgroup of that type (e.g. under the Public Functions section). Set it to | |
| 201 # NO to prevent subgrouping. Alternatively, this can be done per class using | |
| 202 # the \nosubgrouping command. | |
| 203 | |
| 204 SUBGROUPING = YES | |
| 205 | |
| 206 #--------------------------------------------------------------------------- | |
| 207 # Build related configuration options | |
| 208 #--------------------------------------------------------------------------- | |
| 209 | |
| 210 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | |
| 211 # documentation are documented, even if no documentation was available. | |
| 212 # Private class members and static file members will be hidden unless | |
| 213 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | |
| 214 | |
| 215 EXTRACT_ALL = YES | |
| 216 | |
| 217 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | |
| 218 # will be included in the documentation. | |
| 219 | |
| 220 EXTRACT_PRIVATE = YES | |
| 221 | |
| 222 # If the EXTRACT_STATIC tag is set to YES all static members of a file | |
| 223 # will be included in the documentation. | |
| 224 | |
| 225 EXTRACT_STATIC = YES | |
| 226 | |
| 227 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | |
| 228 # defined locally in source files will be included in the documentation. | |
| 229 # If set to NO only classes defined in header files are included. | |
| 230 | |
| 231 EXTRACT_LOCAL_CLASSES = YES | |
| 232 | |
| 233 # This flag is only useful for Objective-C code. When set to YES local | |
| 234 # methods, which are defined in the implementation section but not in | |
| 235 # the interface are included in the documentation. | |
| 236 # If set to NO (the default) only methods in the interface are included. | |
| 237 | |
| 238 EXTRACT_LOCAL_METHODS = NO | |
| 239 | |
| 240 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | |
| 241 # undocumented members of documented classes, files or namespaces. | |
| 242 # If set to NO (the default) these members will be included in the | |
| 243 # various overviews, but no documentation section is generated. | |
| 244 # This option has no effect if EXTRACT_ALL is enabled. | |
| 245 | |
| 246 HIDE_UNDOC_MEMBERS = NO | |
| 247 | |
| 248 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | |
| 249 # undocumented classes that are normally visible in the class hierarchy. | |
| 250 # If set to NO (the default) these classes will be included in the various | |
| 251 # overviews. This option has no effect if EXTRACT_ALL is enabled. | |
| 252 | |
| 253 HIDE_UNDOC_CLASSES = NO | |
| 254 | |
| 255 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | |
| 256 # friend (class|struct|union) declarations. | |
| 257 # If set to NO (the default) these declarations will be included in the | |
| 258 # documentation. | |
| 259 | |
| 260 HIDE_FRIEND_COMPOUNDS = NO | |
| 261 | |
| 262 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | |
| 263 # documentation blocks found inside the body of a function. | |
| 264 # If set to NO (the default) these blocks will be appended to the | |
| 265 # function's detailed documentation block. | |
| 266 | |
| 267 HIDE_IN_BODY_DOCS = NO | |
| 268 | |
| 269 # The INTERNAL_DOCS tag determines if documentation | |
| 270 # that is typed after a \internal command is included. If the tag is set | |
| 271 # to NO (the default) then the documentation will be excluded. | |
| 272 # Set it to YES to include the internal documentation. | |
| 273 | |
| 274 INTERNAL_DOCS = YES | |
| 275 | |
| 276 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | |
| 277 # file names in lower-case letters. If set to YES upper-case letters are also | |
| 278 # allowed. This is useful if you have classes or files whose names only differ | |
| 279 # in case and if your file system supports case sensitive file names. Windows | |
| 280 # and Mac users are advised to set this option to NO. | |
| 281 | |
| 282 CASE_SENSE_NAMES = YES | |
| 283 | |
| 284 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | |
| 285 # will show members with their full class and namespace scopes in the | |
| 286 # documentation. If set to YES the scope will be hidden. | |
| 287 | |
| 288 HIDE_SCOPE_NAMES = NO | |
| 289 | |
| 290 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | |
| 291 # will put a list of the files that are included by a file in the documentation | |
| 292 # of that file. | |
| 293 | |
| 294 SHOW_INCLUDE_FILES = YES | |
| 295 | |
| 296 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | |
| 297 # is inserted in the documentation for inline members. | |
| 298 | |
| 299 INLINE_INFO = YES | |
| 300 | |
| 301 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | |
| 302 # will sort the (detailed) documentation of file and class members | |
| 303 # alphabetically by member name. If set to NO the members will appear in | |
| 304 # declaration order. | |
| 305 | |
| 306 SORT_MEMBER_DOCS = YES | |
| 307 | |
| 308 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | |
| 309 # brief documentation of file, namespace and class members alphabetically | |
| 310 # by member name. If set to NO (the default) the members will appear in | |
| 311 # declaration order. | |
| 312 | |
| 313 SORT_BRIEF_DOCS = NO | |
| 314 | |
| 315 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | |
| 316 # sorted by fully-qualified names, including namespaces. If set to | |
| 317 # NO (the default), the class list will be sorted only by class name, | |
| 318 # not including the namespace part. | |
| 319 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | |
| 320 # Note: This option applies only to the class list, not to the | |
| 321 # alphabetical list. | |
| 322 | |
| 323 SORT_BY_SCOPE_NAME = NO | |
| 324 | |
| 325 # The GENERATE_TODOLIST tag can be used to enable (YES) or | |
| 326 # disable (NO) the todo list. This list is created by putting \todo | |
| 327 # commands in the documentation. | |
| 328 | |
| 329 GENERATE_TODOLIST = YES | |
| 330 | |
| 331 # The GENERATE_TESTLIST tag can be used to enable (YES) or | |
| 332 # disable (NO) the test list. This list is created by putting \test | |
| 333 # commands in the documentation. | |
| 334 | |
| 335 GENERATE_TESTLIST = YES | |
| 336 | |
| 337 # The GENERATE_BUGLIST tag can be used to enable (YES) or | |
| 338 # disable (NO) the bug list. This list is created by putting \bug | |
| 339 # commands in the documentation. | |
| 340 | |
| 341 GENERATE_BUGLIST = YES | |
| 342 | |
| 343 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | |
| 344 # disable (NO) the deprecated list. This list is created by putting | |
| 345 # \deprecated commands in the documentation. | |
| 346 | |
| 347 GENERATE_DEPRECATEDLIST= YES | |
| 348 | |
| 349 # The ENABLED_SECTIONS tag can be used to enable conditional | |
| 350 # documentation sections, marked by \if sectionname ... \endif. | |
| 351 | |
| 352 ENABLED_SECTIONS = | |
| 353 | |
| 354 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | |
| 355 # the initial value of a variable or define consists of for it to appear in | |
| 356 # the documentation. If the initializer consists of more lines than specified | |
| 357 # here it will be hidden. Use a value of 0 to hide initializers completely. | |
| 358 # The appearance of the initializer of individual variables and defines in the | |
| 359 # documentation can be controlled using \showinitializer or \hideinitializer | |
| 360 # command in the documentation regardless of this setting. | |
| 361 | |
| 362 MAX_INITIALIZER_LINES = 30 | |
| 363 | |
| 364 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | |
| 365 # at the bottom of the documentation of classes and structs. If set to YES the | |
| 366 # list will mention the files that were used to generate the documentation. | |
| 367 | |
| 368 SHOW_USED_FILES = YES | |
| 369 | |
| 370 # If the sources in your project are distributed over multiple directories | |
| 371 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | |
| 372 # in the documentation. | |
| 373 | |
| 374 SHOW_DIRECTORIES = YES | |
| 375 | |
| 376 #--------------------------------------------------------------------------- | |
| 377 # configuration options related to warning and progress messages | |
| 378 #--------------------------------------------------------------------------- | |
| 379 | |
| 380 # The QUIET tag can be used to turn on/off the messages that are generated | |
| 381 # by doxygen. Possible values are YES and NO. If left blank NO is used. | |
| 382 | |
| 383 QUIET = NO | |
| 384 | |
| 385 # The WARNINGS tag can be used to turn on/off the warning messages that are | |
| 386 # generated by doxygen. Possible values are YES and NO. If left blank | |
| 387 # NO is used. | |
| 388 | |
| 389 WARNINGS = YES | |
| 390 | |
| 391 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | |
| 392 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | |
| 393 # automatically be disabled. | |
| 394 | |
| 395 WARN_IF_UNDOCUMENTED = YES | |
| 396 | |
| 397 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | |
| 398 # potential errors in the documentation, such as not documenting some | |
| 399 # parameters in a documented function, or documenting parameters that | |
| 400 # don't exist or using markup commands wrongly. | |
| 401 | |
| 402 WARN_IF_DOC_ERROR = YES | |
| 403 | |
| 404 # The WARN_FORMAT tag determines the format of the warning messages that | |
| 405 # doxygen can produce. The string should contain the $file, $line, and $text | |
| 406 # tags, which will be replaced by the file and line number from which the | |
| 407 # warning originated and the warning text. | |
| 408 | |
| 409 WARN_FORMAT = "$file:$line: $text" | |
| 410 | |
| 411 # The WARN_LOGFILE tag can be used to specify a file to which warning | |
| 412 # and error messages should be written. If left blank the output is written | |
| 413 # to stderr. | |
| 414 | |
| 415 WARN_LOGFILE = | |
| 416 | |
| 417 #--------------------------------------------------------------------------- | |
| 418 # configuration options related to the input files | |
| 419 #--------------------------------------------------------------------------- | |
| 420 | |
| 421 # The INPUT tag can be used to specify the files and/or directories that contain | |
| 422 # documented source files. You may enter file names like "myfile.cpp" or | |
| 423 # directories like "/usr/src/myproject". Separate the files or directories | |
| 424 # with spaces. | |
| 425 | |
| 426 INPUT = src | |
| 427 | |
| 428 # If the value of the INPUT tag contains directories, you can use the | |
| 429 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 430 # and *.h) to filter out the source-files in the directories. If left | |
| 431 # blank the following patterns are tested: | |
| 432 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | |
| 433 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm | |
| 434 | |
| 435 FILE_PATTERNS = | |
| 436 | |
| 437 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | |
| 438 # should be searched for input files as well. Possible values are YES and NO. | |
| 439 # If left blank NO is used. | |
| 440 | |
| 441 RECURSIVE = YES | |
| 442 | |
| 443 # The EXCLUDE tag can be used to specify files and/or directories that should | |
| 444 # excluded from the INPUT source files. This way you can easily exclude a | |
| 445 # subdirectory from a directory tree whose root is specified with the INPUT tag. | |
| 446 | |
| 447 EXCLUDE = | |
| 448 | |
| 449 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | |
| 450 # that are symbolic links (a Unix filesystem feature) are excluded from the input. | |
| 451 | |
| 452 EXCLUDE_SYMLINKS = NO | |
| 453 | |
| 454 # If the value of the INPUT tag contains directories, you can use the | |
| 455 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
| 456 # certain files from those directories. | |
| 457 | |
| 458 EXCLUDE_PATTERNS = | |
| 459 | |
| 460 # The EXAMPLE_PATH tag can be used to specify one or more files or | |
| 461 # directories that contain example code fragments that are included (see | |
| 462 # the \include command). | |
| 463 | |
| 464 EXAMPLE_PATH = | |
| 465 | |
| 466 # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |
| 467 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 468 # and *.h) to filter out the source-files in the directories. If left | |
| 469 # blank all files are included. | |
| 470 | |
| 471 EXAMPLE_PATTERNS = | |
| 472 | |
| 473 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |
| 474 # searched for input files to be used with the \include or \dontinclude | |
| 475 # commands irrespective of the value of the RECURSIVE tag. | |
| 476 # Possible values are YES and NO. If left blank NO is used. | |
| 477 | |
| 478 EXAMPLE_RECURSIVE = NO | |
| 479 | |
| 480 # The IMAGE_PATH tag can be used to specify one or more files or | |
| 481 # directories that contain image that are included in the documentation (see | |
| 482 # the \image command). | |
| 483 | |
| 484 IMAGE_PATH = | |
| 485 | |
| 486 # The INPUT_FILTER tag can be used to specify a program that doxygen should | |
| 487 # invoke to filter for each input file. Doxygen will invoke the filter program | |
| 488 # by executing (via popen()) the command <filter> <input-file>, where <filter> | |
| 489 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | |
| 490 # input file. Doxygen will then use the output that the filter program writes | |
| 491 # to standard output. If FILTER_PATTERNS is specified, this tag will be | |
| 492 # ignored. | |
| 493 | |
| 494 INPUT_FILTER = | |
| 495 | |
| 496 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | |
| 497 # basis. Doxygen will compare the file name with each pattern and apply the | |
| 498 # filter if there is a match. The filters are a list of the form: | |
| 499 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |
| 500 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | |
| 501 # is applied to all files. | |
| 502 | |
| 503 FILTER_PATTERNS = | |
| 504 | |
| 505 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |
| 506 # INPUT_FILTER) will be used to filter the input files when producing source | |
| 507 # files to browse (i.e. when SOURCE_BROWSER is set to YES). | |
| 508 | |
| 509 FILTER_SOURCE_FILES = NO | |
| 510 | |
| 511 #--------------------------------------------------------------------------- | |
| 512 # configuration options related to source browsing | |
| 513 #--------------------------------------------------------------------------- | |
| 514 | |
| 515 # If the SOURCE_BROWSER tag is set to YES then a list of source files will | |
| 516 # be generated. Documented entities will be cross-referenced with these sources. | |
| 517 # Note: To get rid of all source code in the generated output, make sure also | |
| 518 # VERBATIM_HEADERS is set to NO. | |
| 519 | |
| 520 SOURCE_BROWSER = YES | |
| 521 | |
| 522 # Setting the INLINE_SOURCES tag to YES will include the body | |
| 523 # of functions and classes directly in the documentation. | |
| 524 | |
| 525 INLINE_SOURCES = NO | |
| 526 | |
| 527 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | |
| 528 # doxygen to hide any special comment blocks from generated source code | |
| 529 # fragments. Normal C and C++ comments will always remain visible. | |
| 530 | |
| 531 STRIP_CODE_COMMENTS = YES | |
| 532 | |
| 533 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | |
| 534 # then for each documented function all documented | |
| 535 # functions referencing it will be listed. | |
| 536 | |
| 537 REFERENCED_BY_RELATION = YES | |
| 538 | |
| 539 # If the REFERENCES_RELATION tag is set to YES (the default) | |
| 540 # then for each documented function all documented entities | |
| 541 # called/used by that function will be listed. | |
| 542 | |
| 543 REFERENCES_RELATION = YES | |
| 544 | |
| 545 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | |
| 546 # will generate a verbatim copy of the header file for each class for | |
| 547 # which an include is specified. Set to NO to disable this. | |
| 548 | |
| 549 VERBATIM_HEADERS = YES | |
| 550 | |
| 551 #--------------------------------------------------------------------------- | |
| 552 # configuration options related to the alphabetical class index | |
| 553 #--------------------------------------------------------------------------- | |
| 554 | |
| 555 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | |
| 556 # of all compounds will be generated. Enable this if the project | |
| 557 # contains a lot of classes, structs, unions or interfaces. | |
| 558 | |
| 559 ALPHABETICAL_INDEX = YES | |
| 560 | |
| 561 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | |
| 562 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | |
| 563 # in which this list will be split (can be a number in the range [1..20]) | |
| 564 | |
| 565 COLS_IN_ALPHA_INDEX = 5 | |
| 566 | |
| 567 # In case all classes in a project start with a common prefix, all | |
| 568 # classes will be put under the same header in the alphabetical index. | |
| 569 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | |
| 570 # should be ignored while generating the index headers. | |
| 571 | |
| 572 IGNORE_PREFIX = | |
| 573 | |
| 574 #--------------------------------------------------------------------------- | |
| 575 # configuration options related to the HTML output | |
| 576 #--------------------------------------------------------------------------- | |
| 577 | |
| 578 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | |
| 579 # generate HTML output. | |
| 580 | |
| 581 GENERATE_HTML = YES | |
| 582 | |
| 583 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | |
| 584 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 585 # put in front of it. If left blank `html' will be used as the default path. | |
| 586 | |
| 587 HTML_OUTPUT = html.internal | |
| 588 | |
| 589 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | |
| 590 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | |
| 591 # doxygen will generate files with .html extension. | |
| 592 | |
| 593 HTML_FILE_EXTENSION = .html | |
| 594 | |
| 595 # The HTML_HEADER tag can be used to specify a personal HTML header for | |
| 596 # each generated HTML page. If it is left blank doxygen will generate a | |
| 597 # standard header. | |
| 598 | |
| 599 HTML_HEADER = | |
| 600 | |
| 601 # The HTML_FOOTER tag can be used to specify a personal HTML footer for | |
| 602 # each generated HTML page. If it is left blank doxygen will generate a | |
| 603 # standard footer. | |
| 604 | |
| 605 HTML_FOOTER = | |
| 606 | |
| 607 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | |
| 608 # style sheet that is used by each HTML page. It can be used to | |
| 609 # fine-tune the look of the HTML output. If the tag is left blank doxygen | |
| 610 # will generate a default style sheet. Note that doxygen will try to copy | |
| 611 # the style sheet file to the HTML output directory, so don't put your own | |
| 612 # stylesheet in the HTML output directory as well, or it will be erased! | |
| 613 | |
| 614 HTML_STYLESHEET = | |
| 615 | |
| 616 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | |
| 617 # files or namespaces will be aligned in HTML using tables. If set to | |
| 618 # NO a bullet list will be used. | |
| 619 | |
| 620 HTML_ALIGN_MEMBERS = YES | |
| 621 | |
| 622 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | |
| 623 # will be generated that can be used as input for tools like the | |
| 624 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | |
| 625 # of the generated HTML documentation. | |
| 626 | |
| 627 GENERATE_HTMLHELP = NO | |
| 628 | |
| 629 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | |
| 630 # be used to specify the file name of the resulting .chm file. You | |
| 631 # can add a path in front of the file if the result should not be | |
| 632 # written to the html output directory. | |
| 633 | |
| 634 CHM_FILE = | |
| 635 | |
| 636 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | |
| 637 # be used to specify the location (absolute path including file name) of | |
| 638 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | |
| 639 # the HTML help compiler on the generated index.hhp. | |
| 640 | |
| 641 HHC_LOCATION = | |
| 642 | |
| 643 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | |
| 644 # controls if a separate .chi index file is generated (YES) or that | |
| 645 # it should be included in the master .chm file (NO). | |
| 646 | |
| 647 GENERATE_CHI = NO | |
| 648 | |
| 649 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | |
| 650 # controls whether a binary table of contents is generated (YES) or a | |
| 651 # normal table of contents (NO) in the .chm file. | |
| 652 | |
| 653 BINARY_TOC = NO | |
| 654 | |
| 655 # The TOC_EXPAND flag can be set to YES to add extra items for group members | |
| 656 # to the contents of the HTML help documentation and to the tree view. | |
| 657 | |
| 658 TOC_EXPAND = NO | |
| 659 | |
| 660 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | |
| 661 # top of each HTML page. The value NO (the default) enables the index and | |
| 662 # the value YES disables it. | |
| 663 | |
| 664 DISABLE_INDEX = NO | |
| 665 | |
| 666 # This tag can be used to set the number of enum values (range [1..20]) | |
| 667 # that doxygen will group on one line in the generated HTML documentation. | |
| 668 | |
| 669 ENUM_VALUES_PER_LINE = 4 | |
| 670 | |
| 671 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | |
| 672 # generated containing a tree-like index structure (just like the one that | |
| 673 # is generated for HTML Help). For this to work a browser that supports | |
| 674 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | |
| 675 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | |
| 676 # probably better off using the HTML help feature. | |
| 677 | |
| 678 GENERATE_TREEVIEW = YES | |
| 679 | |
| 680 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | |
| 681 # used to set the initial width (in pixels) of the frame in which the tree | |
| 682 # is shown. | |
| 683 | |
| 684 TREEVIEW_WIDTH = 250 | |
| 685 | |
| 686 #--------------------------------------------------------------------------- | |
| 687 # configuration options related to the LaTeX output | |
| 688 #--------------------------------------------------------------------------- | |
| 689 | |
| 690 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | |
| 691 # generate Latex output. | |
| 692 | |
| 693 GENERATE_LATEX = NO | |
| 694 | |
| 695 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | |
| 696 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 697 # put in front of it. If left blank `latex' will be used as the default path. | |
| 698 | |
| 699 LATEX_OUTPUT = latex | |
| 700 | |
| 701 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | |
| 702 # invoked. If left blank `latex' will be used as the default command name. | |
| 703 | |
| 704 LATEX_CMD_NAME = latex | |
| 705 | |
| 706 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | |
| 707 # generate index for LaTeX. If left blank `makeindex' will be used as the | |
| 708 # default command name. | |
| 709 | |
| 710 MAKEINDEX_CMD_NAME = makeindex | |
| 711 | |
| 712 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | |
| 713 # LaTeX documents. This may be useful for small projects and may help to | |
| 714 # save some trees in general. | |
| 715 | |
| 716 COMPACT_LATEX = NO | |
| 717 | |
| 718 # The PAPER_TYPE tag can be used to set the paper type that is used | |
| 719 # by the printer. Possible values are: a4, a4wide, letter, legal and | |
| 720 # executive. If left blank a4wide will be used. | |
| 721 | |
| 722 PAPER_TYPE = a4wide | |
| 723 | |
| 724 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | |
| 725 # packages that should be included in the LaTeX output. | |
| 726 | |
| 727 EXTRA_PACKAGES = | |
| 728 | |
| 729 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | |
| 730 # the generated latex document. The header should contain everything until | |
| 731 # the first chapter. If it is left blank doxygen will generate a | |
| 732 # standard header. Notice: only use this tag if you know what you are doing! | |
| 733 | |
| 734 LATEX_HEADER = | |
| 735 | |
| 736 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | |
| 737 # is prepared for conversion to pdf (using ps2pdf). The pdf file will | |
| 738 # contain links (just like the HTML output) instead of page references | |
| 739 # This makes the output suitable for online browsing using a pdf viewer. | |
| 740 | |
| 741 PDF_HYPERLINKS = NO | |
| 742 | |
| 743 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | |
| 744 # plain latex in the generated Makefile. Set this option to YES to get a | |
| 745 # higher quality PDF documentation. | |
| 746 | |
| 747 USE_PDFLATEX = NO | |
| 748 | |
| 749 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | |
| 750 # command to the generated LaTeX files. This will instruct LaTeX to keep | |
| 751 # running if errors occur, instead of asking the user for help. | |
| 752 # This option is also used when generating formulas in HTML. | |
| 753 | |
| 754 LATEX_BATCHMODE = NO | |
| 755 | |
| 756 # If LATEX_HIDE_INDICES is set to YES then doxygen will not | |
| 757 # include the index chapters (such as File Index, Compound Index, etc.) | |
| 758 # in the output. | |
| 759 | |
| 760 LATEX_HIDE_INDICES = NO | |
| 761 | |
| 762 #--------------------------------------------------------------------------- | |
| 763 # configuration options related to the RTF output | |
| 764 #--------------------------------------------------------------------------- | |
| 765 | |
| 766 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | |
| 767 # The RTF output is optimized for Word 97 and may not look very pretty with | |
| 768 # other RTF readers or editors. | |
| 769 | |
| 770 GENERATE_RTF = NO | |
| 771 | |
| 772 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | |
| 773 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 774 # put in front of it. If left blank `rtf' will be used as the default path. | |
| 775 | |
| 776 RTF_OUTPUT = rtf | |
| 777 | |
| 778 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | |
| 779 # RTF documents. This may be useful for small projects and may help to | |
| 780 # save some trees in general. | |
| 781 | |
| 782 COMPACT_RTF = NO | |
| 783 | |
| 784 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | |
| 785 # will contain hyperlink fields. The RTF file will | |
| 786 # contain links (just like the HTML output) instead of page references. | |
| 787 # This makes the output suitable for online browsing using WORD or other | |
| 788 # programs which support those fields. | |
| 789 # Note: wordpad (write) and others do not support links. | |
| 790 | |
| 791 RTF_HYPERLINKS = YES | |
| 792 | |
| 793 # Load stylesheet definitions from file. Syntax is similar to doxygen's | |
| 794 # config file, i.e. a series of assignments. You only have to provide | |
| 795 # replacements, missing definitions are set to their default value. | |
| 796 | |
| 797 RTF_STYLESHEET_FILE = | |
| 798 | |
| 799 # Set optional variables used in the generation of an rtf document. | |
| 800 # Syntax is similar to doxygen's config file. | |
| 801 | |
| 802 RTF_EXTENSIONS_FILE = | |
| 803 | |
| 804 #--------------------------------------------------------------------------- | |
| 805 # configuration options related to the man page output | |
| 806 #--------------------------------------------------------------------------- | |
| 807 | |
| 808 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | |
| 809 # generate man pages | |
| 810 | |
| 811 GENERATE_MAN = NO | |
| 812 | |
| 813 # The MAN_OUTPUT tag is used to specify where the man pages will be put. | |
| 814 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 815 # put in front of it. If left blank `man' will be used as the default path. | |
| 816 | |
| 817 MAN_OUTPUT = man | |
| 818 | |
| 819 # The MAN_EXTENSION tag determines the extension that is added to | |
| 820 # the generated man pages (default is the subroutine's section .3) | |
| 821 | |
| 822 MAN_EXTENSION = .3 | |
| 823 | |
| 824 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | |
| 825 # then it will generate one additional man file for each entity | |
| 826 # documented in the real man page(s). These additional files | |
| 827 # only source the real man page, but without them the man command | |
| 828 # would be unable to find the correct page. The default is NO. | |
| 829 | |
| 830 MAN_LINKS = NO | |
| 831 | |
| 832 #--------------------------------------------------------------------------- | |
| 833 # configuration options related to the XML output | |
| 834 #--------------------------------------------------------------------------- | |
| 835 | |
| 836 # If the GENERATE_XML tag is set to YES Doxygen will | |
| 837 # generate an XML file that captures the structure of | |
| 838 # the code including all documentation. | |
| 839 | |
| 840 GENERATE_XML = NO | |
| 841 | |
| 842 # The XML_OUTPUT tag is used to specify where the XML pages will be put. | |
| 843 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 844 # put in front of it. If left blank `xml' will be used as the default path. | |
| 845 | |
| 846 XML_OUTPUT = xml | |
| 847 | |
| 848 # The XML_SCHEMA tag can be used to specify an XML schema, | |
| 849 # which can be used by a validating XML parser to check the | |
| 850 # syntax of the XML files. | |
| 851 | |
| 852 XML_SCHEMA = | |
| 853 | |
| 854 # The XML_DTD tag can be used to specify an XML DTD, | |
| 855 # which can be used by a validating XML parser to check the | |
| 856 # syntax of the XML files. | |
| 857 | |
| 858 XML_DTD = | |
| 859 | |
| 860 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | |
| 861 # dump the program listings (including syntax highlighting | |
| 862 # and cross-referencing information) to the XML output. Note that | |
| 863 # enabling this will significantly increase the size of the XML output. | |
| 864 | |
| 865 XML_PROGRAMLISTING = YES | |
| 866 | |
| 867 #--------------------------------------------------------------------------- | |
| 868 # configuration options for the AutoGen Definitions output | |
| 869 #--------------------------------------------------------------------------- | |
| 870 | |
| 871 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | |
| 872 # generate an AutoGen Definitions (see autogen.sf.net) file | |
| 873 # that captures the structure of the code including all | |
| 874 # documentation. Note that this feature is still experimental | |
| 875 # and incomplete at the moment. | |
| 876 | |
| 877 GENERATE_AUTOGEN_DEF = NO | |
| 878 | |
| 879 #--------------------------------------------------------------------------- | |
| 880 # configuration options related to the Perl module output | |
| 881 #--------------------------------------------------------------------------- | |
| 882 | |
| 883 # If the GENERATE_PERLMOD tag is set to YES Doxygen will | |
| 884 # generate a Perl module file that captures the structure of | |
| 885 # the code including all documentation. Note that this | |
| 886 # feature is still experimental and incomplete at the | |
| 887 # moment. | |
| 888 | |
| 889 GENERATE_PERLMOD = NO | |
| 890 | |
| 891 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | |
| 892 # the necessary Makefile rules, Perl scripts and LaTeX code to be able | |
| 893 # to generate PDF and DVI output from the Perl module output. | |
| 894 | |
| 895 PERLMOD_LATEX = NO | |
| 896 | |
| 897 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | |
| 898 # nicely formatted so it can be parsed by a human reader. This is useful | |
| 899 # if you want to understand what is going on. On the other hand, if this | |
| 900 # tag is set to NO the size of the Perl module output will be much smaller | |
| 901 # and Perl will parse it just the same. | |
| 902 | |
| 903 PERLMOD_PRETTY = YES | |
| 904 | |
| 905 # The names of the make variables in the generated doxyrules.make file | |
| 906 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | |
| 907 # This is useful so different doxyrules.make files included by the same | |
| 908 # Makefile don't overwrite each other's variables. | |
| 909 | |
| 910 PERLMOD_MAKEVAR_PREFIX = | |
| 911 | |
| 912 #--------------------------------------------------------------------------- | |
| 913 # Configuration options related to the preprocessor | |
| 914 #--------------------------------------------------------------------------- | |
| 915 | |
| 916 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | |
| 917 # evaluate all C-preprocessor directives found in the sources and include | |
| 918 # files. | |
| 919 | |
| 920 ENABLE_PREPROCESSING = YES | |
| 921 | |
| 922 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | |
| 923 # names in the source code. If set to NO (the default) only conditional | |
| 924 # compilation will be performed. Macro expansion can be done in a controlled | |
| 925 # way by setting EXPAND_ONLY_PREDEF to YES. | |
| 926 | |
| 927 MACRO_EXPANSION = YES | |
| 928 | |
| 929 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | |
| 930 # then the macro expansion is limited to the macros specified with the | |
| 931 # PREDEFINED and EXPAND_AS_PREDEFINED tags. | |
| 932 | |
| 933 EXPAND_ONLY_PREDEF = NO | |
| 934 | |
| 935 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | |
| 936 # in the INCLUDE_PATH (see below) will be search if a #include is found. | |
| 937 | |
| 938 SEARCH_INCLUDES = YES | |
| 939 | |
| 940 # The INCLUDE_PATH tag can be used to specify one or more directories that | |
| 941 # contain include files that are not input files but should be processed by | |
| 942 # the preprocessor. | |
| 943 | |
| 944 INCLUDE_PATH = | |
| 945 | |
| 946 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |
| 947 # patterns (like *.h and *.hpp) to filter out the header-files in the | |
| 948 # directories. If left blank, the patterns specified with FILE_PATTERNS will | |
| 949 # be used. | |
| 950 | |
| 951 INCLUDE_FILE_PATTERNS = | |
| 952 | |
| 953 # The PREDEFINED tag can be used to specify one or more macro names that | |
| 954 # are defined before the preprocessor is started (similar to the -D option of | |
| 955 # gcc). The argument of the tag is a list of macros of the form: name | |
| 956 # or name=definition (no spaces). If the definition and the = are | |
| 957 # omitted =1 is assumed. To prevent a macro definition from being | |
| 958 # undefined via #undef or recursively expanded use the := operator | |
| 959 # instead of the = operator. | |
| 960 | |
| 961 PREDEFINED = | |
| 962 | |
| 963 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | |
| 964 # this tag can be used to specify a list of macro names that should be expanded. | |
| 965 # The macro definition that is found in the sources will be used. | |
| 966 # Use the PREDEFINED tag if you want to use a different macro definition. | |
| 967 | |
| 968 EXPAND_AS_DEFINED = | |
| 969 | |
| 970 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | |
| 971 # doxygen's preprocessor will remove all function-like macros that are alone | |
| 972 # on a line, have an all uppercase name, and do not end with a semicolon. Such | |
| 973 # function macros are typically used for boiler-plate code, and will confuse the | |
| 974 # parser if not removed. | |
| 975 | |
| 976 SKIP_FUNCTION_MACROS = YES | |
| 977 | |
| 978 #--------------------------------------------------------------------------- | |
| 979 # Configuration::additions related to external references | |
| 980 #--------------------------------------------------------------------------- | |
| 981 | |
| 982 # The TAGFILES option can be used to specify one or more tagfiles. | |
| 983 # Optionally an initial location of the external documentation | |
| 984 # can be added for each tagfile. The format of a tag file without | |
| 985 # this location is as follows: | |
| 986 # TAGFILES = file1 file2 ... | |
| 987 # Adding location for the tag files is done as follows: | |
| 988 # TAGFILES = file1=loc1 "file2 = loc2" ... | |
| 989 # where "loc1" and "loc2" can be relative or absolute paths or | |
| 990 # URLs. If a location is present for each tag, the installdox tool | |
| 991 # does not have to be run to correct the links. | |
| 992 # Note that each tag file must have a unique name | |
| 993 # (where the name does NOT include the path) | |
| 994 # If a tag file is not located in the directory in which doxygen | |
| 995 # is run, you must also specify the path to the tagfile here. | |
| 996 | |
| 997 TAGFILES = | |
| 998 | |
| 999 # When a file name is specified after GENERATE_TAGFILE, doxygen will create | |
| 1000 # a tag file that is based on the input files it reads. | |
| 1001 | |
| 1002 GENERATE_TAGFILE = | |
| 1003 | |
| 1004 # If the ALLEXTERNALS tag is set to YES all external classes will be listed | |
| 1005 # in the class index. If set to NO only the inherited external classes | |
| 1006 # will be listed. | |
| 1007 | |
| 1008 ALLEXTERNALS = NO | |
| 1009 | |
| 1010 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | |
| 1011 # in the modules index. If set to NO, only the current project's groups will | |
| 1012 # be listed. | |
| 1013 | |
| 1014 EXTERNAL_GROUPS = YES | |
| 1015 | |
| 1016 # The PERL_PATH should be the absolute path and name of the perl script | |
| 1017 # interpreter (i.e. the result of `which perl'). | |
| 1018 | |
| 1019 PERL_PATH = /usr/bin/perl | |
| 1020 | |
| 1021 #--------------------------------------------------------------------------- | |
| 1022 # Configuration options related to the dot tool | |
| 1023 #--------------------------------------------------------------------------- | |
| 1024 | |
| 1025 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | |
| 1026 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or | |
| 1027 # super classes. Setting the tag to NO turns the diagrams off. Note that this | |
| 1028 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is | |
| 1029 # recommended to install and use dot, since it yields more powerful graphs. | |
| 1030 | |
| 1031 CLASS_DIAGRAMS = YES | |
| 1032 | |
| 1033 # If set to YES, the inheritance and collaboration graphs will hide | |
| 1034 # inheritance and usage relations if the target is undocumented | |
| 1035 # or is not a class. | |
| 1036 | |
| 1037 HIDE_UNDOC_RELATIONS = YES | |
| 1038 | |
| 1039 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |
| 1040 # available from the path. This tool is part of Graphviz, a graph visualization | |
| 1041 # toolkit from AT&T and Lucent Bell Labs. The other options in this section | |
| 1042 # have no effect if this option is set to NO (the default) | |
| 1043 | |
|
110
7133b39975f7
patch from David Cuadrado to process emails with type PST_TYPE_OTHER
Carl Byington <carl@five-ten-sg.com>
parents:
50
diff
changeset
|
1044 HAVE_DOT = YES |
| 35 | 1045 |
| 1046 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 1047 # will generate a graph for each documented class showing the direct and | |
| 1048 # indirect inheritance relations. Setting this tag to YES will force the | |
| 1049 # the CLASS_DIAGRAMS tag to NO. | |
| 1050 | |
| 1051 CLASS_GRAPH = YES | |
| 1052 | |
| 1053 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 1054 # will generate a graph for each documented class showing the direct and | |
| 1055 # indirect implementation dependencies (inheritance, containment, and | |
| 1056 # class references variables) of the class with other documented classes. | |
| 1057 | |
| 1058 COLLABORATION_GRAPH = YES | |
| 1059 | |
| 1060 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | |
| 1061 # collaboration diagrams in a style similar to the OMG's Unified Modeling | |
| 1062 # Language. | |
| 1063 | |
| 1064 UML_LOOK = NO | |
| 1065 | |
| 1066 # If set to YES, the inheritance and collaboration graphs will show the | |
| 1067 # relations between templates and their instances. | |
| 1068 | |
| 1069 TEMPLATE_RELATIONS = NO | |
| 1070 | |
| 1071 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | |
| 1072 # tags are set to YES then doxygen will generate a graph for each documented | |
| 1073 # file showing the direct and indirect include dependencies of the file with | |
| 1074 # other documented files. | |
| 1075 | |
| 1076 INCLUDE_GRAPH = YES | |
| 1077 | |
| 1078 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | |
| 1079 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | |
| 1080 # documented header file showing the documented files that directly or | |
| 1081 # indirectly include this file. | |
| 1082 | |
| 1083 INCLUDED_BY_GRAPH = YES | |
| 1084 | |
| 1085 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | |
| 1086 # generate a call dependency graph for every global function or class method. | |
| 1087 # Note that enabling this option will significantly increase the time of a run. | |
| 1088 # So in most cases it will be better to enable call graphs for selected | |
| 1089 # functions only using the \callgraph command. | |
| 1090 | |
|
110
7133b39975f7
patch from David Cuadrado to process emails with type PST_TYPE_OTHER
Carl Byington <carl@five-ten-sg.com>
parents:
50
diff
changeset
|
1091 CALL_GRAPH = YES |
| 35 | 1092 |
| 1093 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | |
| 1094 # will graphical hierarchy of all classes instead of a textual one. | |
| 1095 | |
| 1096 GRAPHICAL_HIERARCHY = YES | |
| 1097 | |
| 1098 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |
| 1099 # generated by dot. Possible values are png, jpg, or gif | |
| 1100 # If left blank png will be used. | |
| 1101 | |
| 1102 DOT_IMAGE_FORMAT = png | |
| 1103 | |
| 1104 # The tag DOT_PATH can be used to specify the path where the dot tool can be | |
| 1105 # found. If left blank, it is assumed the dot tool can be found on the path. | |
| 1106 | |
| 1107 DOT_PATH = | |
| 1108 | |
| 1109 # The DOTFILE_DIRS tag can be used to specify one or more directories that | |
| 1110 # contain dot files that are included in the documentation (see the | |
| 1111 # \dotfile command). | |
| 1112 | |
| 1113 DOTFILE_DIRS = | |
| 1114 | |
| 1115 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | |
| 1116 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 1117 # this value, doxygen will try to truncate the graph, so that it fits within | |
| 1118 # the specified constraint. Beware that most browsers cannot cope with very | |
| 1119 # large images. | |
| 1120 | |
| 1121 MAX_DOT_GRAPH_WIDTH = 1024 | |
| 1122 | |
| 1123 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | |
| 1124 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 1125 # this value, doxygen will try to truncate the graph, so that it fits within | |
| 1126 # the specified constraint. Beware that most browsers cannot cope with very | |
| 1127 # large images. | |
| 1128 | |
| 1129 MAX_DOT_GRAPH_HEIGHT = 1024 | |
| 1130 | |
| 1131 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | |
| 1132 # graphs generated by dot. A depth value of 3 means that only nodes reachable | |
| 1133 # from the root by following a path via at most 3 edges will be shown. Nodes that | |
| 1134 # lay further from the root node will be omitted. Note that setting this option to | |
| 1135 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also | |
| 1136 # note that a graph may be further truncated if the graph's image dimensions are | |
| 1137 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | |
| 1138 # If 0 is used for the depth value (the default), the graph is not depth-constrained. | |
| 1139 | |
| 1140 MAX_DOT_GRAPH_DEPTH = 0 | |
| 1141 | |
| 1142 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | |
| 1143 # generate a legend page explaining the meaning of the various boxes and | |
| 1144 # arrows in the dot generated graphs. | |
| 1145 | |
| 1146 GENERATE_LEGEND = YES | |
| 1147 | |
| 1148 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | |
| 1149 # remove the intermediate dot files that are used to generate | |
| 1150 # the various graphs. | |
| 1151 | |
| 1152 DOT_CLEANUP = YES | |
| 1153 | |
| 1154 #--------------------------------------------------------------------------- | |
| 1155 # Configuration::additions related to the search engine | |
| 1156 #--------------------------------------------------------------------------- | |
| 1157 | |
| 1158 # The SEARCHENGINE tag specifies whether or not a search engine should be | |
| 1159 # used. If set to NO the values of all tags below this one will be ignored. | |
| 1160 | |
| 1161 SEARCHENGINE = NO |