Fixed bug #859
authorSam Lantinga
Fri, 21 Jan 2011 12:57:01 -0800
changeset 506761d53410eb41
parent 5066 3afb71c202b2
child 5068 231dbbc3e31c
Fixed bug #859

CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser.

ALWAYS_DETAILED_SEC makes sure everything has at least the automatic
documentation like function prototype and source references.

STRIP_FROM_PATH allows you to include only the relevant portions of the files'
paths, cleaning up both the file list and directory tree, though you need to
change the path listed here to match wherever you put SDL.

ALIASES avoids some warnings generated by
C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h.
It seems Apple uses a few commands which are not normally supported by Doxygen.

BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the
standard template library. There isn't a lot of C++ in SDL (some in bwindow at
least), but this still seems like a good idea.

TYPEDEF_HIDES_STRUCT means that for code like this:
typedef struct A {int B;} C;
C is documented as a structure containing B instead of a typedef mapped to A.

EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS,
EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is
documented.

CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on
case insensitive file systems like NTFS and FAT32.

WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of
the parameters of a function. This is useful when you're working on adding
such documentation since it makes partially documented functions easier to
spot.

WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with
stdout. When not running in quiet mode, these warnings can be hard to spot
without this flag.

I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for
config.h.in and config.h.default.

RECURSIVE tells doxygen to look not only in the input directory, but also in
subfolders.

EXCLUDE avoids documenting things like test programs, examples and templates
which need to be documented separately.

I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find
their way into source folders (such as obj or .svn).

EXAMPLE_PATH lists directories doxygen will search to find included example
code. So far, SDL doesn't really use this feature, but I've listed some likely
locations.

SOURCE_BROWSER adds syntax highlighted source code to the HTML output.
USE_HTAGS is nice, but not available on Windows.

INLINE_SOURCES adds the body of a function to it's documentation so you can
quickly see exactly what it does.

ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions,
etc., which makes it much easier to find what you're looking for.

IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an
item on so you don't have everything show up under "S".

HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and
adds JavaScript to allow the user to show and hide them by clicking a link.

ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on
it's own line.

GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the
left.

I have LaTeX and man pages turned off to speed up doxygen, you may want to turn
them back on yourself.

I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to
Win32 builds of SDL. Normally, doxygen gets confused since there are multiple
definitions for various structures and formats that vary by platform. Without
this doxygen can produce broken documentation or, if you're lucky, output
documentation only for the dummy drivers, which isn't very useful. You need to
pick a platform.

GENERATE_TAGFILE produces a file which can be used to link other doxygen
documentation to the SDL documentation.

CLASS_DIAGRAMS turns on class diagrams even when dot is not available.

HAVE_DOT tells doxygen to try to use dot to generate diagrams.

TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the
documentation.

DOT_MULTI_TARGETS speeds up dot.

OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is
intended to process src as well as include and is being run from a separate
subdirectory. Doxygen produces several temporary files while it's running and
if interrupted, can leave those files behind. It's easier to clean up if there
aren't a hundred or so files in the same folder. I typically run doxygen in
SDL/doxy and set the output directory to '.'. Since doxygen puts it's output
in subfolders by type, this keeps things pretty well organised. You could use
'../doc' instead and get the same results.
include/doxyfile
     1.1 --- a/include/doxyfile	Fri Jan 21 12:43:25 2011 -0800
     1.2 +++ b/include/doxyfile	Fri Jan 21 12:57:01 2011 -0800
     1.3 @@ -1,4 +1,4 @@
     1.4 -# Doxyfile 1.4.4
     1.5 +# Doxyfile 1.5.9
     1.6  
     1.7  # This file describes the settings to be used by the documentation system
     1.8  # doxygen (www.doxygen.org) for a project
     1.9 @@ -14,6 +14,14 @@
    1.10  # Project related configuration options
    1.11  #---------------------------------------------------------------------------
    1.12  
    1.13 +# This tag specifies the encoding used for all characters in the config file 
    1.14 +# that follow. The default is UTF-8 which is also the encoding used for all 
    1.15 +# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
    1.16 +# iconv built into libc) for the transcoding. See 
    1.17 +# http://www.gnu.org/software/libiconv for the list of possible encodings.
    1.18 +
    1.19 +DOXYFILE_ENCODING      = UTF-8
    1.20 +
    1.21  # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
    1.22  # by quotes) that should identify the project.
    1.23  
    1.24 @@ -30,7 +38,7 @@
    1.25  # If a relative path is entered, it will be relative to the location 
    1.26  # where doxygen was started. If left blank the current directory will be used.
    1.27  
    1.28 -OUTPUT_DIRECTORY       = docs
    1.29 +OUTPUT_DIRECTORY       = .
    1.30  
    1.31  # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    1.32  # 4096 sub-directories (in 2 levels) under the output directory of each output 
    1.33 @@ -39,30 +47,21 @@
    1.34  # source files, where putting all generated files in the same directory would 
    1.35  # otherwise cause performance problems for the file system.
    1.36  
    1.37 -CREATE_SUBDIRS         = NO
    1.38 +CREATE_SUBDIRS         = YES
    1.39  
    1.40  # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    1.41  # documentation generated by doxygen is written. Doxygen will use this 
    1.42  # information to generate all constant output in the proper language. 
    1.43  # The default language is English, other supported languages are: 
    1.44 -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
    1.45 -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
    1.46 -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
    1.47 -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
    1.48 -# Swedish, and Ukrainian.
    1.49 +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
    1.50 +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
    1.51 +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
    1.52 +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
    1.53 +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 
    1.54 +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    1.55  
    1.56  OUTPUT_LANGUAGE        = English
    1.57  
    1.58 -# This tag can be used to specify the encoding used in the generated output. 
    1.59 -# The encoding is not always determined by the language that is chosen, 
    1.60 -# but also whether or not the output is meant for Windows or non-Windows users. 
    1.61 -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
    1.62 -# forces the Windows encoding (this is the default for the Windows binary), 
    1.63 -# whereas setting the tag to NO uses a Unix-style encoding (the default for 
    1.64 -# all platforms other than Windows).
    1.65 -
    1.66 -USE_WINDOWS_ENCODING   = NO
    1.67 -
    1.68  # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    1.69  # include brief member descriptions after the members that are listed in 
    1.70  # the file and class documentation (similar to JavaDoc). 
    1.71 @@ -87,13 +86,23 @@
    1.72  # "The $name file" "is" "provides" "specifies" "contains" 
    1.73  # "represents" "a" "an" "the"
    1.74  
    1.75 -ABBREVIATE_BRIEF       = 
    1.76 +ABBREVIATE_BRIEF       = "The $name class" \
    1.77 +                         "The $name widget" \
    1.78 +                         "The $name file" \
    1.79 +                         is \
    1.80 +                         provides \
    1.81 +                         specifies \
    1.82 +                         contains \
    1.83 +                         represents \
    1.84 +                         a \
    1.85 +                         an \
    1.86 +                         the
    1.87  
    1.88  # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    1.89  # Doxygen will generate a detailed section even if there is only a brief 
    1.90  # description.
    1.91  
    1.92 -ALWAYS_DETAILED_SEC    = NO
    1.93 +ALWAYS_DETAILED_SEC    = YES
    1.94  
    1.95  # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    1.96  # inherited members of a class in the documentation of that class as if those 
    1.97 @@ -115,7 +124,10 @@
    1.98  # If left blank the directory from which doxygen is run is used as the 
    1.99  # path to strip.
   1.100  
   1.101 -STRIP_FROM_PATH        = 
   1.102 +STRIP_FROM_PATH        = ../ \
   1.103 +                         C:/source/svn.libsdl.org/trunk/ \
   1.104 +                         C:\source\svn.libsdl.org\trunk\ \
   1.105 +                         ..\
   1.106  
   1.107  # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
   1.108  # the path mentioned in the documentation of a class, which tells 
   1.109 @@ -135,11 +147,19 @@
   1.110  # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
   1.111  # will interpret the first line (until the first dot) of a JavaDoc-style 
   1.112  # comment as the brief description. If set to NO, the JavaDoc 
   1.113 -# comments will behave just like the Qt-style comments (thus requiring an 
   1.114 -# explicit @brief command for a brief description.
   1.115 +# comments will behave just like regular Qt-style comments 
   1.116 +# (thus requiring an explicit @brief command for a brief description.)
   1.117  
   1.118  JAVADOC_AUTOBRIEF      = NO
   1.119  
   1.120 +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
   1.121 +# interpret the first line (until the first dot) of a Qt-style 
   1.122 +# comment as the brief description. If set to NO, the comments 
   1.123 +# will behave just like regular Qt-style comments (thus requiring 
   1.124 +# an explicit \brief command for a brief description.)
   1.125 +
   1.126 +QT_AUTOBRIEF           = NO
   1.127 +
   1.128  # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
   1.129  # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
   1.130  # comments) as a brief description. This used to be the default behaviour. 
   1.131 @@ -148,26 +168,12 @@
   1.132  
   1.133  MULTILINE_CPP_IS_BRIEF = NO
   1.134  
   1.135 -# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
   1.136 -# will output the detailed description near the top, like JavaDoc.
   1.137 -# If set to NO, the detailed description appears after the member 
   1.138 -# documentation.
   1.139 -
   1.140 -DETAILS_AT_TOP         = NO
   1.141 -
   1.142  # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
   1.143  # member inherits the documentation from any documented member that it 
   1.144  # re-implements.
   1.145  
   1.146  INHERIT_DOCS           = YES
   1.147  
   1.148 -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
   1.149 -# tag is set to YES, then doxygen will reuse the documentation of the first 
   1.150 -# member in the group (if any) for the other members of the group. By default 
   1.151 -# all members of a group must be documented explicitly.
   1.152 -
   1.153 -DISTRIBUTE_GROUP_DOC   = NO
   1.154 -
   1.155  # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
   1.156  # a new page for each member. If set to NO, the documentation of a member will 
   1.157  # be part of the file/class/namespace that contains it.
   1.158 @@ -186,7 +192,8 @@
   1.159  # will result in a user-defined paragraph with heading "Side Effects:". 
   1.160  # You can put \n's in the value part of an alias to insert newlines.
   1.161  
   1.162 -ALIASES                = 
   1.163 +ALIASES                = "defined=\"\def\"" \
   1.164 +                         "discussion=\"\par Discussion:\n\""
   1.165  
   1.166  # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
   1.167  # sources only. Doxygen will then generate output that is more tailored for C. 
   1.168 @@ -195,13 +202,73 @@
   1.169  
   1.170  OPTIMIZE_OUTPUT_FOR_C  = YES
   1.171  
   1.172 -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
   1.173 -# only. Doxygen will then generate output that is more tailored for Java. 
   1.174 -# For instance, namespaces will be presented as packages, qualified scopes 
   1.175 -# will look different, etc.
   1.176 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
   1.177 +# sources only. Doxygen will then generate output that is more tailored for 
   1.178 +# Java. For instance, namespaces will be presented as packages, qualified 
   1.179 +# scopes will look different, etc.
   1.180  
   1.181  OPTIMIZE_OUTPUT_JAVA   = NO
   1.182  
   1.183 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
   1.184 +# sources only. Doxygen will then generate output that is more tailored for 
   1.185 +# Fortran.
   1.186 +
   1.187 +OPTIMIZE_FOR_FORTRAN   = NO
   1.188 +
   1.189 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
   1.190 +# sources. Doxygen will then generate output that is tailored for 
   1.191 +# VHDL.
   1.192 +
   1.193 +OPTIMIZE_OUTPUT_VHDL   = NO
   1.194 +
   1.195 +# Doxygen selects the parser to use depending on the extension of the files it parses. 
   1.196 +# With this tag you can assign which parser to use for a given extension. 
   1.197 +# Doxygen has a built-in mapping, but you can override or extend it using this tag. 
   1.198 +# The format is ext=language, where ext is a file extension, and language is one of 
   1.199 +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 
   1.200 +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 
   1.201 +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 
   1.202 +# use: inc=Fortran f=C. Note that for custom extensions you also need to set
   1.203 +# FILE_PATTERNS otherwise the files are not read by doxygen.
   1.204 +
   1.205 +EXTENSION_MAPPING      = 
   1.206 +
   1.207 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
   1.208 +# to include (a tag file for) the STL sources as input, then you should 
   1.209 +# set this tag to YES in order to let doxygen match functions declarations and 
   1.210 +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
   1.211 +# func(std::string) {}). This also make the inheritance and collaboration 
   1.212 +# diagrams that involve STL classes more complete and accurate.
   1.213 +
   1.214 +BUILTIN_STL_SUPPORT    = YES
   1.215 +
   1.216 +# If you use Microsoft's C++/CLI language, you should set this option to YES to 
   1.217 +# enable parsing support.
   1.218 +
   1.219 +CPP_CLI_SUPPORT        = NO
   1.220 +
   1.221 +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
   1.222 +# Doxygen will parse them like normal C++ but will assume all classes use public 
   1.223 +# instead of private inheritance when no explicit protection keyword is present.
   1.224 +
   1.225 +SIP_SUPPORT            = NO
   1.226 +
   1.227 +# For Microsoft's IDL there are propget and propput attributes to indicate getter 
   1.228 +# and setter methods for a property. Setting this option to YES (the default) 
   1.229 +# will make doxygen to replace the get and set methods by a property in the 
   1.230 +# documentation. This will only work if the methods are indeed getting or 
   1.231 +# setting a simple type. If this is not the case, or you want to show the 
   1.232 +# methods anyway, you should set this option to NO.
   1.233 +
   1.234 +IDL_PROPERTY_SUPPORT   = YES
   1.235 +
   1.236 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
   1.237 +# tag is set to YES, then doxygen will reuse the documentation of the first 
   1.238 +# member in the group (if any) for the other members of the group. By default 
   1.239 +# all members of a group must be documented explicitly.
   1.240 +
   1.241 +DISTRIBUTE_GROUP_DOC   = NO
   1.242 +
   1.243  # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
   1.244  # the same type (for instance a group of public functions) to be put as a 
   1.245  # subgroup of that type (e.g. under the Public Functions section). Set it to 
   1.246 @@ -210,6 +277,32 @@
   1.247  
   1.248  SUBGROUPING            = YES
   1.249  
   1.250 +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
   1.251 +# is documented as struct, union, or enum with the name of the typedef. So 
   1.252 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
   1.253 +# with name TypeT. When disabled the typedef will appear as a member of a file, 
   1.254 +# namespace, or class. And the struct will be named TypeS. This can typically 
   1.255 +# be useful for C code in case the coding convention dictates that all compound 
   1.256 +# types are typedef'ed and only the typedef is referenced, never the tag name.
   1.257 +
   1.258 +TYPEDEF_HIDES_STRUCT   = YES
   1.259 +
   1.260 +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
   1.261 +# determine which symbols to keep in memory and which to flush to disk. 
   1.262 +# When the cache is full, less often used symbols will be written to disk. 
   1.263 +# For small to medium size projects (<1000 input files) the default value is 
   1.264 +# probably good enough. For larger projects a too small cache size can cause 
   1.265 +# doxygen to be busy swapping symbols to and from disk most of the time 
   1.266 +# causing a significant performance penality. 
   1.267 +# If the system has enough physical memory increasing the cache will improve the 
   1.268 +# performance by keeping more symbols in memory. Note that the value works on 
   1.269 +# a logarithmic scale so increasing the size by one will rougly double the 
   1.270 +# memory usage. The cache size is given by this formula: 
   1.271 +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
   1.272 +# corresponding to a cache size of 2^16 = 65536 symbols
   1.273 +
   1.274 +SYMBOL_CACHE_SIZE      = 0
   1.275 +
   1.276  #---------------------------------------------------------------------------
   1.277  # Build related configuration options
   1.278  #---------------------------------------------------------------------------
   1.279 @@ -219,17 +312,17 @@
   1.280  # Private class members and static file members will be hidden unless 
   1.281  # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
   1.282  
   1.283 -EXTRACT_ALL            = NO
   1.284 +EXTRACT_ALL            = YES
   1.285  
   1.286  # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
   1.287  # will be included in the documentation.
   1.288  
   1.289 -EXTRACT_PRIVATE        = NO
   1.290 +EXTRACT_PRIVATE        = YES
   1.291  
   1.292  # If the EXTRACT_STATIC tag is set to YES all static members of a file 
   1.293  # will be included in the documentation.
   1.294  
   1.295 -EXTRACT_STATIC         = NO
   1.296 +EXTRACT_STATIC         = YES
   1.297  
   1.298  # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
   1.299  # defined locally in source files will be included in the documentation. 
   1.300 @@ -242,7 +335,15 @@
   1.301  # the interface are included in the documentation. 
   1.302  # If set to NO (the default) only methods in the interface are included.
   1.303  
   1.304 -EXTRACT_LOCAL_METHODS  = NO
   1.305 +EXTRACT_LOCAL_METHODS  = YES
   1.306 +
   1.307 +# If this flag is set to YES, the members of anonymous namespaces will be 
   1.308 +# extracted and appear in the documentation as a namespace called 
   1.309 +# 'anonymous_namespace{file}', where file will be replaced with the base 
   1.310 +# name of the file that contains the anonymous namespace. By default 
   1.311 +# anonymous namespace are hidden.
   1.312 +
   1.313 +EXTRACT_ANON_NSPACES   = YES
   1.314  
   1.315  # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
   1.316  # undocumented members of documented classes, files or namespaces. 
   1.317 @@ -278,7 +379,7 @@
   1.318  # to NO (the default) then the documentation will be excluded. 
   1.319  # Set it to YES to include the internal documentation.
   1.320  
   1.321 -INTERNAL_DOCS          = NO
   1.322 +INTERNAL_DOCS          = YES
   1.323  
   1.324  # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
   1.325  # file names in lower-case letters. If set to YES upper-case letters are also 
   1.326 @@ -286,7 +387,7 @@
   1.327  # in case and if your file system supports case sensitive file names. Windows 
   1.328  # and Mac users are advised to set this option to NO.
   1.329  
   1.330 -CASE_SENSE_NAMES       = YES
   1.331 +CASE_SENSE_NAMES       = NO
   1.332  
   1.333  # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
   1.334  # will show members with their full class and namespace scopes in the 
   1.335 @@ -319,11 +420,17 @@
   1.336  
   1.337  SORT_BRIEF_DOCS        = NO
   1.338  
   1.339 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
   1.340 +# hierarchy of group names into alphabetical order. If set to NO (the default) 
   1.341 +# the group names will appear in their defined order.
   1.342 +
   1.343 +SORT_GROUP_NAMES       = NO
   1.344 +
   1.345  # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
   1.346  # sorted by fully-qualified names, including namespaces. If set to 
   1.347  # NO (the default), the class list will be sorted only by class name, 
   1.348  # not including the namespace part. 
   1.349 -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
   1.350 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
   1.351  # Note: This option applies only to the class list, not to the 
   1.352  # alphabetical list.
   1.353  
   1.354 @@ -368,28 +475,43 @@
   1.355  
   1.356  MAX_INITIALIZER_LINES  = 30
   1.357  
   1.358 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
   1.359 -# at the bottom of the documentation of classes and structs. If set to YES the 
   1.360 -# list will mention the files that were used to generate the documentation.
   1.361 -
   1.362 -SHOW_USED_FILES        = YES
   1.363 -
   1.364  # If the sources in your project are distributed over multiple directories 
   1.365  # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
   1.366 -# in the documentation. The default is YES.
   1.367 +# in the documentation. The default is NO.
   1.368  
   1.369  SHOW_DIRECTORIES       = YES
   1.370  
   1.371 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
   1.372 +# This will remove the Files entry from the Quick Index and from the 
   1.373 +# Folder Tree View (if specified). The default is YES.
   1.374 +
   1.375 +SHOW_FILES             = YES
   1.376 +
   1.377 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
   1.378 +# Namespaces page.  This will remove the Namespaces entry from the Quick Index 
   1.379 +# and from the Folder Tree View (if specified). The default is YES.
   1.380 +
   1.381 +SHOW_NAMESPACES        = YES
   1.382 +
   1.383  # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
   1.384 -# doxygen should invoke to get the current version for each file (typically from the 
   1.385 -# version control system). Doxygen will invoke the program by executing (via 
   1.386 +# doxygen should invoke to get the current version for each file (typically from 
   1.387 +# the version control system). Doxygen will invoke the program by executing (via 
   1.388  # popen()) the command <command> <input-file>, where <command> is the value of 
   1.389  # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
   1.390 -# provided by doxygen. Whatever the progam writes to standard output 
   1.391 +# provided by doxygen. Whatever the program writes to standard output 
   1.392  # is used as the file version. See the manual for examples.
   1.393  
   1.394  FILE_VERSION_FILTER    = 
   1.395  
   1.396 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
   1.397 +# doxygen. The layout file controls the global structure of the generated output files 
   1.398 +# in an output format independent way. The create the layout file that represents 
   1.399 +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
   1.400 +# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
   1.401 +# of the layout file.
   1.402 +
   1.403 +LAYOUT_FILE            = 
   1.404 +
   1.405  #---------------------------------------------------------------------------
   1.406  # configuration options related to warning and progress messages
   1.407  #---------------------------------------------------------------------------
   1.408 @@ -424,7 +546,7 @@
   1.409  # wrong or incomplete parameter documentation, but not about the absence of 
   1.410  # documentation.
   1.411  
   1.412 -WARN_NO_PARAMDOC       = NO
   1.413 +WARN_NO_PARAMDOC       = YES
   1.414  
   1.415  # The WARN_FORMAT tag determines the format of the warning messages that 
   1.416  # doxygen can produce. The string should contain the $file, $line, and $text 
   1.417 @@ -439,7 +561,7 @@
   1.418  # and error messages should be written. If left blank the output is written 
   1.419  # to stderr.
   1.420  
   1.421 -WARN_LOGFILE           = 
   1.422 +WARN_LOGFILE           = ./doxygen_warn.txt
   1.423  
   1.424  #---------------------------------------------------------------------------
   1.425  # configuration options related to the input files
   1.426 @@ -450,28 +572,73 @@
   1.427  # directories like "/usr/src/myproject". Separate the files or directories 
   1.428  # with spaces.
   1.429  
   1.430 -INPUT                  = 
   1.431 +INPUT                  = ..
   1.432 +
   1.433 +# This tag can be used to specify the character encoding of the source files 
   1.434 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
   1.435 +# also the default input encoding. Doxygen uses libiconv (or the iconv built 
   1.436 +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
   1.437 +# the list of possible encodings.
   1.438 +
   1.439 +INPUT_ENCODING         = UTF-8
   1.440  
   1.441  # If the value of the INPUT tag contains directories, you can use the 
   1.442  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   1.443  # and *.h) to filter out the source-files in the directories. If left 
   1.444  # blank the following patterns are tested: 
   1.445  # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
   1.446 -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
   1.447 +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
   1.448  
   1.449 -FILE_PATTERNS          = 
   1.450 +FILE_PATTERNS          = *.c \
   1.451 +                         *.cc \
   1.452 +                         *.cxx \
   1.453 +                         *.cpp \
   1.454 +                         *.c++ \
   1.455 +                         *.d \
   1.456 +                         *.java \
   1.457 +                         *.ii \
   1.458 +                         *.ixx \
   1.459 +                         *.ipp \
   1.460 +                         *.i++ \
   1.461 +                         *.inl \
   1.462 +                         *.h \
   1.463 +                         *.hh \
   1.464 +                         *.hxx \
   1.465 +                         *.hpp \
   1.466 +                         *.h++ \
   1.467 +                         *.idl \
   1.468 +                         *.odl \
   1.469 +                         *.cs \
   1.470 +                         *.php \
   1.471 +                         *.php3 \
   1.472 +                         *.inc \
   1.473 +                         *.m \
   1.474 +                         *.mm \
   1.475 +                         *.dox \
   1.476 +                         *.py \
   1.477 +                         *.f90 \
   1.478 +                         *.f \
   1.479 +                         *.vhd \
   1.480 +                         *.vhdl \
   1.481 +                         *.h.in \
   1.482 +                         *.h.default
   1.483  
   1.484  # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
   1.485  # should be searched for input files as well. Possible values are YES and NO. 
   1.486  # If left blank NO is used.
   1.487  
   1.488 -RECURSIVE              = NO
   1.489 +RECURSIVE              = YES
   1.490  
   1.491  # The EXCLUDE tag can be used to specify files and/or directories that should 
   1.492  # excluded from the INPUT source files. This way you can easily exclude a 
   1.493  # subdirectory from a directory tree whose root is specified with the INPUT tag.
   1.494  
   1.495 -EXCLUDE                = 
   1.496 +EXCLUDE                = ../doxy \
   1.497 +                         ../test \
   1.498 +                         ../Xcode \
   1.499 +                         ../VisualC \
   1.500 +                         ../VisualCE \
   1.501 +                         ../Xcode-iPhoneOS
   1.502  
   1.503  # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
   1.504  # directories that are symbolic links (a Unix filesystem feature) are excluded 
   1.505 @@ -485,27 +652,40 @@
   1.506  # against the file with absolute path, so to exclude all test directories 
   1.507  # for example use the pattern */test/*
   1.508  
   1.509 -EXCLUDE_PATTERNS       = 
   1.510 +EXCLUDE_PATTERNS       = */.svn/* \
   1.511 +                         */bin/* \
   1.512 +                         */lib/* \
   1.513 +                         */obj/*
   1.514 +
   1.515 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
   1.516 +# (namespaces, classes, functions, etc.) that should be excluded from the 
   1.517 +# output. The symbol name can be a fully qualified name, a word, or if the 
   1.518 +# wildcard * is used, a substring. Examples: ANamespace, AClass, 
   1.519 +# AClass::ANamespace, ANamespace::*Test
   1.520 +
   1.521 +EXCLUDE_SYMBOLS        = 
   1.522  
   1.523  # The EXAMPLE_PATH tag can be used to specify one or more files or 
   1.524  # directories that contain example code fragments that are included (see 
   1.525  # the \include command).
   1.526  
   1.527 -EXAMPLE_PATH           = 
   1.528 +EXAMPLE_PATH           = ../test \
   1.529 +                         ../Xcode \
   1.530 +                         ../Xcode-iPhoneOS
   1.531  
   1.532  # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
   1.533  # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
   1.534  # and *.h) to filter out the source-files in the directories. If left 
   1.535  # blank all files are included.
   1.536  
   1.537 -EXAMPLE_PATTERNS       = 
   1.538 +EXAMPLE_PATTERNS       = *
   1.539  
   1.540  # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
   1.541  # searched for input files to be used with the \include or \dontinclude 
   1.542  # commands irrespective of the value of the RECURSIVE tag. 
   1.543  # Possible values are YES and NO. If left blank NO is used.
   1.544  
   1.545 -EXAMPLE_RECURSIVE      = NO
   1.546 +EXAMPLE_RECURSIVE      = YES
   1.547  
   1.548  # The IMAGE_PATH tag can be used to specify one or more files or 
   1.549  # directories that contain image that are included in the documentation (see 
   1.550 @@ -547,31 +727,38 @@
   1.551  # Note: To get rid of all source code in the generated output, make sure also 
   1.552  # VERBATIM_HEADERS is set to NO.
   1.553  
   1.554 -SOURCE_BROWSER         = NO
   1.555 +SOURCE_BROWSER         = YES
   1.556  
   1.557  # Setting the INLINE_SOURCES tag to YES will include the body 
   1.558  # of functions and classes directly in the documentation.
   1.559  
   1.560 -INLINE_SOURCES         = NO
   1.561 +INLINE_SOURCES         = YES
   1.562  
   1.563  # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
   1.564  # doxygen to hide any special comment blocks from generated source code 
   1.565  # fragments. Normal C and C++ comments will always remain visible.
   1.566  
   1.567 -STRIP_CODE_COMMENTS    = YES
   1.568 +STRIP_CODE_COMMENTS    = NO
   1.569  
   1.570 -# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
   1.571 +# If the REFERENCED_BY_RELATION tag is set to YES 
   1.572  # then for each documented function all documented 
   1.573  # functions referencing it will be listed.
   1.574  
   1.575  REFERENCED_BY_RELATION = YES
   1.576  
   1.577 -# If the REFERENCES_RELATION tag is set to YES (the default) 
   1.578 +# If the REFERENCES_RELATION tag is set to YES 
   1.579  # then for each documented function all documented entities 
   1.580  # called/used by that function will be listed.
   1.581  
   1.582  REFERENCES_RELATION    = YES
   1.583  
   1.584 +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
   1.585 +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
   1.586 +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
   1.587 +# link to the source code.  Otherwise they will link to the documentation.
   1.588 +
   1.589 +REFERENCES_LINK_SOURCE = YES
   1.590 +
   1.591  # If the USE_HTAGS tag is set to YES then the references to source code 
   1.592  # will point to the HTML generated by the htags(1) tool instead of doxygen 
   1.593  # built-in source browser. The htags tool is part of GNU's global source 
   1.594 @@ -594,7 +781,7 @@
   1.595  # of all compounds will be generated. Enable this if the project 
   1.596  # contains a lot of classes, structs, unions or interfaces.
   1.597  
   1.598 -ALPHABETICAL_INDEX     = NO
   1.599 +ALPHABETICAL_INDEX     = YES
   1.600  
   1.601  # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
   1.602  # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
   1.603 @@ -607,7 +794,8 @@
   1.604  # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
   1.605  # should be ignored while generating the index headers.
   1.606  
   1.607 -IGNORE_PREFIX          = 
   1.608 +IGNORE_PREFIX          = SDL_ \
   1.609 +                         SDL
   1.610  
   1.611  #---------------------------------------------------------------------------
   1.612  # configuration options related to the HTML output
   1.613 @@ -657,9 +845,43 @@
   1.614  
   1.615  HTML_ALIGN_MEMBERS     = YES
   1.616  
   1.617 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
   1.618 +# documentation will contain sections that can be hidden and shown after the 
   1.619 +# page has loaded. For this to work a browser that supports 
   1.620 +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
   1.621 +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
   1.622 +
   1.623 +HTML_DYNAMIC_SECTIONS  = YES
   1.624 +
   1.625 +# If the GENERATE_DOCSET tag is set to YES, additional index files 
   1.626 +# will be generated that can be used as input for Apple's Xcode 3 
   1.627 +# integrated development environment, introduced with OSX 10.5 (Leopard). 
   1.628 +# To create a documentation set, doxygen will generate a Makefile in the 
   1.629 +# HTML output directory. Running make will produce the docset in that 
   1.630 +# directory and running "make install" will install the docset in 
   1.631 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
   1.632 +# it at startup. 
   1.633 +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
   1.634 +
   1.635 +GENERATE_DOCSET        = NO
   1.636 +
   1.637 +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
   1.638 +# feed. A documentation feed provides an umbrella under which multiple 
   1.639 +# documentation sets from a single provider (such as a company or product suite) 
   1.640 +# can be grouped.
   1.641 +
   1.642 +DOCSET_FEEDNAME        = "SDL 1.2 Doxygen"
   1.643 +
   1.644 +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
   1.645 +# should uniquely identify the documentation set bundle. This should be a 
   1.646 +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
   1.647 +# will append .docset to the name.
   1.648 +
   1.649 +DOCSET_BUNDLE_ID       = org.libsdl.sdl12
   1.650 +
   1.651  # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
   1.652  # will be generated that can be used as input for tools like the 
   1.653 -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
   1.654 +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
   1.655  # of the generated HTML documentation.
   1.656  
   1.657  GENERATE_HTMLHELP      = NO
   1.658 @@ -669,7 +891,7 @@
   1.659  # can add a path in front of the file if the result should not be 
   1.660  # written to the html output directory.
   1.661  
   1.662 -CHM_FILE               = 
   1.663 +CHM_FILE               = ./sdl12.chm
   1.664  
   1.665  # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
   1.666  # be used to specify the location (absolute path including file name) of 
   1.667 @@ -684,6 +906,12 @@
   1.668  
   1.669  GENERATE_CHI           = NO
   1.670  
   1.671 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
   1.672 +# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
   1.673 +# content.
   1.674 +
   1.675 +CHM_INDEX_ENCODING     = 
   1.676 +
   1.677  # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
   1.678  # controls whether a binary table of contents is generated (YES) or a 
   1.679  # normal table of contents (NO) in the .chm file.
   1.680 @@ -693,7 +921,56 @@
   1.681  # The TOC_EXPAND flag can be set to YES to add extra items for group members 
   1.682  # to the contents of the HTML help documentation and to the tree view.
   1.683  
   1.684 -TOC_EXPAND             = NO
   1.685 +TOC_EXPAND             = YES
   1.686 +
   1.687 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
   1.688 +# are set, an additional index file will be generated that can be used as input for 
   1.689 +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
   1.690 +# HTML documentation.
   1.691 +
   1.692 +GENERATE_QHP           = NO
   1.693 +
   1.694 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
   1.695 +# be used to specify the file name of the resulting .qch file. 
   1.696 +# The path specified is relative to the HTML output folder.
   1.697 +
   1.698 +QCH_FILE               = 
   1.699 +
   1.700 +# The QHP_NAMESPACE tag specifies the namespace to use when generating 
   1.701 +# Qt Help Project output. For more information please see 
   1.702 +# http://doc.trolltech.com/qthelpproject.html#namespace
   1.703 +
   1.704 +QHP_NAMESPACE          = 
   1.705 +
   1.706 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
   1.707 +# Qt Help Project output. For more information please see 
   1.708 +# http://doc.trolltech.com/qthelpproject.html#virtual-folders
   1.709 +
   1.710 +QHP_VIRTUAL_FOLDER     = doc
   1.711 +
   1.712 +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
   1.713 +# For more information please see 
   1.714 +# http://doc.trolltech.com/qthelpproject.html#custom-filters
   1.715 +
   1.716 +QHP_CUST_FILTER_NAME   = 
   1.717 +
   1.718 +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
   1.719 +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
   1.720 +
   1.721 +QHP_CUST_FILTER_ATTRS  = 
   1.722 +
   1.723 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
   1.724 +# filter section matches. 
   1.725 +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
   1.726 +
   1.727 +QHP_SECT_FILTER_ATTRS  = 
   1.728 +
   1.729 +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
   1.730 +# be used to specify the location of Qt's qhelpgenerator. 
   1.731 +# If non-empty doxygen will try to run qhelpgenerator on the generated 
   1.732 +# .qhp file.
   1.733 +
   1.734 +QHG_LOCATION           = 
   1.735  
   1.736  # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
   1.737  # top of each HTML page. The value NO (the default) enables the index and 
   1.738 @@ -704,16 +981,24 @@
   1.739  # This tag can be used to set the number of enum values (range [1..20]) 
   1.740  # that doxygen will group on one line in the generated HTML documentation.
   1.741  
   1.742 -ENUM_VALUES_PER_LINE   = 4
   1.743 +ENUM_VALUES_PER_LINE   = 1
   1.744  
   1.745 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
   1.746 -# generated containing a tree-like index structure (just like the one that 
   1.747 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
   1.748 +# structure should be generated to display hierarchical information. 
   1.749 +# If the tag value is set to FRAME, a side panel will be generated 
   1.750 +# containing a tree-like index structure (just like the one that 
   1.751  # is generated for HTML Help). For this to work a browser that supports 
   1.752  # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
   1.753  # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
   1.754 -# probably better off using the HTML help feature.
   1.755 +# probably better off using the HTML help feature. Other possible values 
   1.756 +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
   1.757 +# and Class Hierarchy pages using a tree view instead of an ordered list; 
   1.758 +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
   1.759 +# disables this behavior completely. For backwards compatibility with previous 
   1.760 +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
   1.761 +# respectively.
   1.762  
   1.763 -GENERATE_TREEVIEW      = NO
   1.764 +GENERATE_TREEVIEW      = ALL
   1.765  
   1.766  # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
   1.767  # used to set the initial width (in pixels) of the frame in which the tree 
   1.768 @@ -721,6 +1006,14 @@
   1.769  
   1.770  TREEVIEW_WIDTH         = 250
   1.771  
   1.772 +# Use this tag to change the font size of Latex formulas included 
   1.773 +# as images in the HTML documentation. The default is 10. Note that 
   1.774 +# when you change the font size after a successful doxygen run you need 
   1.775 +# to manually remove any form_*.png images from the HTML output directory 
   1.776 +# to force them to be regenerated.
   1.777 +
   1.778 +FORMULA_FONTSIZE       = 10
   1.779 +
   1.780  #---------------------------------------------------------------------------
   1.781  # configuration options related to the LaTeX output
   1.782  #---------------------------------------------------------------------------
   1.783 @@ -728,7 +1021,7 @@
   1.784  # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
   1.785  # generate Latex output.
   1.786  
   1.787 -GENERATE_LATEX         = YES
   1.788 +GENERATE_LATEX         = NO
   1.789  
   1.790  # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
   1.791  # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1.792 @@ -776,13 +1069,13 @@
   1.793  # contain links (just like the HTML output) instead of page references 
   1.794  # This makes the output suitable for online browsing using a pdf viewer.
   1.795  
   1.796 -PDF_HYPERLINKS         = NO
   1.797 +PDF_HYPERLINKS         = YES
   1.798  
   1.799  # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
   1.800  # plain latex in the generated Makefile. Set this option to YES to get a 
   1.801  # higher quality PDF documentation.
   1.802  
   1.803 -USE_PDFLATEX           = NO
   1.804 +USE_PDFLATEX           = YES
   1.805  
   1.806  # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
   1.807  # command to the generated LaTeX files. This will instruct LaTeX to keep 
   1.808 @@ -797,6 +1090,13 @@
   1.809  
   1.810  LATEX_HIDE_INDICES     = NO
   1.811  
   1.812 +# If LATEX_SOURCE_CODE is set to YES then doxygen will include
   1.813 +# source code with syntax highlighting in the LaTeX output.
   1.814 +# Note that which sources are shown also depends on other settings
   1.815 +# such as SOURCE_BROWSER.
   1.816 +
   1.817 +LATEX_SOURCE_CODE      = NO
   1.818 +
   1.819  #---------------------------------------------------------------------------
   1.820  # configuration options related to the RTF output
   1.821  #---------------------------------------------------------------------------
   1.822 @@ -846,7 +1146,7 @@
   1.823  # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
   1.824  # generate man pages
   1.825  
   1.826 -GENERATE_MAN           = YES
   1.827 +GENERATE_MAN           = NO
   1.828  
   1.829  # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
   1.830  # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
   1.831 @@ -966,7 +1266,7 @@
   1.832  
   1.833  # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
   1.834  # then the macro expansion is limited to the macros specified with the 
   1.835 -# PREDEFINED and EXPAND_AS_PREDEFINED tags.
   1.836 +# PREDEFINED and EXPAND_AS_DEFINED tags.
   1.837  
   1.838  EXPAND_ONLY_PREDEF     = YES
   1.839  
   1.840 @@ -997,7 +1297,9 @@
   1.841  # instead of the = operator.
   1.842  
   1.843  PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
   1.844 -                         DECLSPEC= SDLCALL=
   1.845 +                         DECLSPEC= \
   1.846 +                         SDLCALL= \
   1.847 +                         _WIN32=1
   1.848  
   1.849  # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
   1.850  # this tag can be used to specify a list of macro names that should be expanded. 
   1.851 @@ -1027,9 +1329,9 @@
   1.852  #   TAGFILES = file1=loc1 "file2 = loc2" ... 
   1.853  # where "loc1" and "loc2" can be relative or absolute paths or 
   1.854  # URLs. If a location is present for each tag, the installdox tool 
   1.855 -# does not have to be run to correct the links.
   1.856 -# Note that each tag file must have a unique name
   1.857 -# (where the name does NOT include the path)
   1.858 +# does not have to be run to correct the links. 
   1.859 +# Note that each tag file must have a unique name 
   1.860 +# (where the name does NOT include the path) 
   1.861  # If a tag file is not located in the directory in which doxygen 
   1.862  # is run, you must also specify the path to the tagfile here.
   1.863  
   1.864 @@ -1038,7 +1340,7 @@
   1.865  # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
   1.866  # a tag file that is based on the input files it reads.
   1.867  
   1.868 -GENERATE_TAGFILE       = 
   1.869 +GENERATE_TAGFILE       = ./SDL.tag
   1.870  
   1.871  # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
   1.872  # in the class index. If set to NO only the inherited external classes 
   1.873 @@ -1055,7 +1357,7 @@
   1.874  # The PERL_PATH should be the absolute path and name of the perl script 
   1.875  # interpreter (i.e. the result of `which perl').
   1.876  
   1.877 -PERL_PATH              = /usr/bin/perl
   1.878 +PERL_PATH              = c:\Perl\bin\perl.exe
   1.879  
   1.880  #---------------------------------------------------------------------------
   1.881  # Configuration options related to the dot tool   
   1.882 @@ -1068,7 +1370,16 @@
   1.883  # fallback. It is recommended to install and use dot, since it yields more 
   1.884  # powerful graphs.
   1.885  
   1.886 -CLASS_DIAGRAMS         = NO
   1.887 +CLASS_DIAGRAMS         = YES
   1.888 +
   1.889 +# You can define message sequence charts within doxygen comments using the \msc 
   1.890 +# command. Doxygen will then run the mscgen tool (see 
   1.891 +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
   1.892 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
   1.893 +# the mscgen tool resides. If left empty the tool is assumed to be found in the 
   1.894 +# default search path.
   1.895 +
   1.896 +MSCGEN_PATH            = 
   1.897  
   1.898  # If set to YES, the inheritance and collaboration graphs will hide 
   1.899  # inheritance and usage relations if the target is undocumented 
   1.900 @@ -1081,7 +1392,30 @@
   1.901  # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
   1.902  # have no effect if this option is set to NO (the default)
   1.903  
   1.904 -HAVE_DOT               = NO
   1.905 +HAVE_DOT               = YES
   1.906 +
   1.907 +# By default doxygen will write a font called FreeSans.ttf to the output 
   1.908 +# directory and reference it in all dot files that doxygen generates. This 
   1.909 +# font does not include all possible unicode characters however, so when you need 
   1.910 +# these (or just want a differently looking font) you can specify the font name 
   1.911 +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
   1.912 +# which can be done by putting it in a standard location or by setting the 
   1.913 +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
   1.914 +# containing the font.
   1.915 +
   1.916 +DOT_FONTNAME           = FreeSans
   1.917 +
   1.918 +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
   1.919 +# The default size is 10pt.
   1.920 +
   1.921 +DOT_FONTSIZE           = 10
   1.922 +
   1.923 +# By default doxygen will tell dot to use the output directory to look for the 
   1.924 +# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
   1.925 +# different font using DOT_FONTNAME you can set the path where dot 
   1.926 +# can find it using this tag.
   1.927 +
   1.928 +DOT_FONTPATH           = 
   1.929  
   1.930  # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
   1.931  # will generate a graph for each documented class showing the direct and 
   1.932 @@ -1111,14 +1445,14 @@
   1.933  # If set to YES, the inheritance and collaboration graphs will show the 
   1.934  # relations between templates and their instances.
   1.935  
   1.936 -TEMPLATE_RELATIONS     = NO
   1.937 +TEMPLATE_RELATIONS     = YES
   1.938  
   1.939  # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
   1.940  # tags are set to YES then doxygen will generate a graph for each documented 
   1.941  # file showing the direct and indirect include dependencies of the file with 
   1.942  # other documented files.
   1.943  
   1.944 -INCLUDE_GRAPH          = NO
   1.945 +INCLUDE_GRAPH          = YES
   1.946  
   1.947  # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
   1.948  # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
   1.949 @@ -1127,14 +1461,22 @@
   1.950  
   1.951  INCLUDED_BY_GRAPH      = YES
   1.952  
   1.953 -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
   1.954 -# generate a call dependency graph for every global function or class method. 
   1.955 -# Note that enabling this option will significantly increase the time of a run. 
   1.956 -# So in most cases it will be better to enable call graphs for selected 
   1.957 -# functions only using the \callgraph command.
   1.958 +# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
   1.959 +# doxygen will generate a call dependency graph for every global function 
   1.960 +# or class method. Note that enabling this option will significantly increase 
   1.961 +# the time of a run. So in most cases it will be better to enable call graphs 
   1.962 +# for selected functions only using the \callgraph command.
   1.963  
   1.964  CALL_GRAPH             = NO
   1.965  
   1.966 +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
   1.967 +# doxygen will generate a caller dependency graph for every global function 
   1.968 +# or class method. Note that enabling this option will significantly increase 
   1.969 +# the time of a run. So in most cases it will be better to enable caller 
   1.970 +# graphs for selected functions only using the \callergraph command.
   1.971 +
   1.972 +CALLER_GRAPH           = NO
   1.973 +
   1.974  # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
   1.975  # will graphical hierarchy of all classes instead of a textual one.
   1.976  
   1.977 @@ -1142,13 +1484,13 @@
   1.978  
   1.979  # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
   1.980  # then doxygen will show the dependencies a directory has on other directories 
   1.981 -# in a graphical way. The dependency relations are determined by the #include
   1.982 +# in a graphical way. The dependency relations are determined by the #include 
   1.983  # relations between the files in the directories.
   1.984  
   1.985  DIRECTORY_GRAPH        = YES
   1.986  
   1.987  # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
   1.988 -# generated by dot. Possible values are png, jpg, or gif
   1.989 +# generated by dot. Possible values are png, jpg, or gif 
   1.990  # If left blank png will be used.
   1.991  
   1.992  DOT_IMAGE_FORMAT       = png
   1.993 @@ -1164,39 +1506,31 @@
   1.994  
   1.995  DOTFILE_DIRS           = 
   1.996  
   1.997 -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
   1.998 -# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
   1.999 -# this value, doxygen will try to truncate the graph, so that it fits within 
  1.1000 -# the specified constraint. Beware that most browsers cannot cope with very 
  1.1001 -# large images.
  1.1002 -
  1.1003 -MAX_DOT_GRAPH_WIDTH    = 1024
  1.1004 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
  1.1005 +# nodes that will be shown in the graph. If the number of nodes in a graph 
  1.1006 +# becomes larger than this value, doxygen will truncate the graph, which is 
  1.1007 +# visualized by representing a node as a red box. Note that doxygen if the 
  1.1008 +# number of direct children of the root node in a graph is already larger than 
  1.1009 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
  1.1010 +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1.1011  
  1.1012 -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
  1.1013 -# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
  1.1014 -# this value, doxygen will try to truncate the graph, so that it fits within 
  1.1015 -# the specified constraint. Beware that most browsers cannot cope with very 
  1.1016 -# large images.
  1.1017 -
  1.1018 -MAX_DOT_GRAPH_HEIGHT   = 1024
  1.1019 +DOT_GRAPH_MAX_NODES    = 50
  1.1020  
  1.1021  # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
  1.1022  # graphs generated by dot. A depth value of 3 means that only nodes reachable 
  1.1023  # from the root by following a path via at most 3 edges will be shown. Nodes 
  1.1024  # that lay further from the root node will be omitted. Note that setting this 
  1.1025  # option to 1 or 2 may greatly reduce the computation time needed for large 
  1.1026 -# code bases. Also note that a graph may be further truncated if the graph's 
  1.1027 -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
  1.1028 -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
  1.1029 -# the graph is not depth-constrained.
  1.1030 +# code bases. Also note that the size of a graph can be further restricted by 
  1.1031 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1.1032  
  1.1033 -MAX_DOT_GRAPH_DEPTH    = 0
  1.1034 +MAX_DOT_GRAPH_DEPTH    = 2
  1.1035  
  1.1036  # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
  1.1037 -# background. This is disabled by default, which results in a white background. 
  1.1038 -# Warning: Depending on the platform used, enabling this option may lead to 
  1.1039 -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
  1.1040 -# read).
  1.1041 +# background. This is disabled by default, because dot on Windows does not 
  1.1042 +# seem to support this out of the box. Warning: Depending on the platform used, 
  1.1043 +# enabling this option may lead to badly anti-aliased labels on the edges of 
  1.1044 +# a graph (i.e. they become hard to read).
  1.1045  
  1.1046  DOT_TRANSPARENT        = NO
  1.1047  
  1.1048 @@ -1205,7 +1539,7 @@
  1.1049  # makes dot run faster, but since only newer versions of dot (>1.8.10) 
  1.1050  # support this, this feature is disabled by default.
  1.1051  
  1.1052 -DOT_MULTI_TARGETS      = NO
  1.1053 +DOT_MULTI_TARGETS      = YES
  1.1054  
  1.1055  # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
  1.1056  # generate a legend page explaining the meaning of the various boxes and 
  1.1057 @@ -1220,7 +1554,7 @@
  1.1058  DOT_CLEANUP            = YES
  1.1059  
  1.1060  #---------------------------------------------------------------------------
  1.1061 -# Configuration::additions related to the search engine   
  1.1062 +# Options related to the search engine
  1.1063  #---------------------------------------------------------------------------
  1.1064  
  1.1065  # The SEARCHENGINE tag specifies whether or not a search engine should be