cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

doxyfile (65746B)


      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
     23DOXYFILE_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
     28PROJECT_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
     34PROJECT_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
     41OUTPUT_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
     50CREATE_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
     63OUTPUT_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
     70BRIEF_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
     77REPEAT_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
     89ABBREVIATE_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
    105ALWAYS_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
    112INLINE_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
    118FULL_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
    127STRIP_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
    136STRIP_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
    142SHORT_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
    150JAVADOC_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
    158QT_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
    166MULTILINE_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
    172INHERIT_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
    178SEPARATE_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
    183TAB_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
    192ALIASES                = "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
    200OPTIMIZE_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
    207OPTIMIZE_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
    213OPTIMIZE_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
    219OPTIMIZE_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
    231EXTENSION_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
    240BUILTIN_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
    245CPP_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
    251SIP_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
    260IDL_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
    267DISTRIBUTE_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
    275SUBGROUPING            = 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
    285TYPEDEF_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
    301SYMBOL_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
    312EXTRACT_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
    317EXTRACT_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
    322EXTRACT_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
    328EXTRACT_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
    335EXTRACT_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
    343EXTRACT_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
    351HIDE_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
    358HIDE_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
    365HIDE_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
    372HIDE_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
    379INTERNAL_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
    387CASE_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
    393HIDE_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
    399SHOW_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
    404INLINE_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
    411SORT_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
    418SORT_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
    424SORT_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
    434SORT_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
    440GENERATE_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
    446GENERATE_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
    452GENERATE_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
    458GENERATE_DEPRECATEDLIST= YES
    459
    460# The ENABLED_SECTIONS tag can be used to enable conditional 
    461# documentation sections, marked by \if sectionname ... \endif.
    462
    463ENABLED_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
    473MAX_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
    479SHOW_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
    485SHOW_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
    491SHOW_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
    501FILE_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
    510LAYOUT_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
    519QUIET                  = 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
    525WARNINGS               = 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
    531WARN_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
    538WARN_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
    546WARN_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
    555WARN_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
    561WARN_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
    572INPUT                  = . ../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
    580INPUT_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
    589FILE_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
    628RECURSIVE              = 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
    634EXCLUDE                = ../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
    643
    644# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
    645# directories that are symbolic links (a Unix filesystem feature) are excluded 
    646# from the input.
    647
    648EXCLUDE_SYMLINKS       = NO
    649
    650# If the value of the INPUT tag contains directories, you can use the 
    651# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
    652# certain files from those directories. Note that the wildcards are matched 
    653# against the file with absolute path, so to exclude all test directories 
    654# for example use the pattern */test/*
    655
    656EXCLUDE_PATTERNS       =
    657
    658# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
    659# (namespaces, classes, functions, etc.) that should be excluded from the 
    660# output. The symbol name can be a fully qualified name, a word, or if the 
    661# wildcard * is used, a substring. Examples: ANamespace, AClass, 
    662# AClass::ANamespace, ANamespace::*Test
    663
    664EXCLUDE_SYMBOLS        = 
    665
    666# The EXAMPLE_PATH tag can be used to specify one or more files or 
    667# directories that contain example code fragments that are included (see 
    668# the \include command).
    669
    670EXAMPLE_PATH           =
    671
    672# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    673# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    674# and *.h) to filter out the source-files in the directories. If left 
    675# blank all files are included.
    676
    677EXAMPLE_PATTERNS       = *
    678
    679# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    680# searched for input files to be used with the \include or \dontinclude 
    681# commands irrespective of the value of the RECURSIVE tag. 
    682# Possible values are YES and NO. If left blank NO is used.
    683
    684EXAMPLE_RECURSIVE      = YES
    685
    686# The IMAGE_PATH tag can be used to specify one or more files or 
    687# directories that contain image that are included in the documentation (see 
    688# the \image command).
    689
    690IMAGE_PATH             = 
    691
    692# The INPUT_FILTER tag can be used to specify a program that doxygen should 
    693# invoke to filter for each input file. Doxygen will invoke the filter program 
    694# by executing (via popen()) the command <filter> <input-file>, where <filter> 
    695# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
    696# input file. Doxygen will then use the output that the filter program writes 
    697# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
    698# ignored.
    699
    700INPUT_FILTER           = 
    701
    702# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
    703# basis.  Doxygen will compare the file name with each pattern and apply the 
    704# filter if there is a match.  The filters are a list of the form: 
    705# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
    706# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
    707# is applied to all files.
    708
    709FILTER_PATTERNS        = 
    710
    711# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
    712# INPUT_FILTER) will be used to filter the input files when producing source 
    713# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    714
    715FILTER_SOURCE_FILES    = NO
    716
    717#---------------------------------------------------------------------------
    718# configuration options related to source browsing
    719#---------------------------------------------------------------------------
    720
    721# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
    722# be generated. Documented entities will be cross-referenced with these sources. 
    723# Note: To get rid of all source code in the generated output, make sure also 
    724# VERBATIM_HEADERS is set to NO.
    725
    726SOURCE_BROWSER         = YES
    727
    728# Setting the INLINE_SOURCES tag to YES will include the body 
    729# of functions and classes directly in the documentation.
    730
    731INLINE_SOURCES         = YES
    732
    733# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    734# doxygen to hide any special comment blocks from generated source code 
    735# fragments. Normal C and C++ comments will always remain visible.
    736
    737STRIP_CODE_COMMENTS    = NO
    738
    739# If the REFERENCED_BY_RELATION tag is set to YES 
    740# then for each documented function all documented 
    741# functions referencing it will be listed.
    742
    743REFERENCED_BY_RELATION = YES
    744
    745# If the REFERENCES_RELATION tag is set to YES 
    746# then for each documented function all documented entities 
    747# called/used by that function will be listed.
    748
    749REFERENCES_RELATION    = YES
    750
    751# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
    752# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
    753# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
    754# link to the source code.  Otherwise they will link to the documentation.
    755
    756REFERENCES_LINK_SOURCE = YES
    757
    758# If the USE_HTAGS tag is set to YES then the references to source code 
    759# will point to the HTML generated by the htags(1) tool instead of doxygen 
    760# built-in source browser. The htags tool is part of GNU's global source 
    761# tagging system (see http://www.gnu.org/software/global/global.html). You 
    762# will need version 4.8.6 or higher.
    763
    764USE_HTAGS              = NO
    765
    766# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    767# will generate a verbatim copy of the header file for each class for 
    768# which an include is specified. Set to NO to disable this.
    769
    770VERBATIM_HEADERS       = YES
    771
    772#---------------------------------------------------------------------------
    773# configuration options related to the alphabetical class index
    774#---------------------------------------------------------------------------
    775
    776# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    777# of all compounds will be generated. Enable this if the project 
    778# contains a lot of classes, structs, unions or interfaces.
    779
    780ALPHABETICAL_INDEX     = YES
    781
    782# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    783# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
    784# in which this list will be split (can be a number in the range [1..20])
    785
    786COLS_IN_ALPHA_INDEX    = 5
    787
    788# In case all classes in a project start with a common prefix, all 
    789# classes will be put under the same header in the alphabetical index. 
    790# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
    791# should be ignored while generating the index headers.
    792
    793IGNORE_PREFIX          = SDL_ \
    794                         SDL
    795
    796#---------------------------------------------------------------------------
    797# configuration options related to the HTML output
    798#---------------------------------------------------------------------------
    799
    800# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
    801# generate HTML output.
    802
    803GENERATE_HTML          = YES
    804
    805# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    806# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
    807# put in front of it. If left blank `html' will be used as the default path.
    808
    809HTML_OUTPUT            = html
    810
    811# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    812# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
    813# doxygen will generate files with .html extension.
    814
    815HTML_FILE_EXTENSION    = .html
    816
    817# The HTML_HEADER tag can be used to specify a personal HTML header for 
    818# each generated HTML page. If it is left blank doxygen will generate a 
    819# standard header.
    820
    821HTML_HEADER            = 
    822
    823# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    824# each generated HTML page. If it is left blank doxygen will generate a 
    825# standard footer.
    826
    827HTML_FOOTER            = 
    828
    829# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
    830# style sheet that is used by each HTML page. It can be used to 
    831# fine-tune the look of the HTML output. If the tag is left blank doxygen 
    832# will generate a default style sheet. Note that doxygen will try to copy 
    833# the style sheet file to the HTML output directory, so don't put your own 
    834# stylesheet in the HTML output directory as well, or it will be erased!
    835
    836HTML_STYLESHEET        = 
    837
    838# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    839# files or namespaces will be aligned in HTML using tables. If set to 
    840# NO a bullet list will be used.
    841
    842HTML_ALIGN_MEMBERS     = YES
    843
    844# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
    845# documentation will contain sections that can be hidden and shown after the 
    846# page has loaded. For this to work a browser that supports 
    847# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
    848# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
    849
    850HTML_DYNAMIC_SECTIONS  = YES
    851
    852# If the GENERATE_DOCSET tag is set to YES, additional index files 
    853# will be generated that can be used as input for Apple's Xcode 3 
    854# integrated development environment, introduced with OSX 10.5 (Leopard). 
    855# To create a documentation set, doxygen will generate a Makefile in the 
    856# HTML output directory. Running make will produce the docset in that 
    857# directory and running "make install" will install the docset in 
    858# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
    859# it at startup. 
    860# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
    861
    862GENERATE_DOCSET        = NO
    863
    864# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
    865# feed. A documentation feed provides an umbrella under which multiple 
    866# documentation sets from a single provider (such as a company or product suite) 
    867# can be grouped.
    868
    869DOCSET_FEEDNAME        = "SDL 2.0 Doxygen"
    870
    871# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
    872# should uniquely identify the documentation set bundle. This should be a 
    873# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
    874# will append .docset to the name.
    875
    876DOCSET_BUNDLE_ID       = org.libsdl.sdl20
    877
    878# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
    879# will be generated that can be used as input for tools like the 
    880# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
    881# of the generated HTML documentation.
    882
    883GENERATE_HTMLHELP      = NO
    884
    885# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
    886# be used to specify the file name of the resulting .chm file. You 
    887# can add a path in front of the file if the result should not be 
    888# written to the html output directory.
    889
    890CHM_FILE               = ./sdl20.chm
    891
    892# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    893# be used to specify the location (absolute path including file name) of 
    894# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
    895# the HTML help compiler on the generated index.hhp.
    896
    897HHC_LOCATION           = 
    898
    899# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    900# controls if a separate .chi index file is generated (YES) or that 
    901# it should be included in the master .chm file (NO).
    902
    903GENERATE_CHI           = NO
    904
    905# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
    906# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
    907# content.
    908
    909CHM_INDEX_ENCODING     = 
    910
    911# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
    912# controls whether a binary table of contents is generated (YES) or a 
    913# normal table of contents (NO) in the .chm file.
    914
    915BINARY_TOC             = NO
    916
    917# The TOC_EXPAND flag can be set to YES to add extra items for group members 
    918# to the contents of the HTML help documentation and to the tree view.
    919
    920TOC_EXPAND             = YES
    921
    922# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
    923# are set, an additional index file will be generated that can be used as input for 
    924# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
    925# HTML documentation.
    926
    927GENERATE_QHP           = NO
    928
    929# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
    930# be used to specify the file name of the resulting .qch file. 
    931# The path specified is relative to the HTML output folder.
    932
    933QCH_FILE               = 
    934
    935# The QHP_NAMESPACE tag specifies the namespace to use when generating 
    936# Qt Help Project output. For more information please see 
    937# http://doc.trolltech.com/qthelpproject.html#namespace
    938
    939QHP_NAMESPACE          = 
    940
    941# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
    942# Qt Help Project output. For more information please see 
    943# http://doc.trolltech.com/qthelpproject.html#virtual-folders
    944
    945QHP_VIRTUAL_FOLDER     = doc
    946
    947# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
    948# For more information please see 
    949# http://doc.trolltech.com/qthelpproject.html#custom-filters
    950
    951QHP_CUST_FILTER_NAME   = 
    952
    953# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
    954# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
    955
    956QHP_CUST_FILTER_ATTRS  = 
    957
    958# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
    959# filter section matches. 
    960# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
    961
    962QHP_SECT_FILTER_ATTRS  = 
    963
    964# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
    965# be used to specify the location of Qt's qhelpgenerator. 
    966# If non-empty doxygen will try to run qhelpgenerator on the generated 
    967# .qhp file.
    968
    969QHG_LOCATION           = 
    970
    971# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
    972# top of each HTML page. The value NO (the default) enables the index and 
    973# the value YES disables it.
    974
    975DISABLE_INDEX          = NO
    976
    977# This tag can be used to set the number of enum values (range [1..20]) 
    978# that doxygen will group on one line in the generated HTML documentation.
    979
    980ENUM_VALUES_PER_LINE   = 1
    981
    982# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
    983# structure should be generated to display hierarchical information. 
    984# If the tag value is set to FRAME, a side panel will be generated 
    985# containing a tree-like index structure (just like the one that 
    986# is generated for HTML Help). For this to work a browser that supports 
    987# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
    988# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
    989# probably better off using the HTML help feature. Other possible values 
    990# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
    991# and Class Hierarchy pages using a tree view instead of an ordered list; 
    992# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
    993# disables this behavior completely. For backwards compatibility with previous 
    994# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
    995# respectively.
    996
    997GENERATE_TREEVIEW      = ALL
    998
    999# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
   1000# used to set the initial width (in pixels) of the frame in which the tree 
   1001# is shown.
   1002
   1003TREEVIEW_WIDTH         = 250
   1004
   1005# Use this tag to change the font size of Latex formulas included 
   1006# as images in the HTML documentation. The default is 10. Note that 
   1007# when you change the font size after a successful doxygen run you need 
   1008# to manually remove any form_*.png images from the HTML output directory 
   1009# to force them to be regenerated.
   1010
   1011FORMULA_FONTSIZE       = 10
   1012
   1013#---------------------------------------------------------------------------
   1014# configuration options related to the LaTeX output
   1015#---------------------------------------------------------------------------
   1016
   1017# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
   1018# generate Latex output.
   1019
   1020GENERATE_LATEX         = NO
   1021
   1022# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
   1023# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1024# put in front of it. If left blank `latex' will be used as the default path.
   1025
   1026LATEX_OUTPUT           = latex
   1027
   1028# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
   1029# invoked. If left blank `latex' will be used as the default command name.
   1030
   1031LATEX_CMD_NAME         = latex
   1032
   1033# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
   1034# generate index for LaTeX. If left blank `makeindex' will be used as the 
   1035# default command name.
   1036
   1037MAKEINDEX_CMD_NAME     = makeindex
   1038
   1039# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
   1040# LaTeX documents. This may be useful for small projects and may help to 
   1041# save some trees in general.
   1042
   1043COMPACT_LATEX          = NO
   1044
   1045# The PAPER_TYPE tag can be used to set the paper type that is used 
   1046# by the printer. Possible values are: a4, a4wide, letter, legal and 
   1047# executive. If left blank a4wide will be used.
   1048
   1049PAPER_TYPE             = a4wide
   1050
   1051# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
   1052# packages that should be included in the LaTeX output.
   1053
   1054EXTRA_PACKAGES         = 
   1055
   1056# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
   1057# the generated latex document. The header should contain everything until 
   1058# the first chapter. If it is left blank doxygen will generate a 
   1059# standard header. Notice: only use this tag if you know what you are doing!
   1060
   1061LATEX_HEADER           = 
   1062
   1063# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
   1064# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
   1065# contain links (just like the HTML output) instead of page references 
   1066# This makes the output suitable for online browsing using a pdf viewer.
   1067
   1068PDF_HYPERLINKS         = YES
   1069
   1070# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
   1071# plain latex in the generated Makefile. Set this option to YES to get a 
   1072# higher quality PDF documentation.
   1073
   1074USE_PDFLATEX           = YES
   1075
   1076# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
   1077# command to the generated LaTeX files. This will instruct LaTeX to keep 
   1078# running if errors occur, instead of asking the user for help. 
   1079# This option is also used when generating formulas in HTML.
   1080
   1081LATEX_BATCHMODE        = NO
   1082
   1083# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
   1084# include the index chapters (such as File Index, Compound Index, etc.) 
   1085# in the output.
   1086
   1087LATEX_HIDE_INDICES     = NO
   1088
   1089# If LATEX_SOURCE_CODE is set to YES then doxygen will include
   1090# source code with syntax highlighting in the LaTeX output.
   1091# Note that which sources are shown also depends on other settings
   1092# such as SOURCE_BROWSER.
   1093
   1094LATEX_SOURCE_CODE      = NO
   1095
   1096#---------------------------------------------------------------------------
   1097# configuration options related to the RTF output
   1098#---------------------------------------------------------------------------
   1099
   1100# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
   1101# The RTF output is optimized for Word 97 and may not look very pretty with 
   1102# other RTF readers or editors.
   1103
   1104GENERATE_RTF           = NO
   1105
   1106# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
   1107# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1108# put in front of it. If left blank `rtf' will be used as the default path.
   1109
   1110RTF_OUTPUT             = rtf
   1111
   1112# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
   1113# RTF documents. This may be useful for small projects and may help to 
   1114# save some trees in general.
   1115
   1116COMPACT_RTF            = NO
   1117
   1118# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
   1119# will contain hyperlink fields. The RTF file will 
   1120# contain links (just like the HTML output) instead of page references. 
   1121# This makes the output suitable for online browsing using WORD or other 
   1122# programs which support those fields. 
   1123# Note: wordpad (write) and others do not support links.
   1124
   1125RTF_HYPERLINKS         = NO
   1126
   1127# Load stylesheet definitions from file. Syntax is similar to doxygen's 
   1128# config file, i.e. a series of assignments. You only have to provide 
   1129# replacements, missing definitions are set to their default value.
   1130
   1131RTF_STYLESHEET_FILE    = 
   1132
   1133# Set optional variables used in the generation of an rtf document. 
   1134# Syntax is similar to doxygen's config file.
   1135
   1136RTF_EXTENSIONS_FILE    = 
   1137
   1138#---------------------------------------------------------------------------
   1139# configuration options related to the man page output
   1140#---------------------------------------------------------------------------
   1141
   1142# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
   1143# generate man pages
   1144
   1145GENERATE_MAN           = NO
   1146
   1147# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
   1148# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1149# put in front of it. If left blank `man' will be used as the default path.
   1150
   1151MAN_OUTPUT             = man
   1152
   1153# The MAN_EXTENSION tag determines the extension that is added to 
   1154# the generated man pages (default is the subroutine's section .3)
   1155
   1156MAN_EXTENSION          = .3
   1157
   1158# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
   1159# then it will generate one additional man file for each entity 
   1160# documented in the real man page(s). These additional files 
   1161# only source the real man page, but without them the man command 
   1162# would be unable to find the correct page. The default is NO.
   1163
   1164MAN_LINKS              = NO
   1165
   1166#---------------------------------------------------------------------------
   1167# configuration options related to the XML output
   1168#---------------------------------------------------------------------------
   1169
   1170# If the GENERATE_XML tag is set to YES Doxygen will 
   1171# generate an XML file that captures the structure of 
   1172# the code including all documentation.
   1173
   1174GENERATE_XML           = NO
   1175
   1176# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
   1177# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1178# put in front of it. If left blank `xml' will be used as the default path.
   1179
   1180XML_OUTPUT             = xml
   1181
   1182# The XML_SCHEMA tag can be used to specify an XML schema, 
   1183# which can be used by a validating XML parser to check the 
   1184# syntax of the XML files.
   1185
   1186XML_SCHEMA             = 
   1187
   1188# The XML_DTD tag can be used to specify an XML DTD, 
   1189# which can be used by a validating XML parser to check the 
   1190# syntax of the XML files.
   1191
   1192XML_DTD                = 
   1193
   1194# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
   1195# dump the program listings (including syntax highlighting 
   1196# and cross-referencing information) to the XML output. Note that 
   1197# enabling this will significantly increase the size of the XML output.
   1198
   1199XML_PROGRAMLISTING     = YES
   1200
   1201#---------------------------------------------------------------------------
   1202# configuration options for the AutoGen Definitions output
   1203#---------------------------------------------------------------------------
   1204
   1205# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
   1206# generate an AutoGen Definitions (see autogen.sf.net) file 
   1207# that captures the structure of the code including all 
   1208# documentation. Note that this feature is still experimental 
   1209# and incomplete at the moment.
   1210
   1211GENERATE_AUTOGEN_DEF   = NO
   1212
   1213#---------------------------------------------------------------------------
   1214# configuration options related to the Perl module output
   1215#---------------------------------------------------------------------------
   1216
   1217# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
   1218# generate a Perl module file that captures the structure of 
   1219# the code including all documentation. Note that this 
   1220# feature is still experimental and incomplete at the 
   1221# moment.
   1222
   1223GENERATE_PERLMOD       = NO
   1224
   1225# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
   1226# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
   1227# to generate PDF and DVI output from the Perl module output.
   1228
   1229PERLMOD_LATEX          = NO
   1230
   1231# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
   1232# nicely formatted so it can be parsed by a human reader.  This is useful 
   1233# if you want to understand what is going on.  On the other hand, if this 
   1234# tag is set to NO the size of the Perl module output will be much smaller 
   1235# and Perl will parse it just the same.
   1236
   1237PERLMOD_PRETTY         = YES
   1238
   1239# The names of the make variables in the generated doxyrules.make file 
   1240# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
   1241# This is useful so different doxyrules.make files included by the same 
   1242# Makefile don't overwrite each other's variables.
   1243
   1244PERLMOD_MAKEVAR_PREFIX = 
   1245
   1246#---------------------------------------------------------------------------
   1247# Configuration options related to the preprocessor   
   1248#---------------------------------------------------------------------------
   1249
   1250# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
   1251# evaluate all C-preprocessor directives found in the sources and include 
   1252# files.
   1253
   1254ENABLE_PREPROCESSING   = YES
   1255
   1256# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
   1257# names in the source code. If set to NO (the default) only conditional 
   1258# compilation will be performed. Macro expansion can be done in a controlled 
   1259# way by setting EXPAND_ONLY_PREDEF to YES.
   1260
   1261MACRO_EXPANSION        = YES
   1262
   1263# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
   1264# then the macro expansion is limited to the macros specified with the 
   1265# PREDEFINED and EXPAND_AS_DEFINED tags.
   1266
   1267EXPAND_ONLY_PREDEF     = YES
   1268
   1269# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
   1270# in the INCLUDE_PATH (see below) will be search if a #include is found.
   1271
   1272SEARCH_INCLUDES        = YES
   1273
   1274# The INCLUDE_PATH tag can be used to specify one or more directories that 
   1275# contain include files that are not input files but should be processed by 
   1276# the preprocessor.
   1277
   1278INCLUDE_PATH           =
   1279
   1280# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
   1281# patterns (like *.h and *.hpp) to filter out the header-files in the 
   1282# directories. If left blank, the patterns specified with FILE_PATTERNS will 
   1283# be used.
   1284
   1285INCLUDE_FILE_PATTERNS  = 
   1286
   1287# The PREDEFINED tag can be used to specify one or more macro names that 
   1288# are defined before the preprocessor is started (similar to the -D option of 
   1289# gcc). The argument of the tag is a list of macros of the form: name 
   1290# or name=definition (no spaces). If the definition and the = are 
   1291# omitted =1 is assumed. To prevent a macro definition from being 
   1292# undefined via #undef or recursively expanded use the := operator 
   1293# instead of the = operator.
   1294
   1295PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
   1296                         DECLSPEC= \
   1297                         SDLCALL= \
   1298                         _WIN32=1
   1299
   1300# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
   1301# this tag can be used to specify a list of macro names that should be expanded. 
   1302# The macro definition that is found in the sources will be used. 
   1303# Use the PREDEFINED tag if you want to use a different macro definition.
   1304
   1305EXPAND_AS_DEFINED      = 
   1306
   1307# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
   1308# doxygen's preprocessor will remove all function-like macros that are alone 
   1309# on a line, have an all uppercase name, and do not end with a semicolon. Such 
   1310# function macros are typically used for boiler-plate code, and will confuse 
   1311# the parser if not removed.
   1312
   1313SKIP_FUNCTION_MACROS   = YES
   1314
   1315#---------------------------------------------------------------------------
   1316# Configuration::additions related to external references   
   1317#---------------------------------------------------------------------------
   1318
   1319# The TAGFILES option can be used to specify one or more tagfiles. 
   1320# Optionally an initial location of the external documentation 
   1321# can be added for each tagfile. The format of a tag file without 
   1322# this location is as follows: 
   1323#   TAGFILES = file1 file2 ... 
   1324# Adding location for the tag files is done as follows: 
   1325#   TAGFILES = file1=loc1 "file2 = loc2" ... 
   1326# where "loc1" and "loc2" can be relative or absolute paths or 
   1327# URLs. If a location is present for each tag, the installdox tool 
   1328# does not have to be run to correct the links. 
   1329# Note that each tag file must have a unique name 
   1330# (where the name does NOT include the path) 
   1331# If a tag file is not located in the directory in which doxygen 
   1332# is run, you must also specify the path to the tagfile here.
   1333
   1334TAGFILES               = 
   1335
   1336# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
   1337# a tag file that is based on the input files it reads.
   1338
   1339GENERATE_TAGFILE       = ./SDL.tag
   1340
   1341# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
   1342# in the class index. If set to NO only the inherited external classes 
   1343# will be listed.
   1344
   1345ALLEXTERNALS           = NO
   1346
   1347# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
   1348# in the modules index. If set to NO, only the current project's groups will 
   1349# be listed.
   1350
   1351EXTERNAL_GROUPS        = YES
   1352
   1353# The PERL_PATH should be the absolute path and name of the perl script 
   1354# interpreter (i.e. the result of `which perl').
   1355
   1356PERL_PATH              = c:\Perl\bin\perl.exe
   1357
   1358#---------------------------------------------------------------------------
   1359# Configuration options related to the dot tool   
   1360#---------------------------------------------------------------------------
   1361
   1362# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
   1363# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
   1364# or super classes. Setting the tag to NO turns the diagrams off. Note that 
   1365# this option is superseded by the HAVE_DOT option below. This is only a 
   1366# fallback. It is recommended to install and use dot, since it yields more 
   1367# powerful graphs.
   1368
   1369CLASS_DIAGRAMS         = YES
   1370
   1371# You can define message sequence charts within doxygen comments using the \msc 
   1372# command. Doxygen will then run the mscgen tool (see 
   1373# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
   1374# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
   1375# the mscgen tool resides. If left empty the tool is assumed to be found in the 
   1376# default search path.
   1377
   1378MSCGEN_PATH            = 
   1379
   1380# If set to YES, the inheritance and collaboration graphs will hide 
   1381# inheritance and usage relations if the target is undocumented 
   1382# or is not a class.
   1383
   1384HIDE_UNDOC_RELATIONS   = YES
   1385
   1386# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
   1387# available from the path. This tool is part of Graphviz, a graph visualization 
   1388# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
   1389# have no effect if this option is set to NO (the default)
   1390
   1391HAVE_DOT               = YES
   1392
   1393# By default doxygen will write a font called FreeSans.ttf to the output 
   1394# directory and reference it in all dot files that doxygen generates. This 
   1395# font does not include all possible unicode characters however, so when you need 
   1396# these (or just want a differently looking font) you can specify the font name 
   1397# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
   1398# which can be done by putting it in a standard location or by setting the 
   1399# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
   1400# containing the font.
   1401
   1402DOT_FONTNAME           = FreeSans
   1403
   1404# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
   1405# The default size is 10pt.
   1406
   1407DOT_FONTSIZE           = 10
   1408
   1409# By default doxygen will tell dot to use the output directory to look for the 
   1410# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
   1411# different font using DOT_FONTNAME you can set the path where dot 
   1412# can find it using this tag.
   1413
   1414DOT_FONTPATH           = 
   1415
   1416# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
   1417# will generate a graph for each documented class showing the direct and 
   1418# indirect inheritance relations. Setting this tag to YES will force the 
   1419# the CLASS_DIAGRAMS tag to NO.
   1420
   1421CLASS_GRAPH            = YES
   1422
   1423# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
   1424# will generate a graph for each documented class showing the direct and 
   1425# indirect implementation dependencies (inheritance, containment, and 
   1426# class references variables) of the class with other documented classes.
   1427
   1428COLLABORATION_GRAPH    = YES
   1429
   1430# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
   1431# will generate a graph for groups, showing the direct groups dependencies
   1432
   1433GROUP_GRAPHS           = YES
   1434
   1435# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
   1436# collaboration diagrams in a style similar to the OMG's Unified Modeling 
   1437# Language.
   1438
   1439UML_LOOK               = NO
   1440
   1441# If set to YES, the inheritance and collaboration graphs will show the 
   1442# relations between templates and their instances.
   1443
   1444TEMPLATE_RELATIONS     = YES
   1445
   1446# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
   1447# tags are set to YES then doxygen will generate a graph for each documented 
   1448# file showing the direct and indirect include dependencies of the file with 
   1449# other documented files.
   1450
   1451INCLUDE_GRAPH          = YES
   1452
   1453# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
   1454# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
   1455# documented header file showing the documented files that directly or 
   1456# indirectly include this file.
   1457
   1458INCLUDED_BY_GRAPH      = YES
   1459
   1460# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
   1461# doxygen will generate a call dependency graph for every global function 
   1462# or class method. Note that enabling this option will significantly increase 
   1463# the time of a run. So in most cases it will be better to enable call graphs 
   1464# for selected functions only using the \callgraph command.
   1465
   1466CALL_GRAPH             = NO
   1467
   1468# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
   1469# doxygen will generate a caller dependency graph for every global function 
   1470# or class method. Note that enabling this option will significantly increase 
   1471# the time of a run. So in most cases it will be better to enable caller 
   1472# graphs for selected functions only using the \callergraph command.
   1473
   1474CALLER_GRAPH           = NO
   1475
   1476# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
   1477# will graphical hierarchy of all classes instead of a textual one.
   1478
   1479GRAPHICAL_HIERARCHY    = YES
   1480
   1481# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
   1482# then doxygen will show the dependencies a directory has on other directories 
   1483# in a graphical way. The dependency relations are determined by the #include 
   1484# relations between the files in the directories.
   1485
   1486DIRECTORY_GRAPH        = YES
   1487
   1488# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
   1489# generated by dot. Possible values are png, jpg, or gif 
   1490# If left blank png will be used.
   1491
   1492DOT_IMAGE_FORMAT       = png
   1493
   1494# The tag DOT_PATH can be used to specify the path where the dot tool can be 
   1495# found. If left blank, it is assumed the dot tool can be found in the path.
   1496
   1497DOT_PATH               = 
   1498
   1499# The DOTFILE_DIRS tag can be used to specify one or more directories that 
   1500# contain dot files that are included in the documentation (see the 
   1501# \dotfile command).
   1502
   1503DOTFILE_DIRS           = 
   1504
   1505# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
   1506# nodes that will be shown in the graph. If the number of nodes in a graph 
   1507# becomes larger than this value, doxygen will truncate the graph, which is 
   1508# visualized by representing a node as a red box. Note that doxygen if the 
   1509# number of direct children of the root node in a graph is already larger than 
   1510# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
   1511# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
   1512
   1513DOT_GRAPH_MAX_NODES    = 60
   1514
   1515# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
   1516# graphs generated by dot. A depth value of 3 means that only nodes reachable 
   1517# from the root by following a path via at most 3 edges will be shown. Nodes 
   1518# that lay further from the root node will be omitted. Note that setting this 
   1519# option to 1 or 2 may greatly reduce the computation time needed for large 
   1520# code bases. Also note that the size of a graph can be further restricted by 
   1521# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
   1522
   1523MAX_DOT_GRAPH_DEPTH    = 2
   1524
   1525# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
   1526# background. This is disabled by default, because dot on Windows does not 
   1527# seem to support this out of the box. Warning: Depending on the platform used, 
   1528# enabling this option may lead to badly anti-aliased labels on the edges of 
   1529# a graph (i.e. they become hard to read).
   1530
   1531DOT_TRANSPARENT        = NO
   1532
   1533# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
   1534# files in one run (i.e. multiple -o and -T options on the command line). This 
   1535# makes dot run faster, but since only newer versions of dot (>1.8.10) 
   1536# support this, this feature is disabled by default.
   1537
   1538DOT_MULTI_TARGETS      = YES
   1539
   1540# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
   1541# generate a legend page explaining the meaning of the various boxes and 
   1542# arrows in the dot generated graphs.
   1543
   1544GENERATE_LEGEND        = YES
   1545
   1546# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
   1547# remove the intermediate dot files that are used to generate 
   1548# the various graphs.
   1549
   1550DOT_CLEANUP            = YES
   1551
   1552#---------------------------------------------------------------------------
   1553# Options related to the search engine
   1554#---------------------------------------------------------------------------
   1555
   1556# The SEARCHENGINE tag specifies whether or not a search engine should be 
   1557# used. If set to NO the values of all tags below this one will be ignored.
   1558
   1559SEARCHENGINE           = NO