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