doxyfile (65794B)
1 # Doxyfile 1.5.9 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 # This tag specifies the encoding used for all characters in the config file 18 # that follow. The default is UTF-8 which is also the encoding used for all 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 # iconv built into libc) for the transcoding. See 21 # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 23 DOXYFILE_ENCODING = UTF-8 24 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26 # by quotes) that should identify the project. 27 28 PROJECT_NAME = SDL 29 30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 31 # This could be handy for archiving the generated documentation or 32 # if some version control system is used. 33 34 PROJECT_NUMBER = 2.0 35 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37 # base path where the generated documentation will be put. 38 # If a relative path is entered, it will be relative to the location 39 # where doxygen was started. If left blank the current directory will be used. 40 41 OUTPUT_DIRECTORY = ./output 42 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44 # 4096 sub-directories (in 2 levels) under the output directory of each output 45 # format and will distribute the generated files over these directories. 46 # Enabling this option can be useful when feeding doxygen a huge amount of 47 # source files, where putting all generated files in the same directory would 48 # otherwise cause performance problems for the file system. 49 50 CREATE_SUBDIRS = YES 51 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 53 # documentation generated by doxygen is written. Doxygen will use this 54 # information to generate all constant output in the proper language. 55 # The default language is English, other supported languages are: 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 62 63 OUTPUT_LANGUAGE = English 64 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 66 # include brief member descriptions after the members that are listed in 67 # the file and class documentation (similar to JavaDoc). 68 # Set to NO to disable this. 69 70 BRIEF_MEMBER_DESC = YES 71 72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 73 # the brief description of a member or function before the detailed description. 74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 75 # brief descriptions will be completely suppressed. 76 77 REPEAT_BRIEF = YES 78 79 # This tag implements a quasi-intelligent brief description abbreviator 80 # that is used to form the text in various listings. Each string 81 # in this list, if found as the leading text of the brief description, will be 82 # stripped from the text and the result after processing the whole list, is 83 # used as the annotated text. Otherwise, the brief description is used as-is. 84 # If left blank, the following values are used ("$name" is automatically 85 # replaced with the name of the entity): "The $name class" "The $name widget" 86 # "The $name file" "is" "provides" "specifies" "contains" 87 # "represents" "a" "an" "the" 88 89 ABBREVIATE_BRIEF = "The $name class" \ 90 "The $name widget" \ 91 "The $name file" \ 92 is \ 93 provides \ 94 specifies \ 95 contains \ 96 represents \ 97 a \ 98 an \ 99 the 100 101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 102 # Doxygen will generate a detailed section even if there is only a brief 103 # description. 104 105 ALWAYS_DETAILED_SEC = YES 106 107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 108 # inherited members of a class in the documentation of that class as if those 109 # members were ordinary class members. Constructors, destructors and assignment 110 # operators of the base classes will not be shown. 111 112 INLINE_INHERITED_MEMB = NO 113 114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 115 # path before files name in the file list and in the header files. If set 116 # to NO the shortest path that makes the file name unique will be used. 117 118 FULL_PATH_NAMES = YES 119 120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 121 # can be used to strip a user-defined part of the path. Stripping is 122 # only done if one of the specified strings matches the left-hand part of 123 # the path. The tag can be used to show relative paths in the file list. 124 # If left blank the directory from which doxygen is run is used as the 125 # path to strip. 126 127 STRIP_FROM_PATH = 128 129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 130 # the path mentioned in the documentation of a class, which tells 131 # the reader which header file to include in order to use a class. 132 # If left blank only the name of the header file containing the class 133 # definition is used. Otherwise one should specify the include paths that 134 # are normally passed to the compiler using the -I flag. 135 136 STRIP_FROM_INC_PATH = 137 138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 139 # (but less readable) file names. This can be useful is your file systems 140 # doesn't support long names like on DOS, Mac, or CD-ROM. 141 142 SHORT_NAMES = NO 143 144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 145 # will interpret the first line (until the first dot) of a JavaDoc-style 146 # comment as the brief description. If set to NO, the JavaDoc 147 # comments will behave just like regular Qt-style comments 148 # (thus requiring an explicit @brief command for a brief description.) 149 150 JAVADOC_AUTOBRIEF = NO 151 152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 153 # interpret the first line (until the first dot) of a Qt-style 154 # comment as the brief description. If set to NO, the comments 155 # will behave just like regular Qt-style comments (thus requiring 156 # an explicit \brief command for a brief description.) 157 158 QT_AUTOBRIEF = NO 159 160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 161 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 162 # comments) as a brief description. This used to be the default behaviour. 163 # The new default is to treat a multi-line C++ comment block as a detailed 164 # description. Set this tag to YES if you prefer the old behaviour instead. 165 166 MULTILINE_CPP_IS_BRIEF = NO 167 168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 169 # member inherits the documentation from any documented member that it 170 # re-implements. 171 172 INHERIT_DOCS = YES 173 174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 175 # a new page for each member. If set to NO, the documentation of a member will 176 # be part of the file/class/namespace that contains it. 177 178 SEPARATE_MEMBER_PAGES = NO 179 180 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 181 # Doxygen uses this value to replace tabs by spaces in code fragments. 182 183 TAB_SIZE = 8 184 185 # This tag can be used to specify a number of aliases that acts 186 # as commands in the documentation. An alias has the form "name=value". 187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 188 # put the command \sideeffect (or @sideeffect) in the documentation, which 189 # will result in a user-defined paragraph with heading "Side Effects:". 190 # You can put \n's in the value part of an alias to insert newlines. 191 192 ALIASES = "defined=\"\def\"" \ 193 "discussion=\"\par Discussion:\n\"" 194 195 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 196 # sources only. Doxygen will then generate output that is more tailored for C. 197 # For instance, some of the names that are used will be different. The list 198 # of all members will be omitted, etc. 199 200 OPTIMIZE_OUTPUT_FOR_C = YES 201 202 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 203 # sources only. Doxygen will then generate output that is more tailored for 204 # Java. For instance, namespaces will be presented as packages, qualified 205 # scopes will look different, etc. 206 207 OPTIMIZE_OUTPUT_JAVA = NO 208 209 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 210 # sources only. Doxygen will then generate output that is more tailored for 211 # Fortran. 212 213 OPTIMIZE_FOR_FORTRAN = NO 214 215 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 216 # sources. Doxygen will then generate output that is tailored for 217 # VHDL. 218 219 OPTIMIZE_OUTPUT_VHDL = NO 220 221 # Doxygen selects the parser to use depending on the extension of the files it parses. 222 # With this tag you can assign which parser to use for a given extension. 223 # Doxygen has a built-in mapping, but you can override or extend it using this tag. 224 # The format is ext=language, where ext is a file extension, and language is one of 225 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 226 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 227 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 228 # use: inc=Fortran f=C. Note that for custom extensions you also need to set 229 # FILE_PATTERNS otherwise the files are not read by doxygen. 230 231 EXTENSION_MAPPING = 232 233 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 234 # to include (a tag file for) the STL sources as input, then you should 235 # set this tag to YES in order to let doxygen match functions declarations and 236 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 237 # func(std::string) {}). This also make the inheritance and collaboration 238 # diagrams that involve STL classes more complete and accurate. 239 240 BUILTIN_STL_SUPPORT = YES 241 242 # If you use Microsoft's C++/CLI language, you should set this option to YES to 243 # enable parsing support. 244 245 CPP_CLI_SUPPORT = NO 246 247 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 248 # Doxygen will parse them like normal C++ but will assume all classes use public 249 # instead of private inheritance when no explicit protection keyword is present. 250 251 SIP_SUPPORT = NO 252 253 # For Microsoft's IDL there are propget and propput attributes to indicate getter 254 # and setter methods for a property. Setting this option to YES (the default) 255 # will make doxygen to replace the get and set methods by a property in the 256 # documentation. This will only work if the methods are indeed getting or 257 # setting a simple type. If this is not the case, or you want to show the 258 # methods anyway, you should set this option to NO. 259 260 IDL_PROPERTY_SUPPORT = YES 261 262 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 263 # tag is set to YES, then doxygen will reuse the documentation of the first 264 # member in the group (if any) for the other members of the group. By default 265 # all members of a group must be documented explicitly. 266 267 DISTRIBUTE_GROUP_DOC = NO 268 269 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 270 # the same type (for instance a group of public functions) to be put as a 271 # subgroup of that type (e.g. under the Public Functions section). Set it to 272 # NO to prevent subgrouping. Alternatively, this can be done per class using 273 # the \nosubgrouping command. 274 275 SUBGROUPING = YES 276 277 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 278 # is documented as struct, union, or enum with the name of the typedef. So 279 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 280 # with name TypeT. When disabled the typedef will appear as a member of a file, 281 # namespace, or class. And the struct will be named TypeS. This can typically 282 # be useful for C code in case the coding convention dictates that all compound 283 # types are typedef'ed and only the typedef is referenced, never the tag name. 284 285 TYPEDEF_HIDES_STRUCT = YES 286 287 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 288 # determine which symbols to keep in memory and which to flush to disk. 289 # When the cache is full, less often used symbols will be written to disk. 290 # For small to medium size projects (<1000 input files) the default value is 291 # probably good enough. For larger projects a too small cache size can cause 292 # doxygen to be busy swapping symbols to and from disk most of the time 293 # causing a significant performance penality. 294 # If the system has enough physical memory increasing the cache will improve the 295 # performance by keeping more symbols in memory. Note that the value works on 296 # a logarithmic scale so increasing the size by one will rougly double the 297 # memory usage. The cache size is given by this formula: 298 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 299 # corresponding to a cache size of 2^16 = 65536 symbols 300 301 SYMBOL_CACHE_SIZE = 0 302 303 #--------------------------------------------------------------------------- 304 # Build related configuration options 305 #--------------------------------------------------------------------------- 306 307 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 308 # documentation are documented, even if no documentation was available. 309 # Private class members and static file members will be hidden unless 310 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 311 312 EXTRACT_ALL = YES 313 314 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 315 # will be included in the documentation. 316 317 EXTRACT_PRIVATE = YES 318 319 # If the EXTRACT_STATIC tag is set to YES all static members of a file 320 # will be included in the documentation. 321 322 EXTRACT_STATIC = YES 323 324 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 325 # defined locally in source files will be included in the documentation. 326 # If set to NO only classes defined in header files are included. 327 328 EXTRACT_LOCAL_CLASSES = YES 329 330 # This flag is only useful for Objective-C code. When set to YES local 331 # methods, which are defined in the implementation section but not in 332 # the interface are included in the documentation. 333 # If set to NO (the default) only methods in the interface are included. 334 335 EXTRACT_LOCAL_METHODS = YES 336 337 # If this flag is set to YES, the members of anonymous namespaces will be 338 # extracted and appear in the documentation as a namespace called 339 # 'anonymous_namespace{file}', where file will be replaced with the base 340 # name of the file that contains the anonymous namespace. By default 341 # anonymous namespace are hidden. 342 343 EXTRACT_ANON_NSPACES = YES 344 345 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 346 # undocumented members of documented classes, files or namespaces. 347 # If set to NO (the default) these members will be included in the 348 # various overviews, but no documentation section is generated. 349 # This option has no effect if EXTRACT_ALL is enabled. 350 351 HIDE_UNDOC_MEMBERS = NO 352 353 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 354 # undocumented classes that are normally visible in the class hierarchy. 355 # If set to NO (the default) these classes will be included in the various 356 # overviews. This option has no effect if EXTRACT_ALL is enabled. 357 358 HIDE_UNDOC_CLASSES = NO 359 360 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 361 # friend (class|struct|union) declarations. 362 # If set to NO (the default) these declarations will be included in the 363 # documentation. 364 365 HIDE_FRIEND_COMPOUNDS = NO 366 367 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 368 # documentation blocks found inside the body of a function. 369 # If set to NO (the default) these blocks will be appended to the 370 # function's detailed documentation block. 371 372 HIDE_IN_BODY_DOCS = NO 373 374 # The INTERNAL_DOCS tag determines if documentation 375 # that is typed after a \internal command is included. If the tag is set 376 # to NO (the default) then the documentation will be excluded. 377 # Set it to YES to include the internal documentation. 378 379 INTERNAL_DOCS = YES 380 381 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 382 # file names in lower-case letters. If set to YES upper-case letters are also 383 # allowed. This is useful if you have classes or files whose names only differ 384 # in case and if your file system supports case sensitive file names. Windows 385 # and Mac users are advised to set this option to NO. 386 387 CASE_SENSE_NAMES = NO 388 389 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 390 # will show members with their full class and namespace scopes in the 391 # documentation. If set to YES the scope will be hidden. 392 393 HIDE_SCOPE_NAMES = NO 394 395 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 396 # will put a list of the files that are included by a file in the documentation 397 # of that file. 398 399 SHOW_INCLUDE_FILES = YES 400 401 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 402 # is inserted in the documentation for inline members. 403 404 INLINE_INFO = YES 405 406 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 407 # will sort the (detailed) documentation of file and class members 408 # alphabetically by member name. If set to NO the members will appear in 409 # declaration order. 410 411 SORT_MEMBER_DOCS = YES 412 413 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 414 # brief documentation of file, namespace and class members alphabetically 415 # by member name. If set to NO (the default) the members will appear in 416 # declaration order. 417 418 SORT_BRIEF_DOCS = NO 419 420 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 421 # hierarchy of group names into alphabetical order. If set to NO (the default) 422 # the group names will appear in their defined order. 423 424 SORT_GROUP_NAMES = NO 425 426 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 427 # sorted by fully-qualified names, including namespaces. If set to 428 # NO (the default), the class list will be sorted only by class name, 429 # not including the namespace part. 430 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 431 # Note: This option applies only to the class list, not to the 432 # alphabetical list. 433 434 SORT_BY_SCOPE_NAME = NO 435 436 # The GENERATE_TODOLIST tag can be used to enable (YES) or 437 # disable (NO) the todo list. This list is created by putting \todo 438 # commands in the documentation. 439 440 GENERATE_TODOLIST = YES 441 442 # The GENERATE_TESTLIST tag can be used to enable (YES) or 443 # disable (NO) the test list. This list is created by putting \test 444 # commands in the documentation. 445 446 GENERATE_TESTLIST = YES 447 448 # The GENERATE_BUGLIST tag can be used to enable (YES) or 449 # disable (NO) the bug list. This list is created by putting \bug 450 # commands in the documentation. 451 452 GENERATE_BUGLIST = YES 453 454 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 455 # disable (NO) the deprecated list. This list is created by putting 456 # \deprecated commands in the documentation. 457 458 GENERATE_DEPRECATEDLIST= YES 459 460 # The ENABLED_SECTIONS tag can be used to enable conditional 461 # documentation sections, marked by \if sectionname ... \endif. 462 463 ENABLED_SECTIONS = 464 465 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 466 # the initial value of a variable or define consists of for it to appear in 467 # the documentation. If the initializer consists of more lines than specified 468 # here it will be hidden. Use a value of 0 to hide initializers completely. 469 # The appearance of the initializer of individual variables and defines in the 470 # documentation can be controlled using \showinitializer or \hideinitializer 471 # command in the documentation regardless of this setting. 472 473 MAX_INITIALIZER_LINES = 30 474 475 # If the sources in your project are distributed over multiple directories 476 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 477 # in the documentation. The default is NO. 478 479 SHOW_DIRECTORIES = YES 480 481 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 482 # This will remove the Files entry from the Quick Index and from the 483 # Folder Tree View (if specified). The default is YES. 484 485 SHOW_FILES = YES 486 487 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 488 # Namespaces page. This will remove the Namespaces entry from the Quick Index 489 # and from the Folder Tree View (if specified). The default is YES. 490 491 SHOW_NAMESPACES = YES 492 493 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 494 # doxygen should invoke to get the current version for each file (typically from 495 # the version control system). Doxygen will invoke the program by executing (via 496 # popen()) the command <command> <input-file>, where <command> is the value of 497 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 498 # provided by doxygen. Whatever the program writes to standard output 499 # is used as the file version. See the manual for examples. 500 501 FILE_VERSION_FILTER = 502 503 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 504 # doxygen. The layout file controls the global structure of the generated output files 505 # in an output format independent way. The create the layout file that represents 506 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 507 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 508 # of the layout file. 509 510 LAYOUT_FILE = 511 512 #--------------------------------------------------------------------------- 513 # configuration options related to warning and progress messages 514 #--------------------------------------------------------------------------- 515 516 # The QUIET tag can be used to turn on/off the messages that are generated 517 # by doxygen. Possible values are YES and NO. If left blank NO is used. 518 519 QUIET = NO 520 521 # The WARNINGS tag can be used to turn on/off the warning messages that are 522 # generated by doxygen. Possible values are YES and NO. If left blank 523 # NO is used. 524 525 WARNINGS = YES 526 527 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 528 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 529 # automatically be disabled. 530 531 WARN_IF_UNDOCUMENTED = YES 532 533 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 534 # potential errors in the documentation, such as not documenting some 535 # parameters in a documented function, or documenting parameters that 536 # don't exist or using markup commands wrongly. 537 538 WARN_IF_DOC_ERROR = YES 539 540 # This WARN_NO_PARAMDOC option can be abled to get warnings for 541 # functions that are documented, but have no documentation for their parameters 542 # or return value. If set to NO (the default) doxygen will only warn about 543 # wrong or incomplete parameter documentation, but not about the absence of 544 # documentation. 545 546 WARN_NO_PARAMDOC = YES 547 548 # The WARN_FORMAT tag determines the format of the warning messages that 549 # doxygen can produce. The string should contain the $file, $line, and $text 550 # tags, which will be replaced by the file and line number from which the 551 # warning originated and the warning text. Optionally the format may contain 552 # $version, which will be replaced by the version of the file (if it could 553 # be obtained via FILE_VERSION_FILTER) 554 555 WARN_FORMAT = "$file:$line: $text" 556 557 # The WARN_LOGFILE tag can be used to specify a file to which warning 558 # and error messages should be written. If left blank the output is written 559 # to stderr. 560 561 WARN_LOGFILE = ./doxygen_warn.txt 562 563 #--------------------------------------------------------------------------- 564 # configuration options related to the input files 565 #--------------------------------------------------------------------------- 566 567 # The INPUT tag can be used to specify the files and/or directories that contain 568 # documented source files. You may enter file names like "myfile.cpp" or 569 # directories like "/usr/src/myproject". Separate the files or directories 570 # with spaces. 571 572 INPUT = . ../include 573 574 # This tag can be used to specify the character encoding of the source files 575 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 576 # also the default input encoding. Doxygen uses libiconv (or the iconv built 577 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 578 # the list of possible encodings. 579 580 INPUT_ENCODING = UTF-8 581 582 # If the value of the INPUT tag contains directories, you can use the 583 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 584 # and *.h) to filter out the source-files in the directories. If left 585 # blank the following patterns are tested: 586 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 587 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 588 589 FILE_PATTERNS = *.c \ 590 *.cc \ 591 *.cxx \ 592 *.cpp \ 593 *.c++ \ 594 *.d \ 595 *.java \ 596 *.ii \ 597 *.ixx \ 598 *.ipp \ 599 *.i++ \ 600 *.inl \ 601 *.h \ 602 *.hh \ 603 *.hxx \ 604 *.hpp \ 605 *.h++ \ 606 *.idl \ 607 *.odl \ 608 *.cs \ 609 *.php \ 610 *.php3 \ 611 *.inc \ 612 *.m \ 613 *.mm \ 614 *.dox \ 615 *.py \ 616 *.f90 \ 617 *.f \ 618 *.vhd \ 619 *.vhdl \ 620 *.h.in \ 621 *.h.default \ 622 *.md 623 624 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 625 # should be searched for input files as well. Possible values are YES and NO. 626 # If left blank NO is used. 627 628 RECURSIVE = YES 629 630 # The EXCLUDE tag can be used to specify files and/or directories that should 631 # excluded from the INPUT source files. This way you can easily exclude a 632 # subdirectory from a directory tree whose root is specified with the INPUT tag. 633 634 EXCLUDE = ../include/SDL_opengles2_gl2ext.h \ 635 ../include/SDL_opengles2_gl2platform.h \ 636 ../include/SDL_opengles2_khrplatform.h \ 637 ../include/SDL_opengl_glext.h \ 638 ../include/SDL_opengles2_gl2.h \ 639 ../include/SDL_opengles2.h \ 640 ../include/SDL_opengles.h \ 641 ../include/SDL_opengl.h \ 642 ../include/SDL_egl.h \ 643 644 645 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 646 # directories that are symbolic links (a Unix filesystem feature) are excluded 647 # from the input. 648 649 EXCLUDE_SYMLINKS = NO 650 651 # If the value of the INPUT tag contains directories, you can use the 652 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 653 # certain files from those directories. Note that the wildcards are matched 654 # against the file with absolute path, so to exclude all test directories 655 # for example use the pattern */test/* 656 657 EXCLUDE_PATTERNS = 658 659 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 660 # (namespaces, classes, functions, etc.) that should be excluded from the 661 # output. The symbol name can be a fully qualified name, a word, or if the 662 # wildcard * is used, a substring. Examples: ANamespace, AClass, 663 # AClass::ANamespace, ANamespace::*Test 664 665 EXCLUDE_SYMBOLS = 666 667 # The EXAMPLE_PATH tag can be used to specify one or more files or 668 # directories that contain example code fragments that are included (see 669 # the \include command). 670 671 EXAMPLE_PATH = 672 673 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 674 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 675 # and *.h) to filter out the source-files in the directories. If left 676 # blank all files are included. 677 678 EXAMPLE_PATTERNS = * 679 680 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 681 # searched for input files to be used with the \include or \dontinclude 682 # commands irrespective of the value of the RECURSIVE tag. 683 # Possible values are YES and NO. If left blank NO is used. 684 685 EXAMPLE_RECURSIVE = YES 686 687 # The IMAGE_PATH tag can be used to specify one or more files or 688 # directories that contain image that are included in the documentation (see 689 # the \image command). 690 691 IMAGE_PATH = 692 693 # The INPUT_FILTER tag can be used to specify a program that doxygen should 694 # invoke to filter for each input file. Doxygen will invoke the filter program 695 # by executing (via popen()) the command <filter> <input-file>, where <filter> 696 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 697 # input file. Doxygen will then use the output that the filter program writes 698 # to standard output. If FILTER_PATTERNS is specified, this tag will be 699 # ignored. 700 701 INPUT_FILTER = 702 703 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 704 # basis. Doxygen will compare the file name with each pattern and apply the 705 # filter if there is a match. The filters are a list of the form: 706 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 707 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 708 # is applied to all files. 709 710 FILTER_PATTERNS = 711 712 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 713 # INPUT_FILTER) will be used to filter the input files when producing source 714 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 715 716 FILTER_SOURCE_FILES = NO 717 718 #--------------------------------------------------------------------------- 719 # configuration options related to source browsing 720 #--------------------------------------------------------------------------- 721 722 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 723 # be generated. Documented entities will be cross-referenced with these sources. 724 # Note: To get rid of all source code in the generated output, make sure also 725 # VERBATIM_HEADERS is set to NO. 726 727 SOURCE_BROWSER = YES 728 729 # Setting the INLINE_SOURCES tag to YES will include the body 730 # of functions and classes directly in the documentation. 731 732 INLINE_SOURCES = YES 733 734 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 735 # doxygen to hide any special comment blocks from generated source code 736 # fragments. Normal C and C++ comments will always remain visible. 737 738 STRIP_CODE_COMMENTS = NO 739 740 # If the REFERENCED_BY_RELATION tag is set to YES 741 # then for each documented function all documented 742 # functions referencing it will be listed. 743 744 REFERENCED_BY_RELATION = YES 745 746 # If the REFERENCES_RELATION tag is set to YES 747 # then for each documented function all documented entities 748 # called/used by that function will be listed. 749 750 REFERENCES_RELATION = YES 751 752 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 753 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 754 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 755 # link to the source code. Otherwise they will link to the documentation. 756 757 REFERENCES_LINK_SOURCE = YES 758 759 # If the USE_HTAGS tag is set to YES then the references to source code 760 # will point to the HTML generated by the htags(1) tool instead of doxygen 761 # built-in source browser. The htags tool is part of GNU's global source 762 # tagging system (see http://www.gnu.org/software/global/global.html). You 763 # will need version 4.8.6 or higher. 764 765 USE_HTAGS = NO 766 767 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 768 # will generate a verbatim copy of the header file for each class for 769 # which an include is specified. Set to NO to disable this. 770 771 VERBATIM_HEADERS = YES 772 773 #--------------------------------------------------------------------------- 774 # configuration options related to the alphabetical class index 775 #--------------------------------------------------------------------------- 776 777 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 778 # of all compounds will be generated. Enable this if the project 779 # contains a lot of classes, structs, unions or interfaces. 780 781 ALPHABETICAL_INDEX = YES 782 783 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 784 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 785 # in which this list will be split (can be a number in the range [1..20]) 786 787 COLS_IN_ALPHA_INDEX = 5 788 789 # In case all classes in a project start with a common prefix, all 790 # classes will be put under the same header in the alphabetical index. 791 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 792 # should be ignored while generating the index headers. 793 794 IGNORE_PREFIX = SDL_ \ 795 SDL 796 797 #--------------------------------------------------------------------------- 798 # configuration options related to the HTML output 799 #--------------------------------------------------------------------------- 800 801 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 802 # generate HTML output. 803 804 GENERATE_HTML = YES 805 806 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 807 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 808 # put in front of it. If left blank `html' will be used as the default path. 809 810 HTML_OUTPUT = html 811 812 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 813 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 814 # doxygen will generate files with .html extension. 815 816 HTML_FILE_EXTENSION = .html 817 818 # The HTML_HEADER tag can be used to specify a personal HTML header for 819 # each generated HTML page. If it is left blank doxygen will generate a 820 # standard header. 821 822 HTML_HEADER = 823 824 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 825 # each generated HTML page. If it is left blank doxygen will generate a 826 # standard footer. 827 828 HTML_FOOTER = 829 830 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 831 # style sheet that is used by each HTML page. It can be used to 832 # fine-tune the look of the HTML output. If the tag is left blank doxygen 833 # will generate a default style sheet. Note that doxygen will try to copy 834 # the style sheet file to the HTML output directory, so don't put your own 835 # stylesheet in the HTML output directory as well, or it will be erased! 836 837 HTML_STYLESHEET = 838 839 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 840 # files or namespaces will be aligned in HTML using tables. If set to 841 # NO a bullet list will be used. 842 843 HTML_ALIGN_MEMBERS = YES 844 845 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 846 # documentation will contain sections that can be hidden and shown after the 847 # page has loaded. For this to work a browser that supports 848 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 849 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 850 851 HTML_DYNAMIC_SECTIONS = YES 852 853 # If the GENERATE_DOCSET tag is set to YES, additional index files 854 # will be generated that can be used as input for Apple's Xcode 3 855 # integrated development environment, introduced with OSX 10.5 (Leopard). 856 # To create a documentation set, doxygen will generate a Makefile in the 857 # HTML output directory. Running make will produce the docset in that 858 # directory and running "make install" will install the docset in 859 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 860 # it at startup. 861 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 862 863 GENERATE_DOCSET = NO 864 865 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 866 # feed. A documentation feed provides an umbrella under which multiple 867 # documentation sets from a single provider (such as a company or product suite) 868 # can be grouped. 869 870 DOCSET_FEEDNAME = "SDL 2.0 Doxygen" 871 872 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 873 # should uniquely identify the documentation set bundle. This should be a 874 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 875 # will append .docset to the name. 876 877 DOCSET_BUNDLE_ID = org.libsdl.sdl20 878 879 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 880 # will be generated that can be used as input for tools like the 881 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 882 # of the generated HTML documentation. 883 884 GENERATE_HTMLHELP = NO 885 886 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 887 # be used to specify the file name of the resulting .chm file. You 888 # can add a path in front of the file if the result should not be 889 # written to the html output directory. 890 891 CHM_FILE = ./sdl20.chm 892 893 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 894 # be used to specify the location (absolute path including file name) of 895 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 896 # the HTML help compiler on the generated index.hhp. 897 898 HHC_LOCATION = 899 900 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 901 # controls if a separate .chi index file is generated (YES) or that 902 # it should be included in the master .chm file (NO). 903 904 GENERATE_CHI = NO 905 906 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 907 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 908 # content. 909 910 CHM_INDEX_ENCODING = 911 912 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 913 # controls whether a binary table of contents is generated (YES) or a 914 # normal table of contents (NO) in the .chm file. 915 916 BINARY_TOC = NO 917 918 # The TOC_EXPAND flag can be set to YES to add extra items for group members 919 # to the contents of the HTML help documentation and to the tree view. 920 921 TOC_EXPAND = YES 922 923 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 924 # are set, an additional index file will be generated that can be used as input for 925 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 926 # HTML documentation. 927 928 GENERATE_QHP = NO 929 930 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 931 # be used to specify the file name of the resulting .qch file. 932 # The path specified is relative to the HTML output folder. 933 934 QCH_FILE = 935 936 # The QHP_NAMESPACE tag specifies the namespace to use when generating 937 # Qt Help Project output. For more information please see 938 # http://doc.trolltech.com/qthelpproject.html#namespace 939 940 QHP_NAMESPACE = 941 942 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 943 # Qt Help Project output. For more information please see 944 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 945 946 QHP_VIRTUAL_FOLDER = doc 947 948 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 949 # For more information please see 950 # http://doc.trolltech.com/qthelpproject.html#custom-filters 951 952 QHP_CUST_FILTER_NAME = 953 954 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 955 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 956 957 QHP_CUST_FILTER_ATTRS = 958 959 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 960 # filter section matches. 961 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 962 963 QHP_SECT_FILTER_ATTRS = 964 965 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 966 # be used to specify the location of Qt's qhelpgenerator. 967 # If non-empty doxygen will try to run qhelpgenerator on the generated 968 # .qhp file. 969 970 QHG_LOCATION = 971 972 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 973 # top of each HTML page. The value NO (the default) enables the index and 974 # the value YES disables it. 975 976 DISABLE_INDEX = NO 977 978 # This tag can be used to set the number of enum values (range [1..20]) 979 # that doxygen will group on one line in the generated HTML documentation. 980 981 ENUM_VALUES_PER_LINE = 1 982 983 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 984 # structure should be generated to display hierarchical information. 985 # If the tag value is set to FRAME, a side panel will be generated 986 # containing a tree-like index structure (just like the one that 987 # is generated for HTML Help). For this to work a browser that supports 988 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 989 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 990 # probably better off using the HTML help feature. Other possible values 991 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 992 # and Class Hierarchy pages using a tree view instead of an ordered list; 993 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 994 # disables this behavior completely. For backwards compatibility with previous 995 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 996 # respectively. 997 998 GENERATE_TREEVIEW = ALL 999 1000 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1001 # used to set the initial width (in pixels) of the frame in which the tree 1002 # is shown. 1003 1004 TREEVIEW_WIDTH = 250 1005 1006 # Use this tag to change the font size of Latex formulas included 1007 # as images in the HTML documentation. The default is 10. Note that 1008 # when you change the font size after a successful doxygen run you need 1009 # to manually remove any form_*.png images from the HTML output directory 1010 # to force them to be regenerated. 1011 1012 FORMULA_FONTSIZE = 10 1013 1014 #--------------------------------------------------------------------------- 1015 # configuration options related to the LaTeX output 1016 #--------------------------------------------------------------------------- 1017 1018 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1019 # generate Latex output. 1020 1021 GENERATE_LATEX = NO 1022 1023 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1025 # put in front of it. If left blank `latex' will be used as the default path. 1026 1027 LATEX_OUTPUT = latex 1028 1029 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1030 # invoked. If left blank `latex' will be used as the default command name. 1031 1032 LATEX_CMD_NAME = latex 1033 1034 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1035 # generate index for LaTeX. If left blank `makeindex' will be used as the 1036 # default command name. 1037 1038 MAKEINDEX_CMD_NAME = makeindex 1039 1040 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1041 # LaTeX documents. This may be useful for small projects and may help to 1042 # save some trees in general. 1043 1044 COMPACT_LATEX = NO 1045 1046 # The PAPER_TYPE tag can be used to set the paper type that is used 1047 # by the printer. Possible values are: a4, a4wide, letter, legal and 1048 # executive. If left blank a4wide will be used. 1049 1050 PAPER_TYPE = a4wide 1051 1052 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1053 # packages that should be included in the LaTeX output. 1054 1055 EXTRA_PACKAGES = 1056 1057 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1058 # the generated latex document. The header should contain everything until 1059 # the first chapter. If it is left blank doxygen will generate a 1060 # standard header. Notice: only use this tag if you know what you are doing! 1061 1062 LATEX_HEADER = 1063 1064 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1065 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1066 # contain links (just like the HTML output) instead of page references 1067 # This makes the output suitable for online browsing using a pdf viewer. 1068 1069 PDF_HYPERLINKS = YES 1070 1071 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1072 # plain latex in the generated Makefile. Set this option to YES to get a 1073 # higher quality PDF documentation. 1074 1075 USE_PDFLATEX = YES 1076 1077 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1078 # command to the generated LaTeX files. This will instruct LaTeX to keep 1079 # running if errors occur, instead of asking the user for help. 1080 # This option is also used when generating formulas in HTML. 1081 1082 LATEX_BATCHMODE = NO 1083 1084 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1085 # include the index chapters (such as File Index, Compound Index, etc.) 1086 # in the output. 1087 1088 LATEX_HIDE_INDICES = NO 1089 1090 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1091 # source code with syntax highlighting in the LaTeX output. 1092 # Note that which sources are shown also depends on other settings 1093 # such as SOURCE_BROWSER. 1094 1095 LATEX_SOURCE_CODE = NO 1096 1097 #--------------------------------------------------------------------------- 1098 # configuration options related to the RTF output 1099 #--------------------------------------------------------------------------- 1100 1101 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1102 # The RTF output is optimized for Word 97 and may not look very pretty with 1103 # other RTF readers or editors. 1104 1105 GENERATE_RTF = NO 1106 1107 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1108 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1109 # put in front of it. If left blank `rtf' will be used as the default path. 1110 1111 RTF_OUTPUT = rtf 1112 1113 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1114 # RTF documents. This may be useful for small projects and may help to 1115 # save some trees in general. 1116 1117 COMPACT_RTF = NO 1118 1119 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1120 # will contain hyperlink fields. The RTF file will 1121 # contain links (just like the HTML output) instead of page references. 1122 # This makes the output suitable for online browsing using WORD or other 1123 # programs which support those fields. 1124 # Note: wordpad (write) and others do not support links. 1125 1126 RTF_HYPERLINKS = NO 1127 1128 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1129 # config file, i.e. a series of assignments. You only have to provide 1130 # replacements, missing definitions are set to their default value. 1131 1132 RTF_STYLESHEET_FILE = 1133 1134 # Set optional variables used in the generation of an rtf document. 1135 # Syntax is similar to doxygen's config file. 1136 1137 RTF_EXTENSIONS_FILE = 1138 1139 #--------------------------------------------------------------------------- 1140 # configuration options related to the man page output 1141 #--------------------------------------------------------------------------- 1142 1143 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1144 # generate man pages 1145 1146 GENERATE_MAN = NO 1147 1148 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1149 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1150 # put in front of it. If left blank `man' will be used as the default path. 1151 1152 MAN_OUTPUT = man 1153 1154 # The MAN_EXTENSION tag determines the extension that is added to 1155 # the generated man pages (default is the subroutine's section .3) 1156 1157 MAN_EXTENSION = .3 1158 1159 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1160 # then it will generate one additional man file for each entity 1161 # documented in the real man page(s). These additional files 1162 # only source the real man page, but without them the man command 1163 # would be unable to find the correct page. The default is NO. 1164 1165 MAN_LINKS = NO 1166 1167 #--------------------------------------------------------------------------- 1168 # configuration options related to the XML output 1169 #--------------------------------------------------------------------------- 1170 1171 # If the GENERATE_XML tag is set to YES Doxygen will 1172 # generate an XML file that captures the structure of 1173 # the code including all documentation. 1174 1175 GENERATE_XML = NO 1176 1177 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1178 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1179 # put in front of it. If left blank `xml' will be used as the default path. 1180 1181 XML_OUTPUT = xml 1182 1183 # The XML_SCHEMA tag can be used to specify an XML schema, 1184 # which can be used by a validating XML parser to check the 1185 # syntax of the XML files. 1186 1187 XML_SCHEMA = 1188 1189 # The XML_DTD tag can be used to specify an XML DTD, 1190 # which can be used by a validating XML parser to check the 1191 # syntax of the XML files. 1192 1193 XML_DTD = 1194 1195 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1196 # dump the program listings (including syntax highlighting 1197 # and cross-referencing information) to the XML output. Note that 1198 # enabling this will significantly increase the size of the XML output. 1199 1200 XML_PROGRAMLISTING = YES 1201 1202 #--------------------------------------------------------------------------- 1203 # configuration options for the AutoGen Definitions output 1204 #--------------------------------------------------------------------------- 1205 1206 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1207 # generate an AutoGen Definitions (see autogen.sf.net) file 1208 # that captures the structure of the code including all 1209 # documentation. Note that this feature is still experimental 1210 # and incomplete at the moment. 1211 1212 GENERATE_AUTOGEN_DEF = NO 1213 1214 #--------------------------------------------------------------------------- 1215 # configuration options related to the Perl module output 1216 #--------------------------------------------------------------------------- 1217 1218 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1219 # generate a Perl module file that captures the structure of 1220 # the code including all documentation. Note that this 1221 # feature is still experimental and incomplete at the 1222 # moment. 1223 1224 GENERATE_PERLMOD = NO 1225 1226 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1227 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1228 # to generate PDF and DVI output from the Perl module output. 1229 1230 PERLMOD_LATEX = NO 1231 1232 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1233 # nicely formatted so it can be parsed by a human reader. This is useful 1234 # if you want to understand what is going on. On the other hand, if this 1235 # tag is set to NO the size of the Perl module output will be much smaller 1236 # and Perl will parse it just the same. 1237 1238 PERLMOD_PRETTY = YES 1239 1240 # The names of the make variables in the generated doxyrules.make file 1241 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1242 # This is useful so different doxyrules.make files included by the same 1243 # Makefile don't overwrite each other's variables. 1244 1245 PERLMOD_MAKEVAR_PREFIX = 1246 1247 #--------------------------------------------------------------------------- 1248 # Configuration options related to the preprocessor 1249 #--------------------------------------------------------------------------- 1250 1251 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1252 # evaluate all C-preprocessor directives found in the sources and include 1253 # files. 1254 1255 ENABLE_PREPROCESSING = YES 1256 1257 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1258 # names in the source code. If set to NO (the default) only conditional 1259 # compilation will be performed. Macro expansion can be done in a controlled 1260 # way by setting EXPAND_ONLY_PREDEF to YES. 1261 1262 MACRO_EXPANSION = YES 1263 1264 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1265 # then the macro expansion is limited to the macros specified with the 1266 # PREDEFINED and EXPAND_AS_DEFINED tags. 1267 1268 EXPAND_ONLY_PREDEF = YES 1269 1270 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1271 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1272 1273 SEARCH_INCLUDES = YES 1274 1275 # The INCLUDE_PATH tag can be used to specify one or more directories that 1276 # contain include files that are not input files but should be processed by 1277 # the preprocessor. 1278 1279 INCLUDE_PATH = 1280 1281 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1282 # patterns (like *.h and *.hpp) to filter out the header-files in the 1283 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1284 # be used. 1285 1286 INCLUDE_FILE_PATTERNS = 1287 1288 # The PREDEFINED tag can be used to specify one or more macro names that 1289 # are defined before the preprocessor is started (similar to the -D option of 1290 # gcc). The argument of the tag is a list of macros of the form: name 1291 # or name=definition (no spaces). If the definition and the = are 1292 # omitted =1 is assumed. To prevent a macro definition from being 1293 # undefined via #undef or recursively expanded use the := operator 1294 # instead of the = operator. 1295 1296 PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 \ 1297 DECLSPEC= \ 1298 SDLCALL= \ 1299 _WIN32=1 1300 1301 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1302 # this tag can be used to specify a list of macro names that should be expanded. 1303 # The macro definition that is found in the sources will be used. 1304 # Use the PREDEFINED tag if you want to use a different macro definition. 1305 1306 EXPAND_AS_DEFINED = 1307 1308 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1309 # doxygen's preprocessor will remove all function-like macros that are alone 1310 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1311 # function macros are typically used for boiler-plate code, and will confuse 1312 # the parser if not removed. 1313 1314 SKIP_FUNCTION_MACROS = YES 1315 1316 #--------------------------------------------------------------------------- 1317 # Configuration::additions related to external references 1318 #--------------------------------------------------------------------------- 1319 1320 # The TAGFILES option can be used to specify one or more tagfiles. 1321 # Optionally an initial location of the external documentation 1322 # can be added for each tagfile. The format of a tag file without 1323 # this location is as follows: 1324 # TAGFILES = file1 file2 ... 1325 # Adding location for the tag files is done as follows: 1326 # TAGFILES = file1=loc1 "file2 = loc2" ... 1327 # where "loc1" and "loc2" can be relative or absolute paths or 1328 # URLs. If a location is present for each tag, the installdox tool 1329 # does not have to be run to correct the links. 1330 # Note that each tag file must have a unique name 1331 # (where the name does NOT include the path) 1332 # If a tag file is not located in the directory in which doxygen 1333 # is run, you must also specify the path to the tagfile here. 1334 1335 TAGFILES = 1336 1337 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1338 # a tag file that is based on the input files it reads. 1339 1340 GENERATE_TAGFILE = ./SDL.tag 1341 1342 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1343 # in the class index. If set to NO only the inherited external classes 1344 # will be listed. 1345 1346 ALLEXTERNALS = NO 1347 1348 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1349 # in the modules index. If set to NO, only the current project's groups will 1350 # be listed. 1351 1352 EXTERNAL_GROUPS = YES 1353 1354 # The PERL_PATH should be the absolute path and name of the perl script 1355 # interpreter (i.e. the result of `which perl'). 1356 1357 PERL_PATH = c:\Perl\bin\perl.exe 1358 1359 #--------------------------------------------------------------------------- 1360 # Configuration options related to the dot tool 1361 #--------------------------------------------------------------------------- 1362 1363 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1364 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1365 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1366 # this option is superseded by the HAVE_DOT option below. This is only a 1367 # fallback. It is recommended to install and use dot, since it yields more 1368 # powerful graphs. 1369 1370 CLASS_DIAGRAMS = YES 1371 1372 # You can define message sequence charts within doxygen comments using the \msc 1373 # command. Doxygen will then run the mscgen tool (see 1374 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1375 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1376 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1377 # default search path. 1378 1379 MSCGEN_PATH = 1380 1381 # If set to YES, the inheritance and collaboration graphs will hide 1382 # inheritance and usage relations if the target is undocumented 1383 # or is not a class. 1384 1385 HIDE_UNDOC_RELATIONS = YES 1386 1387 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1388 # available from the path. This tool is part of Graphviz, a graph visualization 1389 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1390 # have no effect if this option is set to NO (the default) 1391 1392 HAVE_DOT = YES 1393 1394 # By default doxygen will write a font called FreeSans.ttf to the output 1395 # directory and reference it in all dot files that doxygen generates. This 1396 # font does not include all possible unicode characters however, so when you need 1397 # these (or just want a differently looking font) you can specify the font name 1398 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1399 # which can be done by putting it in a standard location or by setting the 1400 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1401 # containing the font. 1402 1403 DOT_FONTNAME = FreeSans 1404 1405 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1406 # The default size is 10pt. 1407 1408 DOT_FONTSIZE = 10 1409 1410 # By default doxygen will tell dot to use the output directory to look for the 1411 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1412 # different font using DOT_FONTNAME you can set the path where dot 1413 # can find it using this tag. 1414 1415 DOT_FONTPATH = 1416 1417 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1418 # will generate a graph for each documented class showing the direct and 1419 # indirect inheritance relations. Setting this tag to YES will force the 1420 # the CLASS_DIAGRAMS tag to NO. 1421 1422 CLASS_GRAPH = YES 1423 1424 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1425 # will generate a graph for each documented class showing the direct and 1426 # indirect implementation dependencies (inheritance, containment, and 1427 # class references variables) of the class with other documented classes. 1428 1429 COLLABORATION_GRAPH = YES 1430 1431 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1432 # will generate a graph for groups, showing the direct groups dependencies 1433 1434 GROUP_GRAPHS = YES 1435 1436 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1437 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1438 # Language. 1439 1440 UML_LOOK = NO 1441 1442 # If set to YES, the inheritance and collaboration graphs will show the 1443 # relations between templates and their instances. 1444 1445 TEMPLATE_RELATIONS = YES 1446 1447 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1448 # tags are set to YES then doxygen will generate a graph for each documented 1449 # file showing the direct and indirect include dependencies of the file with 1450 # other documented files. 1451 1452 INCLUDE_GRAPH = YES 1453 1454 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1455 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1456 # documented header file showing the documented files that directly or 1457 # indirectly include this file. 1458 1459 INCLUDED_BY_GRAPH = YES 1460 1461 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1462 # doxygen will generate a call dependency graph for every global function 1463 # or class method. Note that enabling this option will significantly increase 1464 # the time of a run. So in most cases it will be better to enable call graphs 1465 # for selected functions only using the \callgraph command. 1466 1467 CALL_GRAPH = NO 1468 1469 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1470 # doxygen will generate a caller dependency graph for every global function 1471 # or class method. Note that enabling this option will significantly increase 1472 # the time of a run. So in most cases it will be better to enable caller 1473 # graphs for selected functions only using the \callergraph command. 1474 1475 CALLER_GRAPH = NO 1476 1477 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1478 # will graphical hierarchy of all classes instead of a textual one. 1479 1480 GRAPHICAL_HIERARCHY = YES 1481 1482 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1483 # then doxygen will show the dependencies a directory has on other directories 1484 # in a graphical way. The dependency relations are determined by the #include 1485 # relations between the files in the directories. 1486 1487 DIRECTORY_GRAPH = YES 1488 1489 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1490 # generated by dot. Possible values are png, jpg, or gif 1491 # If left blank png will be used. 1492 1493 DOT_IMAGE_FORMAT = png 1494 1495 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1496 # found. If left blank, it is assumed the dot tool can be found in the path. 1497 1498 DOT_PATH = 1499 1500 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1501 # contain dot files that are included in the documentation (see the 1502 # \dotfile command). 1503 1504 DOTFILE_DIRS = 1505 1506 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1507 # nodes that will be shown in the graph. If the number of nodes in a graph 1508 # becomes larger than this value, doxygen will truncate the graph, which is 1509 # visualized by representing a node as a red box. Note that doxygen if the 1510 # number of direct children of the root node in a graph is already larger than 1511 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1512 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1513 1514 DOT_GRAPH_MAX_NODES = 60 1515 1516 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1517 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1518 # from the root by following a path via at most 3 edges will be shown. Nodes 1519 # that lay further from the root node will be omitted. Note that setting this 1520 # option to 1 or 2 may greatly reduce the computation time needed for large 1521 # code bases. Also note that the size of a graph can be further restricted by 1522 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1523 1524 MAX_DOT_GRAPH_DEPTH = 2 1525 1526 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1527 # background. This is disabled by default, because dot on Windows does not 1528 # seem to support this out of the box. Warning: Depending on the platform used, 1529 # enabling this option may lead to badly anti-aliased labels on the edges of 1530 # a graph (i.e. they become hard to read). 1531 1532 DOT_TRANSPARENT = NO 1533 1534 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1535 # files in one run (i.e. multiple -o and -T options on the command line). This 1536 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1537 # support this, this feature is disabled by default. 1538 1539 DOT_MULTI_TARGETS = YES 1540 1541 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1542 # generate a legend page explaining the meaning of the various boxes and 1543 # arrows in the dot generated graphs. 1544 1545 GENERATE_LEGEND = YES 1546 1547 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1548 # remove the intermediate dot files that are used to generate 1549 # the various graphs. 1550 1551 DOT_CLEANUP = YES 1552 1553 #--------------------------------------------------------------------------- 1554 # Options related to the search engine 1555 #--------------------------------------------------------------------------- 1556 1557 # The SEARCHENGINE tag specifies whether or not a search engine should be 1558 # used. If set to NO the values of all tags below this one will be ignored. 1559 1560 SEARCHENGINE = NO