docs/Doxyfile
author Ryan C. Gordon <icculus@icculus.org>
Fri, 12 Jun 2020 03:37:58 -0400
changeset 1692 acdcf93d1f9b
parent 1271 28530ae4d9d1
permissions -rw-r--r--
android: PhysicsFS now has actual Android support. This compiled and worked on Android before, if you didn't care about PHYSFS_getBaseDir() and PHYSFS_getPrefDir() being useful. Now you can pass PHYSFS_init() some necessary Android objects to solve this. Passing NULL to PHYSFS_init is acceptable and will simply report "/" for the base dir and prefdir, under the assumption that the app queried the OS for these directly instead.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
     1
# Doxyfile 1.3.4
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     2
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     3
# This file describes the settings to be used by the documentation system
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     4
# doxygen (www.doxygen.org) for a project
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     5
#
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     6
# All text after a hash (#) is considered a comment and will be ignored
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     7
# The format is:
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     8
#       TAG = value [value, ...]
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     9
# For lists items can also be appended using:
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    10
#       TAG += value [value, ...]
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    11
# Values that contain spaces should be placed between quotes (" ")
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    12
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    13
#---------------------------------------------------------------------------
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    14
# Project related configuration options
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    15
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    16
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    18
# by quotes) that should identify the project.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    19
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    20
PROJECT_NAME           = physfs
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    21
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    22
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    23
# This could be handy for archiving the generated documentation or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    24
# if some version control system is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    25
1151
a9e1bbe6e8d6 Fixed "make docs" for out-of-tree builds.
Ryan C. Gordon <icculus@icculus.org>
parents: 1024
diff changeset
    26
# (CMake will set this properly at build time. --ryan.)
1154
d89b62903d59 Changed default doc version string.
Ryan C. Gordon <icculus@icculus.org>
parents: 1153
diff changeset
    27
PROJECT_NUMBER         = "unknown version (build with 'make docs' next time!)"
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    28
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    29
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    30
# base path where the generated documentation will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    31
# If a relative path is entered, it will be relative to the location 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    32
# where doxygen was started. If left blank the current directory will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    33
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    34
OUTPUT_DIRECTORY       = docs
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    35
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    36
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    37
# documentation generated by doxygen is written. Doxygen will use this 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    38
# information to generate all constant output in the proper language. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    39
# The default language is English, other supported languages are: 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    40
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    41
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    42
# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    43
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    44
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    45
OUTPUT_LANGUAGE        = English
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    46
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    47
# This tag can be used to specify the encoding used in the generated output. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    48
# The encoding is not always determined by the language that is chosen, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    49
# but also whether or not the output is meant for Windows or non-Windows users. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    50
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    51
# forces the Windows encoding (this is the default for the Windows binary), 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    52
# whereas setting the tag to NO uses a Unix-style encoding (the default for 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    53
# all platforms other than Windows).
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    54
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    55
USE_WINDOWS_ENCODING   = NO
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    56
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    57
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    58
# include brief member descriptions after the members that are listed in 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    59
# the file and class documentation (similar to JavaDoc). 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    60
# Set to NO to disable this.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    61
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    62
BRIEF_MEMBER_DESC      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    63
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    64
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    65
# the brief description of a member or function before the detailed description. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    66
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    67
# brief descriptions will be completely suppressed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    68
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    69
REPEAT_BRIEF           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    70
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    71
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    72
# Doxygen will generate a detailed section even if there is only a brief 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    73
# description.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    74
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    75
ALWAYS_DETAILED_SEC    = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    76
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    77
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    78
# members of a class in the documentation of that class as if those members were 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    79
# ordinary class members. Constructors, destructors and assignment operators of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    80
# the base classes will not be shown.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    81
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    82
INLINE_INHERITED_MEMB  = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    83
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    84
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    85
# path before files name in the file list and in the header files. If set 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    86
# to NO the shortest path that makes the file name unique will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    87
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    88
FULL_PATH_NAMES        = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    89
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    90
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
    91
# can be used to strip a user-defined part of the path. Stripping is 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    92
# only done if one of the specified strings matches the left-hand part of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    93
# the path. It is allowed to use relative paths in the argument list.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    94
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    95
STRIP_FROM_PATH        = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    96
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    97
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    98
# (but less readable) file names. This can be useful is your file systems 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    99
# doesn't support long names like on DOS, Mac, or CD-ROM.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   100
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   101
SHORT_NAMES            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   102
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   103
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   104
# will interpret the first line (until the first dot) of a JavaDoc-style 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   105
# comment as the brief description. If set to NO, the JavaDoc 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   106
# comments will behave just like the Qt-style comments (thus requiring an 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   107
# explict @brief command for a brief description.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   108
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   109
JAVADOC_AUTOBRIEF      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   110
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   111
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   112
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   113
# comments) as a brief description. This used to be the default behaviour. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   114
# The new default is to treat a multi-line C++ comment block as a detailed 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   115
# description. Set this tag to YES if you prefer the old behaviour instead.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   116
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   117
MULTILINE_CPP_IS_BRIEF = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   118
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   119
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   120
# will output the detailed description near the top, like JavaDoc.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   121
# If set to NO, the detailed description appears after the member 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   122
# documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   123
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   124
DETAILS_AT_TOP         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   125
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   126
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   127
# member inherits the documentation from any documented member that it 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   128
# reimplements.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   129
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   130
INHERIT_DOCS           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   131
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   132
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   133
# tag is set to YES, then doxygen will reuse the documentation of the first 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   134
# member in the group (if any) for the other members of the group. By default 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   135
# all members of a group must be documented explicitly.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   136
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   137
DISTRIBUTE_GROUP_DOC   = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   138
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   139
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   140
# Doxygen uses this value to replace tabs by spaces in code fragments.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   141
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   142
TAB_SIZE               = 4
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   143
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   144
# This tag can be used to specify a number of aliases that acts 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   145
# as commands in the documentation. An alias has the form "name=value". 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   146
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   147
# put the command \sideeffect (or @sideeffect) in the documentation, which 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   148
# will result in a user-defined paragraph with heading "Side Effects:". 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   149
# You can put \n's in the value part of an alias to insert newlines.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   150
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   151
ALIASES                = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   152
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   153
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   154
# only. Doxygen will then generate output that is more tailored for C. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   155
# For instance, some of the names that are used will be different. The list 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   156
# of all members will be omitted, etc.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   157
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   158
OPTIMIZE_OUTPUT_FOR_C  = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   159
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   160
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   161
# only. Doxygen will then generate output that is more tailored for Java. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   162
# For instance, namespaces will be presented as packages, qualified scopes 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   163
# will look different, etc.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   164
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   165
OPTIMIZE_OUTPUT_JAVA   = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   166
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   167
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   168
# the same type (for instance a group of public functions) to be put as a 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   169
# subgroup of that type (e.g. under the Public Functions section). Set it to 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   170
# NO to prevent subgrouping. Alternatively, this can be done per class using 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   171
# the \nosubgrouping command.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   172
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   173
SUBGROUPING            = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   174
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   175
#---------------------------------------------------------------------------
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   176
# Build related configuration options
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   177
#---------------------------------------------------------------------------
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   178
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   179
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   180
# documentation are documented, even if no documentation was available. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   181
# Private class members and static file members will be hidden unless 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   182
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   183
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   184
EXTRACT_ALL            = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   185
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   186
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   187
# will be included in the documentation.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   188
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   189
EXTRACT_PRIVATE        = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   190
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   191
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   192
# will be included in the documentation.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   193
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   194
EXTRACT_STATIC         = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   195
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   196
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   197
# defined locally in source files will be included in the documentation. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   198
# If set to NO only classes defined in header files are included.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   199
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   200
EXTRACT_LOCAL_CLASSES  = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   201
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   202
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   203
# undocumented members of documented classes, files or namespaces. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   204
# If set to NO (the default) these members will be included in the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   205
# various overviews, but no documentation section is generated. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   206
# This option has no effect if EXTRACT_ALL is enabled.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   207
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   208
HIDE_UNDOC_MEMBERS     = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   209
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   210
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   211
# undocumented classes that are normally visible in the class hierarchy. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   212
# If set to NO (the default) these classes will be included in the various 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   213
# overviews. This option has no effect if EXTRACT_ALL is enabled.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   214
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   215
HIDE_UNDOC_CLASSES     = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   216
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   217
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   218
# friend (class|struct|union) declarations. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   219
# If set to NO (the default) these declarations will be included in the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   220
# documentation.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   221
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   222
HIDE_FRIEND_COMPOUNDS  = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   223
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   224
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   225
# documentation blocks found inside the body of a function. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   226
# If set to NO (the default) these blocks will be appended to the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   227
# function's detailed documentation block.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   228
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   229
HIDE_IN_BODY_DOCS      = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   230
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   231
# The INTERNAL_DOCS tag determines if documentation 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   232
# that is typed after a \internal command is included. If the tag is set 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   233
# to NO (the default) then the documentation will be excluded. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   234
# Set it to YES to include the internal documentation.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   235
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   236
INTERNAL_DOCS          = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   237
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   238
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   239
# file names in lower-case letters. If set to YES upper-case letters are also 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   240
# allowed. This is useful if you have classes or files whose names only differ 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   241
# in case and if your file system supports case sensitive file names. Windows 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   242
# users are advised to set this option to NO.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   243
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   244
CASE_SENSE_NAMES       = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   245
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   246
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   247
# will show members with their full class and namespace scopes in the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   248
# documentation. If set to YES the scope will be hidden.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   249
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   250
HIDE_SCOPE_NAMES       = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   251
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   252
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   253
# will put a list of the files that are included by a file in the documentation 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   254
# of that file.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   255
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   256
SHOW_INCLUDE_FILES     = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   257
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   258
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   259
# is inserted in the documentation for inline members.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   260
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   261
INLINE_INFO            = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   262
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   263
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   264
# will sort the (detailed) documentation of file and class members 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   265
# alphabetically by member name. If set to NO the members will appear in 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   266
# declaration order.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   267
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   268
SORT_MEMBER_DOCS       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   269
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   270
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   271
# disable (NO) the todo list. This list is created by putting \todo 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   272
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   273
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   274
GENERATE_TODOLIST      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   275
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   276
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   277
# disable (NO) the test list. This list is created by putting \test 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   278
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   279
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   280
GENERATE_TESTLIST      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   281
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   282
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   283
# disable (NO) the bug list. This list is created by putting \bug 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   284
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   285
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   286
GENERATE_BUGLIST       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   287
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   288
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   289
# disable (NO) the deprecated list. This list is created by putting 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   290
# \deprecated commands in the documentation.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   291
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   292
GENERATE_DEPRECATEDLIST= YES
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   293
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   294
# The ENABLED_SECTIONS tag can be used to enable conditional 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   295
# documentation sections, marked by \if sectionname ... \endif.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   296
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   297
ENABLED_SECTIONS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   298
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   299
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   300
# the initial value of a variable or define consists of for it to appear in 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   301
# the documentation. If the initializer consists of more lines than specified 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   302
# here it will be hidden. Use a value of 0 to hide initializers completely. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   303
# The appearance of the initializer of individual variables and defines in the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   304
# documentation can be controlled using \showinitializer or \hideinitializer 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   305
# command in the documentation regardless of this setting.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   306
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   307
MAX_INITIALIZER_LINES  = 30
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   308
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   309
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   310
# at the bottom of the documentation of classes and structs. If set to YES the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   311
# list will mention the files that were used to generate the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   312
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   313
SHOW_USED_FILES        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   314
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   315
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   316
# configuration options related to warning and progress messages
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   317
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   318
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   319
# The QUIET tag can be used to turn on/off the messages that are generated 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   320
# by doxygen. Possible values are YES and NO. If left blank NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   321
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   322
QUIET                  = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   323
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   324
# The WARNINGS tag can be used to turn on/off the warning messages that are 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   325
# generated by doxygen. Possible values are YES and NO. If left blank 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   326
# NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   327
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   328
WARNINGS               = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   329
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   330
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   331
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   332
# automatically be disabled.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   333
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   334
WARN_IF_UNDOCUMENTED   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   335
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   336
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   337
# potential errors in the documentation, such as not documenting some 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   338
# parameters in a documented function, or documenting parameters that 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   339
# don't exist or using markup commands wrongly.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   340
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   341
WARN_IF_DOC_ERROR      = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   342
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   343
# The WARN_FORMAT tag determines the format of the warning messages that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   344
# doxygen can produce. The string should contain the $file, $line, and $text 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   345
# tags, which will be replaced by the file and line number from which the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   346
# warning originated and the warning text.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   347
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   348
WARN_FORMAT            = "$file:$line: $text"
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   349
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   350
# The WARN_LOGFILE tag can be used to specify a file to which warning 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   351
# and error messages should be written. If left blank the output is written 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   352
# to stderr.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   353
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   354
WARN_LOGFILE           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   355
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   356
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   357
# configuration options related to the input files
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   358
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   359
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   360
# The INPUT tag can be used to specify the files and/or directories that contain 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   361
# documented source files. You may enter file names like "myfile.cpp" or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   362
# directories like "/usr/src/myproject". Separate the files or directories 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   363
# with spaces.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   364
1153
5cbedebaa623 Corrected doc paths for development branch.
Ryan C. Gordon <icculus@icculus.org>
parents: 1151
diff changeset
   365
INPUT                  = src/physfs.h
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   366
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   367
# If the value of the INPUT tag contains directories, you can use the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   368
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   369
# and *.h) to filter out the source-files in the directories. If left 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   370
# blank the following patterns are tested: 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   371
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   372
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   373
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   374
FILE_PATTERNS          = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   375
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   376
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   377
# should be searched for input files as well. Possible values are YES and NO. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   378
# If left blank NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   379
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   380
RECURSIVE              = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   381
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   382
# The EXCLUDE tag can be used to specify files and/or directories that should 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   383
# excluded from the INPUT source files. This way you can easily exclude a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   384
# subdirectory from a directory tree whose root is specified with the INPUT tag.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   385
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   386
EXCLUDE                = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   387
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   388
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   389
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   390
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   391
EXCLUDE_SYMLINKS       = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   392
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   393
# If the value of the INPUT tag contains directories, you can use the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   394
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   395
# certain files from those directories.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   396
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   397
EXCLUDE_PATTERNS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   398
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   399
# The EXAMPLE_PATH tag can be used to specify one or more files or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   400
# directories that contain example code fragments that are included (see 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   401
# the \include command).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   402
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   403
EXAMPLE_PATH           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   404
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   405
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   406
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   407
# and *.h) to filter out the source-files in the directories. If left 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   408
# blank all files are included.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   409
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   410
EXAMPLE_PATTERNS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   411
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   412
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   413
# searched for input files to be used with the \include or \dontinclude 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   414
# commands irrespective of the value of the RECURSIVE tag. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   415
# Possible values are YES and NO. If left blank NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   416
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   417
EXAMPLE_RECURSIVE      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   418
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   419
# The IMAGE_PATH tag can be used to specify one or more files or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   420
# directories that contain image that are included in the documentation (see 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   421
# the \image command).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   422
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   423
IMAGE_PATH             = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   424
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   425
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   426
# invoke to filter for each input file. Doxygen will invoke the filter program 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   427
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   428
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   429
# input file. Doxygen will then use the output that the filter program writes 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   430
# to standard output.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   431
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   432
INPUT_FILTER           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   433
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   434
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   435
# INPUT_FILTER) will be used to filter the input files when producing source 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   436
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   437
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   438
FILTER_SOURCE_FILES    = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   439
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   440
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   441
# configuration options related to source browsing
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   442
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   443
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   444
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   445
# be generated. Documented entities will be cross-referenced with these sources.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   446
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   447
SOURCE_BROWSER         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   448
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   449
# Setting the INLINE_SOURCES tag to YES will include the body 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   450
# of functions and classes directly in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   451
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   452
INLINE_SOURCES         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   453
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   454
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   455
# doxygen to hide any special comment blocks from generated source code 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   456
# fragments. Normal C and C++ comments will always remain visible.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   457
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   458
STRIP_CODE_COMMENTS    = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   459
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   460
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   461
# then for each documented function all documented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   462
# functions referencing it will be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   463
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   464
REFERENCED_BY_RELATION = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   465
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   466
# If the REFERENCES_RELATION tag is set to YES (the default) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   467
# then for each documented function all documented entities 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   468
# called/used by that function will be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   469
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   470
REFERENCES_RELATION    = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   471
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   472
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   473
# will generate a verbatim copy of the header file for each class for 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   474
# which an include is specified. Set to NO to disable this.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   475
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   476
VERBATIM_HEADERS       = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   477
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   478
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   479
# configuration options related to the alphabetical class index
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   480
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   481
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   482
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   483
# of all compounds will be generated. Enable this if the project 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   484
# contains a lot of classes, structs, unions or interfaces.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   485
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   486
ALPHABETICAL_INDEX     = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   487
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   488
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   489
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   490
# in which this list will be split (can be a number in the range [1..20])
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   491
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   492
COLS_IN_ALPHA_INDEX    = 5
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   493
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   494
# In case all classes in a project start with a common prefix, all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   495
# classes will be put under the same header in the alphabetical index. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   496
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   497
# should be ignored while generating the index headers.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   498
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   499
IGNORE_PREFIX          = 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   500
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   501
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   502
# configuration options related to the HTML output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   503
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   504
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   505
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   506
# generate HTML output.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   507
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   508
GENERATE_HTML          = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   509
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   510
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   511
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   512
# put in front of it. If left blank `html' will be used as the default path.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   513
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   514
HTML_OUTPUT            = html
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   515
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   516
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   517
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   518
# doxygen will generate files with .html extension.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   519
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   520
HTML_FILE_EXTENSION    = .html
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   521
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   522
# The HTML_HEADER tag can be used to specify a personal HTML header for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   523
# each generated HTML page. If it is left blank doxygen will generate a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   524
# standard header.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   525
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   526
HTML_HEADER            = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   527
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   528
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   529
# each generated HTML page. If it is left blank doxygen will generate a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   530
# standard footer.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   531
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   532
HTML_FOOTER            = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   533
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   534
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   535
# style sheet that is used by each HTML page. It can be used to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   536
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   537
# will generate a default style sheet
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   538
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   539
HTML_STYLESHEET        = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   540
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   541
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   542
# files or namespaces will be aligned in HTML using tables. If set to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   543
# NO a bullet list will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   544
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   545
HTML_ALIGN_MEMBERS     = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   546
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   547
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   548
# will be generated that can be used as input for tools like the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   549
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   550
# of the generated HTML documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   551
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   552
GENERATE_HTMLHELP      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   553
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   554
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   555
# be used to specify the file name of the resulting .chm file. You 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   556
# can add a path in front of the file if the result should not be 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   557
# written to the html output dir.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   558
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   559
CHM_FILE               = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   560
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   561
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   562
# be used to specify the location (absolute path including file name) of 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   563
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   564
# the HTML help compiler on the generated index.hhp.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   565
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   566
HHC_LOCATION           = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   567
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   568
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   569
# controls if a separate .chi index file is generated (YES) or that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   570
# it should be included in the master .chm file (NO).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   571
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   572
GENERATE_CHI           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   573
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   574
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   575
# controls whether a binary table of contents is generated (YES) or a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   576
# normal table of contents (NO) in the .chm file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   577
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   578
BINARY_TOC             = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   579
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   580
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   581
# to the contents of the HTML help documentation and to the tree view.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   582
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   583
TOC_EXPAND             = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   584
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   585
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   586
# top of each HTML page. The value NO (the default) enables the index and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   587
# the value YES disables it.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   588
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   589
DISABLE_INDEX          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   590
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   591
# This tag can be used to set the number of enum values (range [1..20]) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   592
# that doxygen will group on one line in the generated HTML documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   593
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   594
ENUM_VALUES_PER_LINE   = 4
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   595
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   596
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   597
# generated containing a tree-like index structure (just like the one that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   598
# is generated for HTML Help). For this to work a browser that supports 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   599
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   600
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   601
# probably better off using the HTML help feature.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   602
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   603
GENERATE_TREEVIEW      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   604
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   605
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   606
# used to set the initial width (in pixels) of the frame in which the tree 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   607
# is shown.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   608
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   609
TREEVIEW_WIDTH         = 250
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   610
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   611
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   612
# configuration options related to the LaTeX output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   613
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   614
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   615
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   616
# generate Latex output.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   617
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   618
GENERATE_LATEX         = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   619
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   620
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   621
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   622
# put in front of it. If left blank `latex' will be used as the default path.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   623
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   624
LATEX_OUTPUT           = latex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   625
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   626
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   627
# invoked. If left blank `latex' will be used as the default command name.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   628
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   629
LATEX_CMD_NAME         = latex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   630
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   631
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   632
# generate index for LaTeX. If left blank `makeindex' will be used as the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   633
# default command name.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   634
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   635
MAKEINDEX_CMD_NAME     = makeindex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   636
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   637
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   638
# LaTeX documents. This may be useful for small projects and may help to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   639
# save some trees in general.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   640
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   641
COMPACT_LATEX          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   642
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   643
# The PAPER_TYPE tag can be used to set the paper type that is used 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   644
# by the printer. Possible values are: a4, a4wide, letter, legal and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   645
# executive. If left blank a4wide will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   646
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   647
PAPER_TYPE             = a4wide
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   648
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   649
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   650
# packages that should be included in the LaTeX output.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   651
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   652
EXTRA_PACKAGES         = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   653
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   654
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   655
# the generated latex document. The header should contain everything until 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   656
# the first chapter. If it is left blank doxygen will generate a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   657
# standard header. Notice: only use this tag if you know what you are doing!
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   658
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   659
LATEX_HEADER           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   660
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   661
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   662
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   663
# contain links (just like the HTML output) instead of page references 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   664
# This makes the output suitable for online browsing using a pdf viewer.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   665
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   666
PDF_HYPERLINKS         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   667
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   668
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   669
# plain latex in the generated Makefile. Set this option to YES to get a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   670
# higher quality PDF documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   671
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   672
USE_PDFLATEX           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   673
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   674
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   675
# command to the generated LaTeX files. This will instruct LaTeX to keep 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   676
# running if errors occur, instead of asking the user for help. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   677
# This option is also used when generating formulas in HTML.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   678
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   679
LATEX_BATCHMODE        = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   680
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   681
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   682
# include the index chapters (such as File Index, Compound Index, etc.) 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   683
# in the output.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   684
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   685
LATEX_HIDE_INDICES     = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   686
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   687
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   688
# configuration options related to the RTF output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   689
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   690
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   691
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   692
# The RTF output is optimised for Word 97 and may not look very pretty with 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   693
# other RTF readers or editors.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   694
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   695
GENERATE_RTF           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   696
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   697
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   698
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   699
# put in front of it. If left blank `rtf' will be used as the default path.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   700
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   701
RTF_OUTPUT             = rtf
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   702
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   703
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   704
# RTF documents. This may be useful for small projects and may help to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   705
# save some trees in general.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   706
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   707
COMPACT_RTF            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   708
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   709
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   710
# will contain hyperlink fields. The RTF file will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   711
# contain links (just like the HTML output) instead of page references. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   712
# This makes the output suitable for online browsing using WORD or other 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   713
# programs which support those fields. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   714
# Note: wordpad (write) and others do not support links.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   715
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   716
RTF_HYPERLINKS         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   717
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   718
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   719
# config file, i.e. a series of assigments. You only have to provide 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   720
# replacements, missing definitions are set to their default value.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   721
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   722
RTF_STYLESHEET_FILE    = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   723
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   724
# Set optional variables used in the generation of an rtf document. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   725
# Syntax is similar to doxygen's config file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   726
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   727
RTF_EXTENSIONS_FILE    = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   728
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   729
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   730
# configuration options related to the man page output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   731
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   732
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   733
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   734
# generate man pages
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   735
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   736
GENERATE_MAN           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   737
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   738
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   739
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   740
# put in front of it. If left blank `man' will be used as the default path.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   741
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   742
MAN_OUTPUT             = man
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   743
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   744
# The MAN_EXTENSION tag determines the extension that is added to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   745
# the generated man pages (default is the subroutine's section .3)
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   746
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   747
MAN_EXTENSION          = .3
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   748
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   749
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   750
# then it will generate one additional man file for each entity 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   751
# documented in the real man page(s). These additional files 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   752
# only source the real man page, but without them the man command 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   753
# would be unable to find the correct page. The default is NO.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   754
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   755
MAN_LINKS              = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   756
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   757
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   758
# configuration options related to the XML output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   759
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   760
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   761
# If the GENERATE_XML tag is set to YES Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   762
# generate an XML file that captures the structure of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   763
# the code including all documentation. Note that this 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   764
# feature is still experimental and incomplete at the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   765
# moment.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   766
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   767
GENERATE_XML           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   768
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   769
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   770
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   771
# put in front of it. If left blank `xml' will be used as the default path.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   772
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   773
XML_OUTPUT             = xml
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   774
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   775
# The XML_SCHEMA tag can be used to specify an XML schema, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   776
# which can be used by a validating XML parser to check the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   777
# syntax of the XML files.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   778
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   779
XML_SCHEMA             = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   780
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   781
# The XML_DTD tag can be used to specify an XML DTD, 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   782
# which can be used by a validating XML parser to check the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   783
# syntax of the XML files.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   784
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   785
XML_DTD                = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   786
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   787
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   788
# configuration options for the AutoGen Definitions output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   789
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   790
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   791
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   792
# generate an AutoGen Definitions (see autogen.sf.net) file 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   793
# that captures the structure of the code including all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   794
# documentation. Note that this feature is still experimental 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   795
# and incomplete at the moment.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   796
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   797
GENERATE_AUTOGEN_DEF   = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   798
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   799
#---------------------------------------------------------------------------
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   800
# configuration options related to the Perl module output
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   801
#---------------------------------------------------------------------------
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   802
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   803
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   804
# generate a Perl module file that captures the structure of 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   805
# the code including all documentation. Note that this 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   806
# feature is still experimental and incomplete at the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   807
# moment.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   808
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   809
GENERATE_PERLMOD       = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   810
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   811
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   812
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   813
# to generate PDF and DVI output from the Perl module output.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   814
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   815
PERLMOD_LATEX          = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   816
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   817
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   818
# nicely formatted so it can be parsed by a human reader.  This is useful 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   819
# if you want to understand what is going on.  On the other hand, if this 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   820
# tag is set to NO the size of the Perl module output will be much smaller 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   821
# and Perl will parse it just the same.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   822
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   823
PERLMOD_PRETTY         = YES
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   824
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   825
# The names of the make variables in the generated doxyrules.make file 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   826
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   827
# This is useful so different doxyrules.make files included by the same 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   828
# Makefile don't overwrite each other's variables.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   829
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   830
PERLMOD_MAKEVAR_PREFIX = 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   831
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   832
#---------------------------------------------------------------------------
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   833
# Configuration options related to the preprocessor   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   834
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   835
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   836
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   837
# evaluate all C-preprocessor directives found in the sources and include 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   838
# files.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   839
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   840
ENABLE_PREPROCESSING   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   841
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   842
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   843
# names in the source code. If set to NO (the default) only conditional 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   844
# compilation will be performed. Macro expansion can be done in a controlled 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   845
# way by setting EXPAND_ONLY_PREDEF to YES.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   846
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   847
MACRO_EXPANSION        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   848
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   849
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   850
# then the macro expansion is limited to the macros specified with the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   851
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   852
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   853
EXPAND_ONLY_PREDEF     = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   854
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   855
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   856
# in the INCLUDE_PATH (see below) will be search if a #include is found.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   857
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   858
SEARCH_INCLUDES        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   859
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   860
# The INCLUDE_PATH tag can be used to specify one or more directories that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   861
# contain include files that are not input files but should be processed by 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   862
# the preprocessor.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   863
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   864
INCLUDE_PATH           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   865
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   866
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   867
# patterns (like *.h and *.hpp) to filter out the header-files in the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   868
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   869
# be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   870
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   871
INCLUDE_FILE_PATTERNS  = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   872
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   873
# The PREDEFINED tag can be used to specify one or more macro names that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   874
# are defined before the preprocessor is started (similar to the -D option of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   875
# gcc). The argument of the tag is a list of macros of the form: name 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   876
# or name=definition (no spaces). If the definition and the = are 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   877
# omitted =1 is assumed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   878
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   879
PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
1271
28530ae4d9d1 Make Doxygen ignore PHYSFS_DEPRECATED.
Ryan C. Gordon <icculus@icculus.org>
parents: 1154
diff changeset
   880
                         PHYSFS_DECL= \
28530ae4d9d1 Make Doxygen ignore PHYSFS_DEPRECATED.
Ryan C. Gordon <icculus@icculus.org>
parents: 1154
diff changeset
   881
                         PHYSFS_DEPRECATED=
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   882
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   883
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   884
# this tag can be used to specify a list of macro names that should be expanded. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   885
# The macro definition that is found in the sources will be used. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   886
# Use the PREDEFINED tag if you want to use a different macro definition.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   887
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   888
EXPAND_AS_DEFINED      = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   889
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   890
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   891
# doxygen's preprocessor will remove all function-like macros that are alone 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   892
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   893
# function macros are typically used for boiler-plate code, and will confuse the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   894
# parser if not removed.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   895
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   896
SKIP_FUNCTION_MACROS   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   897
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   898
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   899
# Configuration::addtions related to external references   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   900
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   901
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   902
# The TAGFILES option can be used to specify one or more tagfiles. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   903
# Optionally an initial location of the external documentation 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   904
# can be added for each tagfile. The format of a tag file without 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   905
# this location is as follows: 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   906
#   TAGFILES = file1 file2 ... 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   907
# Adding location for the tag files is done as follows: 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   908
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   909
# where "loc1" and "loc2" can be relative or absolute paths or 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   910
# URLs. If a location is present for each tag, the installdox tool 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   911
# does not have to be run to correct the links.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   912
# Note that each tag file must have a unique name
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   913
# (where the name does NOT include the path)
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   914
# If a tag file is not located in the directory in which doxygen 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   915
# is run, you must also specify the path to the tagfile here.
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   916
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   917
TAGFILES               = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   918
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   919
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   920
# a tag file that is based on the input files it reads.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   921
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   922
GENERATE_TAGFILE       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   923
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   924
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   925
# in the class index. If set to NO only the inherited external classes 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   926
# will be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   927
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   928
ALLEXTERNALS           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   929
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   930
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   931
# in the modules index. If set to NO, only the current project's groups will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   932
# be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   933
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   934
EXTERNAL_GROUPS        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   935
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   936
# The PERL_PATH should be the absolute path and name of the perl script 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   937
# interpreter (i.e. the result of `which perl').
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   938
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   939
PERL_PATH              = /usr/bin/perl
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   940
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   941
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   942
# Configuration options related to the dot tool   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   943
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   944
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   945
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   946
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   947
# super classes. Setting the tag to NO turns the diagrams off. Note that this 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   948
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   949
# recommended to install and use dot, since it yields more powerful graphs.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   950
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   951
CLASS_DIAGRAMS         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   952
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   953
# If set to YES, the inheritance and collaboration graphs will hide 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   954
# inheritance and usage relations if the target is undocumented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   955
# or is not a class.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   956
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   957
HIDE_UNDOC_RELATIONS   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   958
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   959
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   960
# available from the path. This tool is part of Graphviz, a graph visualization 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   961
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   962
# have no effect if this option is set to NO (the default)
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   963
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   964
HAVE_DOT               = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   965
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   966
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   967
# will generate a graph for each documented class showing the direct and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   968
# indirect inheritance relations. Setting this tag to YES will force the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   969
# the CLASS_DIAGRAMS tag to NO.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   970
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   971
CLASS_GRAPH            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   972
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   973
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   974
# will generate a graph for each documented class showing the direct and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   975
# indirect implementation dependencies (inheritance, containment, and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   976
# class references variables) of the class with other documented classes.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   977
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   978
COLLABORATION_GRAPH    = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   979
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   980
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   981
# collaboration diagrams in a style similiar to the OMG's Unified Modeling 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   982
# Language.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   983
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   984
UML_LOOK               = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
   985
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   986
# If set to YES, the inheritance and collaboration graphs will show the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   987
# relations between templates and their instances.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   988
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   989
TEMPLATE_RELATIONS     = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   990
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   991
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   992
# tags are set to YES then doxygen will generate a graph for each documented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   993
# file showing the direct and indirect include dependencies of the file with 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   994
# other documented files.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   995
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   996
INCLUDE_GRAPH          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   997
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   998
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   999
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1000
# documented header file showing the documented files that directly or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1001
# indirectly include this file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1002
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1003
INCLUDED_BY_GRAPH      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1004
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1005
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1006
# generate a call dependency graph for every global function or class method. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1007
# Note that enabling this option will significantly increase the time of a run. 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1008
# So in most cases it will be better to enable call graphs for selected 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1009
# functions only using the \callgraph command.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1010
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1011
CALL_GRAPH             = NO
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1012
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1013
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1014
# will graphical hierarchy of all classes instead of a textual one.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1015
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1016
GRAPHICAL_HIERARCHY    = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1017
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1018
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1019
# generated by dot. Possible values are png, jpg, or gif
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1020
# If left blank png will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1021
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1022
DOT_IMAGE_FORMAT       = png
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1023
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1024
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1025
# found. If left blank, it is assumed the dot tool can be found on the path.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1026
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1027
DOT_PATH               = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1028
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1029
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1030
# contain dot files that are included in the documentation (see the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1031
# \dotfile command).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1032
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1033
DOTFILE_DIRS           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1034
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1035
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1036
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1037
# this value, doxygen will try to truncate the graph, so that it fits within 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1038
# the specified constraint. Beware that most browsers cannot cope with very 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1039
# large images.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1040
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1041
MAX_DOT_GRAPH_WIDTH    = 1024
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1042
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1043
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1044
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1045
# this value, doxygen will try to truncate the graph, so that it fits within 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1046
# the specified constraint. Beware that most browsers cannot cope with very 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1047
# large images.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1048
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1049
MAX_DOT_GRAPH_HEIGHT   = 1024
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1050
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1051
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1052
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1053
# from the root by following a path via at most 3 edges will be shown. Nodes that 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1054
# lay further from the root node will be omitted. Note that setting this option to 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1055
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1056
# note that a graph may be further truncated if the graph's image dimensions are 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1057
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1058
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1059
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1060
MAX_DOT_GRAPH_DEPTH    = 0
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1061
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1062
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1063
# generate a legend page explaining the meaning of the various boxes and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1064
# arrows in the dot generated graphs.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1065
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1066
GENERATE_LEGEND        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1067
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1068
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
625
60b5f566a258 Last minute changes, fixes, and build system updates for 1.0.
Ryan C. Gordon <icculus@icculus.org>
parents: 588
diff changeset
  1069
# remove the intermediate dot files that are used to generate 
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1070
# the various graphs.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1071
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1072
DOT_CLEANUP            = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1073
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1074
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1075
# Configuration::addtions related to the search engine   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1076
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1077
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1078
# The SEARCHENGINE tag specifies whether or not a search engine should be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1079
# used. If set to NO the values of all tags below this one will be ignored.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1080
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
  1081
SEARCHENGINE           = NO