Mercurial > SDL_sound_CoreAudio
annotate Doxyfile @ 407:1c7ed7097a9c
Updated.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Sun, 21 Jul 2002 15:18:49 +0000 |
| parents | 8c8ecd1008c9 |
| children | e6fa92dc21eb |
| rev | line source |
|---|---|
| 354 | 1 # Doxyfile 1.2.16 |
| 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 # General 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 = SDL_sound | |
| 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 = 0.1.5 | |
| 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 = docs | |
| 34 | |
| 35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all | |
| 36 # documentation generated by doxygen is written. Doxygen will use this | |
| 37 # information to generate all constant output in the proper language. | |
| 38 # The default language is English, other supported languages are: | |
| 39 # Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | |
| 40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, | |
| 41 # Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene, | |
| 42 # Spanish, Swedish and Ukrainian. | |
| 43 | |
| 44 OUTPUT_LANGUAGE = English | |
| 45 | |
| 46 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | |
| 47 # documentation are documented, even if no documentation was available. | |
| 48 # Private class members and static file members will be hidden unless | |
| 49 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | |
| 50 | |
| 51 EXTRACT_ALL = NO | |
| 52 | |
| 53 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | |
| 54 # will be included in the documentation. | |
| 55 | |
| 56 EXTRACT_PRIVATE = NO | |
| 57 | |
| 58 # If the EXTRACT_STATIC tag is set to YES all static members of a file | |
| 59 # will be included in the documentation. | |
| 60 | |
| 61 EXTRACT_STATIC = NO | |
| 62 | |
| 63 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | |
| 64 # defined locally in source files will be included in the documentation. | |
| 65 # If set to NO only classes defined in header files are included. | |
| 66 | |
| 67 EXTRACT_LOCAL_CLASSES = NO | |
| 68 | |
| 69 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | |
| 70 # undocumented members of documented classes, files or namespaces. | |
| 71 # If set to NO (the default) these members will be included in the | |
| 72 # various overviews, but no documentation section is generated. | |
| 73 # This option has no effect if EXTRACT_ALL is enabled. | |
| 74 | |
| 75 HIDE_UNDOC_MEMBERS = NO | |
| 76 | |
| 77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | |
| 78 # undocumented classes that are normally visible in the class hierarchy. | |
| 79 # If set to NO (the default) these class will be included in the various | |
| 80 # overviews. This option has no effect if EXTRACT_ALL is enabled. | |
| 81 | |
| 82 HIDE_UNDOC_CLASSES = NO | |
| 83 | |
| 84 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | |
| 85 # include brief member descriptions after the members that are listed in | |
| 86 # the file and class documentation (similar to JavaDoc). | |
| 87 # Set to NO to disable this. | |
| 88 | |
| 89 BRIEF_MEMBER_DESC = YES | |
| 90 | |
| 91 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | |
| 92 # the brief description of a member or function before the detailed description. | |
| 93 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | |
| 94 # brief descriptions will be completely suppressed. | |
| 95 | |
| 96 REPEAT_BRIEF = YES | |
| 97 | |
| 98 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | |
| 99 # Doxygen will generate a detailed section even if there is only a brief | |
| 100 # description. | |
| 101 | |
| 102 ALWAYS_DETAILED_SEC = NO | |
| 103 | |
| 104 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | |
| 105 # members of a class in the documentation of that class as if those members were | |
| 106 # ordinary class members. Constructors, destructors and assignment operators of | |
| 107 # the base classes will not be shown. | |
| 108 | |
| 109 INLINE_INHERITED_MEMB = NO | |
| 110 | |
| 111 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | |
| 112 # path before files name in the file list and in the header files. If set | |
| 113 # to NO the shortest path that makes the file name unique will be used. | |
| 114 | |
| 115 FULL_PATH_NAMES = NO | |
| 116 | |
| 117 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | |
| 118 # can be used to strip a user defined part of the path. Stripping is | |
| 119 # only done if one of the specified strings matches the left-hand part of | |
| 120 # the path. It is allowed to use relative paths in the argument list. | |
| 121 | |
| 122 STRIP_FROM_PATH = | |
| 123 | |
| 124 # The INTERNAL_DOCS tag determines if documentation | |
| 125 # that is typed after a \internal command is included. If the tag is set | |
| 126 # to NO (the default) then the documentation will be excluded. | |
| 127 # Set it to YES to include the internal documentation. | |
| 128 | |
| 129 INTERNAL_DOCS = NO | |
| 130 | |
| 131 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | |
| 132 # doxygen to hide any special comment blocks from generated source code | |
| 133 # fragments. Normal C and C++ comments will always remain visible. | |
| 134 | |
| 135 STRIP_CODE_COMMENTS = YES | |
| 136 | |
| 137 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | |
| 138 # file names in lower case letters. If set to YES upper case letters are also | |
| 139 # allowed. This is useful if you have classes or files whose names only differ | |
| 140 # in case and if your file system supports case sensitive file names. Windows | |
| 141 # users are adviced to set this option to NO. | |
| 142 | |
| 143 CASE_SENSE_NAMES = YES | |
| 144 | |
| 145 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | |
| 146 # (but less readable) file names. This can be useful is your file systems | |
| 147 # doesn't support long names like on DOS, Mac, or CD-ROM. | |
| 148 | |
| 149 SHORT_NAMES = NO | |
| 150 | |
| 151 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | |
| 152 # will show members with their full class and namespace scopes in the | |
| 153 # documentation. If set to YES the scope will be hidden. | |
| 154 | |
| 155 HIDE_SCOPE_NAMES = NO | |
| 156 | |
| 157 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | |
| 158 # will generate a verbatim copy of the header file for each class for | |
| 159 # which an include is specified. Set to NO to disable this. | |
| 160 | |
| 161 VERBATIM_HEADERS = YES | |
| 162 | |
| 163 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | |
| 164 # will put list of the files that are included by a file in the documentation | |
| 165 # of that file. | |
| 166 | |
| 167 SHOW_INCLUDE_FILES = YES | |
| 168 | |
| 169 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | |
| 170 # will interpret the first line (until the first dot) of a JavaDoc-style | |
| 171 # comment as the brief description. If set to NO, the JavaDoc | |
| 172 # comments will behave just like the Qt-style comments (thus requiring an | |
| 173 # explict @brief command for a brief description. | |
| 174 | |
| 175 JAVADOC_AUTOBRIEF = NO | |
| 176 | |
| 177 # If the DETAILS_AT_TOP tag is set to YES then Doxygen | |
| 178 # will output the detailed description near the top, like JavaDoc. | |
| 179 # If set to NO, the detailed description appears after the member | |
| 180 # documentation. | |
| 181 | |
| 182 DETAILS_AT_TOP = NO | |
| 183 | |
| 184 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | |
| 185 # member inherits the documentation from any documented member that it | |
| 186 # reimplements. | |
| 187 | |
| 188 INHERIT_DOCS = YES | |
| 189 | |
| 190 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | |
| 191 # is inserted in the documentation for inline members. | |
| 192 | |
| 193 INLINE_INFO = YES | |
| 194 | |
| 195 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | |
| 196 # will sort the (detailed) documentation of file and class members | |
| 197 # alphabetically by member name. If set to NO the members will appear in | |
| 198 # declaration order. | |
| 199 | |
| 200 SORT_MEMBER_DOCS = YES | |
| 201 | |
| 202 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
| 203 # tag is set to YES, then doxygen will reuse the documentation of the first | |
| 204 # member in the group (if any) for the other members of the group. By default | |
| 205 # all members of a group must be documented explicitly. | |
| 206 | |
| 207 DISTRIBUTE_GROUP_DOC = NO | |
| 208 | |
| 209 # The TAB_SIZE tag can be used to set the number of spaces in a tab. | |
| 210 # Doxygen uses this value to replace tabs by spaces in code fragments. | |
| 211 | |
| 212 TAB_SIZE = 4 | |
| 213 | |
| 214 # The GENERATE_TODOLIST tag can be used to enable (YES) or | |
| 215 # disable (NO) the todo list. This list is created by putting \todo | |
| 216 # commands in the documentation. | |
| 217 | |
| 218 GENERATE_TODOLIST = YES | |
| 219 | |
| 220 # The GENERATE_TESTLIST tag can be used to enable (YES) or | |
| 221 # disable (NO) the test list. This list is created by putting \test | |
| 222 # commands in the documentation. | |
| 223 | |
| 224 GENERATE_TESTLIST = YES | |
| 225 | |
| 226 # The GENERATE_BUGLIST tag can be used to enable (YES) or | |
| 227 # disable (NO) the bug list. This list is created by putting \bug | |
| 228 # commands in the documentation. | |
| 229 | |
| 230 GENERATE_BUGLIST = YES | |
| 231 | |
| 232 # This tag can be used to specify a number of aliases that acts | |
| 233 # as commands in the documentation. An alias has the form "name=value". | |
| 234 # For example adding "sideeffect=\par Side Effects:\n" will allow you to | |
| 235 # put the command \sideeffect (or @sideeffect) in the documentation, which | |
| 236 # will result in a user defined paragraph with heading "Side Effects:". | |
| 237 # You can put \n's in the value part of an alias to insert newlines. | |
| 238 | |
| 239 ALIASES = | |
| 240 | |
| 241 # The ENABLED_SECTIONS tag can be used to enable conditional | |
| 242 # documentation sections, marked by \if sectionname ... \endif. | |
| 243 | |
| 244 ENABLED_SECTIONS = | |
| 245 | |
| 246 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | |
| 247 # the initial value of a variable or define consist of for it to appear in | |
| 248 # the documentation. If the initializer consists of more lines than specified | |
| 249 # here it will be hidden. Use a value of 0 to hide initializers completely. | |
| 250 # The appearance of the initializer of individual variables and defines in the | |
| 251 # documentation can be controlled using \showinitializer or \hideinitializer | |
| 252 # command in the documentation regardless of this setting. | |
| 253 | |
| 254 MAX_INITIALIZER_LINES = 30 | |
| 255 | |
| 256 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | |
| 257 # only. Doxygen will then generate output that is more tailored for C. | |
| 258 # For instance some of the names that are used will be different. The list | |
| 259 # of all members will be omitted, etc. | |
| 260 | |
| 261 OPTIMIZE_OUTPUT_FOR_C = YES | |
| 262 | |
| 263 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | |
| 264 # only. Doxygen will then generate output that is more tailored for Java. | |
| 265 # For instance namespaces will be presented as packages, qualified scopes | |
| 266 # will look different, etc. | |
| 267 | |
| 268 OPTIMIZE_OUTPUT_JAVA = NO | |
| 269 | |
| 270 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | |
| 271 # at the bottom of the documentation of classes and structs. If set to YES the | |
| 272 # list will mention the files that were used to generate the documentation. | |
| 273 | |
| 274 SHOW_USED_FILES = YES | |
| 275 | |
| 276 #--------------------------------------------------------------------------- | |
| 277 # configuration options related to warning and progress messages | |
| 278 #--------------------------------------------------------------------------- | |
| 279 | |
| 280 # The QUIET tag can be used to turn on/off the messages that are generated | |
| 281 # by doxygen. Possible values are YES and NO. If left blank NO is used. | |
| 282 | |
| 283 QUIET = NO | |
| 284 | |
| 285 # The WARNINGS tag can be used to turn on/off the warning messages that are | |
| 286 # generated by doxygen. Possible values are YES and NO. If left blank | |
| 287 # NO is used. | |
| 288 | |
| 289 WARNINGS = YES | |
| 290 | |
| 291 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | |
| 292 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | |
| 293 # automatically be disabled. | |
| 294 | |
| 295 WARN_IF_UNDOCUMENTED = YES | |
| 296 | |
| 297 # The WARN_FORMAT tag determines the format of the warning messages that | |
| 298 # doxygen can produce. The string should contain the $file, $line, and $text | |
| 299 # tags, which will be replaced by the file and line number from which the | |
| 300 # warning originated and the warning text. | |
| 301 | |
| 302 WARN_FORMAT = "$file:$line: $text" | |
| 303 | |
| 304 # The WARN_LOGFILE tag can be used to specify a file to which warning | |
| 305 # and error messages should be written. If left blank the output is written | |
| 306 # to stderr. | |
| 307 | |
| 308 WARN_LOGFILE = | |
| 309 | |
| 310 #--------------------------------------------------------------------------- | |
| 311 # configuration options related to the input files | |
| 312 #--------------------------------------------------------------------------- | |
| 313 | |
| 314 # The INPUT tag can be used to specify the files and/or directories that contain | |
| 315 # documented source files. You may enter file names like "myfile.cpp" or | |
| 316 # directories like "/usr/src/myproject". Separate the files or directories | |
| 317 # with spaces. | |
| 318 | |
| 319 INPUT = SDL_sound.h | |
| 320 | |
| 321 # If the value of the INPUT tag contains directories, you can use the | |
| 322 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 323 # and *.h) to filter out the source-files in the directories. If left | |
| 324 # blank the following patterns are tested: | |
| 325 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | |
| 326 # *.h++ *.idl *.odl | |
| 327 | |
| 328 FILE_PATTERNS = | |
| 329 | |
| 330 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | |
| 331 # should be searched for input files as well. Possible values are YES and NO. | |
| 332 # If left blank NO is used. | |
| 333 | |
| 334 RECURSIVE = NO | |
| 335 | |
| 336 # The EXCLUDE tag can be used to specify files and/or directories that should | |
| 337 # excluded from the INPUT source files. This way you can easily exclude a | |
| 338 # subdirectory from a directory tree whose root is specified with the INPUT tag. | |
| 339 | |
| 340 EXCLUDE = | |
| 341 | |
| 342 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | |
| 343 # that are symbolic links (a Unix filesystem feature) are excluded from the input. | |
| 344 | |
| 345 EXCLUDE_SYMLINKS = NO | |
| 346 | |
| 347 # If the value of the INPUT tag contains directories, you can use the | |
| 348 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
| 349 # certain files from those directories. | |
| 350 | |
| 351 EXCLUDE_PATTERNS = | |
| 352 | |
| 353 # The EXAMPLE_PATH tag can be used to specify one or more files or | |
| 354 # directories that contain example code fragments that are included (see | |
| 355 # the \include command). | |
| 356 | |
| 357 EXAMPLE_PATH = | |
| 358 | |
| 359 # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |
| 360 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 361 # and *.h) to filter out the source-files in the directories. If left | |
| 362 # blank all files are included. | |
| 363 | |
| 364 EXAMPLE_PATTERNS = | |
| 365 | |
| 366 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |
| 367 # searched for input files to be used with the \include or \dontinclude | |
| 368 # commands irrespective of the value of the RECURSIVE tag. | |
| 369 # Possible values are YES and NO. If left blank NO is used. | |
| 370 | |
| 371 EXAMPLE_RECURSIVE = NO | |
| 372 | |
| 373 # The IMAGE_PATH tag can be used to specify one or more files or | |
| 374 # directories that contain image that are included in the documentation (see | |
| 375 # the \image command). | |
| 376 | |
| 377 IMAGE_PATH = | |
| 378 | |
| 379 # The INPUT_FILTER tag can be used to specify a program that doxygen should | |
| 380 # invoke to filter for each input file. Doxygen will invoke the filter program | |
| 381 # by executing (via popen()) the command <filter> <input-file>, where <filter> | |
| 382 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | |
| 383 # input file. Doxygen will then use the output that the filter program writes | |
| 384 # to standard output. | |
| 385 | |
| 386 INPUT_FILTER = | |
| 387 | |
| 388 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |
| 389 # INPUT_FILTER) will be used to filter the input files when producing source | |
| 390 # files to browse. | |
| 391 | |
| 392 FILTER_SOURCE_FILES = NO | |
| 393 | |
| 394 #--------------------------------------------------------------------------- | |
| 395 # configuration options related to source browsing | |
| 396 #--------------------------------------------------------------------------- | |
| 397 | |
| 398 # If the SOURCE_BROWSER tag is set to YES then a list of source files will | |
| 399 # be generated. Documented entities will be cross-referenced with these sources. | |
| 400 | |
| 401 SOURCE_BROWSER = NO | |
| 402 | |
| 403 # Setting the INLINE_SOURCES tag to YES will include the body | |
| 404 # of functions and classes directly in the documentation. | |
| 405 | |
| 406 INLINE_SOURCES = NO | |
| 407 | |
| 408 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | |
| 409 # then for each documented function all documented | |
| 410 # functions referencing it will be listed. | |
| 411 | |
| 412 REFERENCED_BY_RELATION = YES | |
| 413 | |
| 414 # If the REFERENCES_RELATION tag is set to YES (the default) | |
| 415 # then for each documented function all documented entities | |
| 416 # called/used by that function will be listed. | |
| 417 | |
| 418 REFERENCES_RELATION = YES | |
| 419 | |
| 420 #--------------------------------------------------------------------------- | |
| 421 # configuration options related to the alphabetical class index | |
| 422 #--------------------------------------------------------------------------- | |
| 423 | |
| 424 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | |
| 425 # of all compounds will be generated. Enable this if the project | |
| 426 # contains a lot of classes, structs, unions or interfaces. | |
| 427 | |
| 428 ALPHABETICAL_INDEX = NO | |
| 429 | |
| 430 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | |
| 431 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | |
| 432 # in which this list will be split (can be a number in the range [1..20]) | |
| 433 | |
| 434 COLS_IN_ALPHA_INDEX = 5 | |
| 435 | |
| 436 # In case all classes in a project start with a common prefix, all | |
| 437 # classes will be put under the same header in the alphabetical index. | |
| 438 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | |
| 439 # should be ignored while generating the index headers. | |
| 440 | |
| 441 IGNORE_PREFIX = | |
| 442 | |
| 443 #--------------------------------------------------------------------------- | |
| 444 # configuration options related to the HTML output | |
| 445 #--------------------------------------------------------------------------- | |
| 446 | |
| 447 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | |
| 448 # generate HTML output. | |
| 449 | |
| 450 GENERATE_HTML = YES | |
| 451 | |
| 452 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | |
| 453 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 454 # put in front of it. If left blank `html' will be used as the default path. | |
| 455 | |
| 456 HTML_OUTPUT = html | |
| 457 | |
| 458 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | |
| 459 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | |
| 460 # doxygen will generate files with .html extension. | |
| 461 | |
| 462 HTML_FILE_EXTENSION = .html | |
| 463 | |
| 464 # The HTML_HEADER tag can be used to specify a personal HTML header for | |
| 465 # each generated HTML page. If it is left blank doxygen will generate a | |
| 466 # standard header. | |
| 467 | |
| 468 HTML_HEADER = | |
| 469 | |
| 470 # The HTML_FOOTER tag can be used to specify a personal HTML footer for | |
| 471 # each generated HTML page. If it is left blank doxygen will generate a | |
| 472 # standard footer. | |
| 473 | |
| 474 HTML_FOOTER = | |
| 475 | |
| 476 # The HTML_STYLESHEET tag can be used to specify a user defined cascading | |
| 477 # style sheet that is used by each HTML page. It can be used to | |
| 478 # fine-tune the look of the HTML output. If the tag is left blank doxygen | |
| 479 # will generate a default style sheet | |
| 480 | |
| 481 HTML_STYLESHEET = | |
| 482 | |
| 483 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | |
| 484 # files or namespaces will be aligned in HTML using tables. If set to | |
| 485 # NO a bullet list will be used. | |
| 486 | |
| 487 HTML_ALIGN_MEMBERS = YES | |
| 488 | |
| 489 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | |
| 490 # will be generated that can be used as input for tools like the | |
| 491 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | |
| 492 # of the generated HTML documentation. | |
| 493 | |
| 494 GENERATE_HTMLHELP = NO | |
| 495 | |
| 496 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | |
| 497 # controls if a separate .chi index file is generated (YES) or that | |
| 498 # it should be included in the master .chm file (NO). | |
| 499 | |
| 500 GENERATE_CHI = NO | |
| 501 | |
| 502 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | |
| 503 # controls whether a binary table of contents is generated (YES) or a | |
| 504 # normal table of contents (NO) in the .chm file. | |
| 505 | |
| 506 BINARY_TOC = NO | |
| 507 | |
| 508 # The TOC_EXPAND flag can be set to YES to add extra items for group members | |
| 509 # to the contents of the Html help documentation and to the tree view. | |
| 510 | |
| 511 TOC_EXPAND = NO | |
| 512 | |
| 513 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | |
| 514 # top of each HTML page. The value NO (the default) enables the index and | |
| 515 # the value YES disables it. | |
| 516 | |
| 517 DISABLE_INDEX = NO | |
| 518 | |
| 519 # This tag can be used to set the number of enum values (range [1..20]) | |
| 520 # that doxygen will group on one line in the generated HTML documentation. | |
| 521 | |
| 522 ENUM_VALUES_PER_LINE = 4 | |
| 523 | |
| 524 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | |
| 525 # generated containing a tree-like index structure (just like the one that | |
| 526 # is generated for HTML Help). For this to work a browser that supports | |
| 527 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, | |
| 528 # or Internet explorer 4.0+). Note that for large projects the tree generation | |
| 529 # can take a very long time. In such cases it is better to disable this feature. | |
| 530 # Windows users are probably better off using the HTML help feature. | |
| 531 | |
| 532 GENERATE_TREEVIEW = NO | |
| 533 | |
| 534 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | |
| 535 # used to set the initial width (in pixels) of the frame in which the tree | |
| 536 # is shown. | |
| 537 | |
| 538 TREEVIEW_WIDTH = 250 | |
| 539 | |
| 540 #--------------------------------------------------------------------------- | |
| 541 # configuration options related to the LaTeX output | |
| 542 #--------------------------------------------------------------------------- | |
| 543 | |
| 544 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | |
| 545 # generate Latex output. | |
| 546 | |
| 547 GENERATE_LATEX = YES | |
| 548 | |
| 549 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | |
| 550 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 551 # put in front of it. If left blank `latex' will be used as the default path. | |
| 552 | |
| 553 LATEX_OUTPUT = latex | |
| 554 | |
| 555 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name. | |
| 556 | |
| 557 LATEX_CMD_NAME = latex | |
| 558 | |
| 559 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | |
| 560 # generate index for LaTeX. If left blank `makeindex' will be used as the | |
| 561 # default command name. | |
| 562 | |
| 563 MAKEINDEX_CMD_NAME = makeindex | |
| 564 | |
| 565 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | |
| 566 # LaTeX documents. This may be useful for small projects and may help to | |
| 567 # save some trees in general. | |
| 568 | |
| 569 COMPACT_LATEX = NO | |
| 570 | |
| 571 # The PAPER_TYPE tag can be used to set the paper type that is used | |
| 572 # by the printer. Possible values are: a4, a4wide, letter, legal and | |
| 573 # executive. If left blank a4wide will be used. | |
| 574 | |
| 575 PAPER_TYPE = a4wide | |
| 576 | |
| 577 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | |
| 578 # packages that should be included in the LaTeX output. | |
| 579 | |
| 580 EXTRA_PACKAGES = | |
| 581 | |
| 582 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | |
| 583 # the generated latex document. The header should contain everything until | |
| 584 # the first chapter. If it is left blank doxygen will generate a | |
| 585 # standard header. Notice: only use this tag if you know what you are doing! | |
| 586 | |
| 587 LATEX_HEADER = | |
| 588 | |
| 589 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | |
| 590 # is prepared for conversion to pdf (using ps2pdf). The pdf file will | |
| 591 # contain links (just like the HTML output) instead of page references | |
| 592 # This makes the output suitable for online browsing using a pdf viewer. | |
| 593 | |
| 594 PDF_HYPERLINKS = NO | |
| 595 | |
| 596 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | |
| 597 # plain latex in the generated Makefile. Set this option to YES to get a | |
| 598 # higher quality PDF documentation. | |
| 599 | |
| 600 USE_PDFLATEX = NO | |
| 601 | |
| 602 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | |
| 603 # command to the generated LaTeX files. This will instruct LaTeX to keep | |
| 604 # running if errors occur, instead of asking the user for help. | |
| 605 # This option is also used when generating formulas in HTML. | |
| 606 | |
| 607 LATEX_BATCHMODE = NO | |
| 608 | |
| 609 #--------------------------------------------------------------------------- | |
| 610 # configuration options related to the RTF output | |
| 611 #--------------------------------------------------------------------------- | |
| 612 | |
| 613 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | |
| 614 # The RTF output is optimised for Word 97 and may not look very pretty with | |
| 615 # other RTF readers or editors. | |
| 616 | |
| 617 GENERATE_RTF = NO | |
| 618 | |
| 619 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | |
| 620 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 621 # put in front of it. If left blank `rtf' will be used as the default path. | |
| 622 | |
| 623 RTF_OUTPUT = rtf | |
| 624 | |
| 625 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | |
| 626 # RTF documents. This may be useful for small projects and may help to | |
| 627 # save some trees in general. | |
| 628 | |
| 629 COMPACT_RTF = NO | |
| 630 | |
| 631 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | |
| 632 # will contain hyperlink fields. The RTF file will | |
| 633 # contain links (just like the HTML output) instead of page references. | |
| 634 # This makes the output suitable for online browsing using WORD or other | |
| 635 # programs which support those fields. | |
| 636 # Note: wordpad (write) and others do not support links. | |
| 637 | |
| 638 RTF_HYPERLINKS = NO | |
| 639 | |
| 640 # Load stylesheet definitions from file. Syntax is similar to doxygen's | |
| 641 # config file, i.e. a series of assigments. You only have to provide | |
| 642 # replacements, missing definitions are set to their default value. | |
| 643 | |
| 644 RTF_STYLESHEET_FILE = | |
| 645 | |
| 646 # Set optional variables used in the generation of an rtf document. | |
| 647 # Syntax is similar to doxygen's config file. | |
| 648 | |
| 649 RTF_EXTENSIONS_FILE = | |
| 650 | |
| 651 #--------------------------------------------------------------------------- | |
| 652 # configuration options related to the man page output | |
| 653 #--------------------------------------------------------------------------- | |
| 654 | |
| 655 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | |
| 656 # generate man pages | |
| 657 | |
| 658 GENERATE_MAN = YES | |
| 659 | |
| 660 # The MAN_OUTPUT tag is used to specify where the man pages will be put. | |
| 661 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 662 # put in front of it. If left blank `man' will be used as the default path. | |
| 663 | |
| 664 MAN_OUTPUT = man | |
| 665 | |
| 666 # The MAN_EXTENSION tag determines the extension that is added to | |
| 667 # the generated man pages (default is the subroutine's section .3) | |
| 668 | |
| 669 MAN_EXTENSION = .3 | |
| 670 | |
| 671 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | |
| 672 # then it will generate one additional man file for each entity | |
| 673 # documented in the real man page(s). These additional files | |
| 674 # only source the real man page, but without them the man command | |
| 675 # would be unable to find the correct page. The default is NO. | |
| 676 | |
| 677 MAN_LINKS = YES | |
| 678 | |
| 679 #--------------------------------------------------------------------------- | |
| 680 # configuration options related to the XML output | |
| 681 #--------------------------------------------------------------------------- | |
| 682 | |
| 683 # If the GENERATE_XML tag is set to YES Doxygen will | |
| 684 # generate an XML file that captures the structure of | |
| 685 # the code including all documentation. Note that this | |
| 686 # feature is still experimental and incomplete at the | |
| 687 # moment. | |
| 688 | |
| 689 GENERATE_XML = NO | |
| 690 | |
| 691 #--------------------------------------------------------------------------- | |
| 692 # configuration options for the AutoGen Definitions output | |
| 693 #--------------------------------------------------------------------------- | |
| 694 | |
| 695 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | |
| 696 # generate an AutoGen Definitions (see autogen.sf.net) file | |
| 697 # that captures the structure of the code including all | |
| 698 # documentation. Note that this feature is still experimental | |
| 699 # and incomplete at the moment. | |
| 700 | |
| 701 GENERATE_AUTOGEN_DEF = NO | |
| 702 | |
| 703 #--------------------------------------------------------------------------- | |
| 704 # Configuration options related to the preprocessor | |
| 705 #--------------------------------------------------------------------------- | |
| 706 | |
| 707 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | |
| 708 # evaluate all C-preprocessor directives found in the sources and include | |
| 709 # files. | |
| 710 | |
| 711 ENABLE_PREPROCESSING = YES | |
| 712 | |
| 713 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | |
| 714 # names in the source code. If set to NO (the default) only conditional | |
| 715 # compilation will be performed. Macro expansion can be done in a controlled | |
| 716 # way by setting EXPAND_ONLY_PREDEF to YES. | |
| 717 | |
| 718 MACRO_EXPANSION = YES | |
| 719 | |
| 720 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | |
| 721 # then the macro expansion is limited to the macros specified with the | |
| 722 # PREDEFINED and EXPAND_AS_PREDEFINED tags. | |
| 723 | |
| 724 EXPAND_ONLY_PREDEF = YES | |
| 725 | |
| 726 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | |
| 727 # in the INCLUDE_PATH (see below) will be search if a #include is found. | |
| 728 | |
| 729 SEARCH_INCLUDES = YES | |
| 730 | |
| 731 # The INCLUDE_PATH tag can be used to specify one or more directories that | |
| 732 # contain include files that are not input files but should be processed by | |
| 733 # the preprocessor. | |
| 734 | |
| 735 INCLUDE_PATH = | |
| 736 | |
| 737 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |
| 738 # patterns (like *.h and *.hpp) to filter out the header-files in the | |
| 739 # directories. If left blank, the patterns specified with FILE_PATTERNS will | |
| 740 # be used. | |
| 741 | |
| 742 INCLUDE_FILE_PATTERNS = | |
| 743 | |
| 744 # The PREDEFINED tag can be used to specify one or more macro names that | |
| 745 # are defined before the preprocessor is started (similar to the -D option of | |
| 746 # gcc). The argument of the tag is a list of macros of the form: name | |
| 747 # or name=definition (no spaces). If the definition and the = are | |
| 748 # omitted =1 is assumed. | |
| 749 | |
|
386
8c8ecd1008c9
Changed DECLSPEC definition.
Ryan C. Gordon <icculus@icculus.org>
parents:
354
diff
changeset
|
750 PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 SNDDECLSPEC= |
| 354 | 751 |
| 752 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then | |
| 753 # this tag can be used to specify a list of macro names that should be expanded. | |
| 754 # The macro definition that is found in the sources will be used. | |
| 755 # Use the PREDEFINED tag if you want to use a different macro definition. | |
| 756 | |
| 757 EXPAND_AS_DEFINED = | |
| 758 | |
| 759 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | |
| 760 # doxygen's preprocessor will remove all function-like macros that are alone | |
| 761 # on a line and do not end with a semicolon. Such function macros are typically | |
| 762 # used for boiler-plate code, and will confuse the parser if not removed. | |
| 763 | |
| 764 SKIP_FUNCTION_MACROS = YES | |
| 765 | |
| 766 #--------------------------------------------------------------------------- | |
| 767 # Configuration::addtions related to external references | |
| 768 #--------------------------------------------------------------------------- | |
| 769 | |
| 770 # The TAGFILES tag can be used to specify one or more tagfiles. | |
| 771 | |
| 772 TAGFILES = | |
| 773 | |
| 774 # When a file name is specified after GENERATE_TAGFILE, doxygen will create | |
| 775 # a tag file that is based on the input files it reads. | |
| 776 | |
| 777 GENERATE_TAGFILE = | |
| 778 | |
| 779 # If the ALLEXTERNALS tag is set to YES all external classes will be listed | |
| 780 # in the class index. If set to NO only the inherited external classes | |
| 781 # will be listed. | |
| 782 | |
| 783 ALLEXTERNALS = NO | |
| 784 | |
| 785 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | |
| 786 # in the modules index. If set to NO, only the current project's groups will | |
| 787 # be listed. | |
| 788 | |
| 789 EXTERNAL_GROUPS = YES | |
| 790 | |
| 791 # The PERL_PATH should be the absolute path and name of the perl script | |
| 792 # interpreter (i.e. the result of `which perl'). | |
| 793 | |
| 794 PERL_PATH = /usr/bin/perl | |
| 795 | |
| 796 #--------------------------------------------------------------------------- | |
| 797 # Configuration options related to the dot tool | |
| 798 #--------------------------------------------------------------------------- | |
| 799 | |
| 800 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | |
| 801 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or | |
| 802 # super classes. Setting the tag to NO turns the diagrams off. Note that this | |
| 803 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | |
| 804 # recommended to install and use dot, since it yields more powerful graphs. | |
| 805 | |
| 806 CLASS_DIAGRAMS = NO | |
| 807 | |
| 808 # If set to YES, the inheritance and collaboration graphs will hide | |
| 809 # inheritance and usage relations if the target is undocumented | |
| 810 # or is not a class. | |
| 811 | |
| 812 HIDE_UNDOC_RELATIONS = YES | |
| 813 | |
| 814 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |
| 815 # available from the path. This tool is part of Graphviz, a graph visualization | |
| 816 # toolkit from AT&T and Lucent Bell Labs. The other options in this section | |
| 817 # have no effect if this option is set to NO (the default) | |
| 818 | |
| 819 HAVE_DOT = NO | |
| 820 | |
| 821 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 822 # will generate a graph for each documented class showing the direct and | |
| 823 # indirect inheritance relations. Setting this tag to YES will force the | |
| 824 # the CLASS_DIAGRAMS tag to NO. | |
| 825 | |
| 826 CLASS_GRAPH = NO | |
| 827 | |
| 828 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 829 # will generate a graph for each documented class showing the direct and | |
| 830 # indirect implementation dependencies (inheritance, containment, and | |
| 831 # class references variables) of the class with other documented classes. | |
| 832 | |
| 833 COLLABORATION_GRAPH = NO | |
| 834 | |
| 835 # If set to YES, the inheritance and collaboration graphs will show the | |
| 836 # relations between templates and their instances. | |
| 837 | |
| 838 TEMPLATE_RELATIONS = NO | |
| 839 | |
| 840 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | |
| 841 # tags are set to YES then doxygen will generate a graph for each documented | |
| 842 # file showing the direct and indirect include dependencies of the file with | |
| 843 # other documented files. | |
| 844 | |
| 845 INCLUDE_GRAPH = NO | |
| 846 | |
| 847 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | |
| 848 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | |
| 849 # documented header file showing the documented files that directly or | |
| 850 # indirectly include this file. | |
| 851 | |
| 852 INCLUDED_BY_GRAPH = YES | |
| 853 | |
| 854 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | |
| 855 # will graphical hierarchy of all classes instead of a textual one. | |
| 856 | |
| 857 GRAPHICAL_HIERARCHY = YES | |
| 858 | |
| 859 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |
| 860 # generated by dot. Possible values are png, jpg, or gif | |
| 861 # If left blank png will be used. | |
| 862 | |
| 863 DOT_IMAGE_FORMAT = png | |
| 864 | |
| 865 # The tag DOT_PATH can be used to specify the path where the dot tool can be | |
| 866 # found. If left blank, it is assumed the dot tool can be found on the path. | |
| 867 | |
| 868 DOT_PATH = | |
| 869 | |
| 870 # The DOTFILE_DIRS tag can be used to specify one or more directories that | |
| 871 # contain dot files that are included in the documentation (see the | |
| 872 # \dotfile command). | |
| 873 | |
| 874 DOTFILE_DIRS = | |
| 875 | |
| 876 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | |
| 877 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 878 # this value, doxygen will try to truncate the graph, so that it fits within | |
| 879 # the specified constraint. Beware that most browsers cannot cope with very | |
| 880 # large images. | |
| 881 | |
| 882 MAX_DOT_GRAPH_WIDTH = 1024 | |
| 883 | |
| 884 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | |
| 885 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 886 # this value, doxygen will try to truncate the graph, so that it fits within | |
| 887 # the specified constraint. Beware that most browsers cannot cope with very | |
| 888 # large images. | |
| 889 | |
| 890 MAX_DOT_GRAPH_HEIGHT = 1024 | |
| 891 | |
| 892 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | |
| 893 # generate a legend page explaining the meaning of the various boxes and | |
| 894 # arrows in the dot generated graphs. | |
| 895 | |
| 896 GENERATE_LEGEND = YES | |
| 897 | |
| 898 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | |
| 899 # remove the intermedate dot files that are used to generate | |
| 900 # the various graphs. | |
| 901 | |
| 902 DOT_CLEANUP = YES | |
| 903 | |
| 904 #--------------------------------------------------------------------------- | |
| 905 # Configuration::addtions related to the search engine | |
| 906 #--------------------------------------------------------------------------- | |
| 907 | |
| 908 # The SEARCHENGINE tag specifies whether or not a search engine should be | |
| 909 # used. If set to NO the values of all tags below this one will be ignored. | |
| 910 | |
| 911 SEARCHENGINE = NO | |
| 912 | |
| 913 # The CGI_NAME tag should be the name of the CGI script that | |
| 914 # starts the search engine (doxysearch) with the correct parameters. | |
| 915 # A script with this name will be generated by doxygen. | |
| 916 | |
| 917 CGI_NAME = search.cgi | |
| 918 | |
| 919 # The CGI_URL tag should be the absolute URL to the directory where the | |
| 920 # cgi binaries are located. See the documentation of your http daemon for | |
| 921 # details. | |
| 922 | |
| 923 CGI_URL = | |
| 924 | |
| 925 # The DOC_URL tag should be the absolute URL to the directory where the | |
| 926 # documentation is located. If left blank the absolute path to the | |
| 927 # documentation, with file:// prepended to it, will be used. | |
| 928 | |
| 929 DOC_URL = | |
| 930 | |
| 931 # The DOC_ABSPATH tag should be the absolute path to the directory where the | |
| 932 # documentation is located. If left blank the directory on the local machine | |
| 933 # will be used. | |
| 934 | |
| 935 DOC_ABSPATH = | |
| 936 | |
| 937 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary | |
| 938 # is installed. | |
| 939 | |
| 940 BIN_ABSPATH = /usr/local/bin/ | |
| 941 | |
| 942 # The EXT_DOC_PATHS tag can be used to specify one or more paths to | |
| 943 # documentation generated for other projects. This allows doxysearch to search | |
| 944 # the documentation for these projects as well. | |
| 945 | |
| 946 EXT_DOC_PATHS = |