Doxyfile
author Ryan C. Gordon <icculus@icculus.org>
Sun, 05 Jan 2003 01:42:13 +0000
changeset 530 0c1ddbcee8c5
parent 325 048871240924
child 588 9f398d3d84a3
permissions -rw-r--r--
Upped version to 0.1.8.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     1
# Doxyfile 1.2.16
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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    14
# General configuration options
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
530
0c1ddbcee8c5 Upped version to 0.1.8.
Ryan C. Gordon <icculus@icculus.org>
parents: 325
diff changeset
    26
PROJECT_NUMBER         = 0.1.8
264
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    27
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    29
# base path where the generated documentation will be put. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    30
# 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
    31
# 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
    32
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    33
OUTPUT_DIRECTORY       = docs
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    34
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    35
# 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
    36
# documentation generated by doxygen is written. Doxygen will use this 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    37
# information to generate all constant output in the proper language. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    38
# The default language is English, other supported languages are: 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    39
# Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    41
# Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovene, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    42
# Spanish, Swedish and Ukrainian.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    43
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    44
OUTPUT_LANGUAGE        = English
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    45
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    47
# documentation are documented, even if no documentation was available. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    48
# Private class members and static file members will be hidden unless 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    50
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    51
EXTRACT_ALL            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    52
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    54
# will be included in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    55
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    56
EXTRACT_PRIVATE        = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    57
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    58
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    59
# will be included in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    60
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    61
EXTRACT_STATIC         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    62
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    64
# defined locally in source files will be included in the documentation. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    65
# If set to NO only classes defined in header files are included.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    66
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    67
EXTRACT_LOCAL_CLASSES  = NO
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
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    70
# undocumented members of documented classes, files or namespaces. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    71
# If set to NO (the default) these members will be included in the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    72
# various overviews, but no documentation section is generated. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    73
# This option has no effect if EXTRACT_ALL is enabled.
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
HIDE_UNDOC_MEMBERS     = 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 HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    78
# undocumented classes that are normally visible in the class hierarchy. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    79
# If set to NO (the default) these class will be included in the various 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
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
HIDE_UNDOC_CLASSES     = 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 BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    85
# include brief member descriptions after the members that are listed in 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    86
# the file and class documentation (similar to JavaDoc). 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    87
# Set to NO to disable this.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    88
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    89
BRIEF_MEMBER_DESC      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    90
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    91
# 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
    92
# the brief description of a member or function before the detailed description. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    93
# 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
    94
# brief descriptions will be completely suppressed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    95
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    96
REPEAT_BRIEF           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    97
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    98
# 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
    99
# 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
   100
# description.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   101
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   102
ALWAYS_DETAILED_SEC    = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   103
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   104
# 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
   105
# 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
   106
# ordinary class members. Constructors, destructors and assignment operators of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   107
# the base classes will not be shown.
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
INLINE_INHERITED_MEMB  = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   110
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   111
# 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
   112
# 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
   113
# 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
   114
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   115
FULL_PATH_NAMES        = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   116
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   117
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   118
# can be used to strip a user defined part of the path. Stripping is 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   119
# 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
   120
# 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
   121
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   122
STRIP_FROM_PATH        = 
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
# The INTERNAL_DOCS tag determines if documentation 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   125
# that is typed after a \internal command is included. If the tag is set 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   126
# to NO (the default) then the documentation will be excluded. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   127
# Set it to YES to include the internal documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   128
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   129
INTERNAL_DOCS          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   130
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   131
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   132
# doxygen to hide any special comment blocks from generated source code 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   133
# fragments. Normal C and C++ comments will always remain visible.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   134
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   135
STRIP_CODE_COMMENTS    = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   136
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   137
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   138
# file names in lower case letters. If set to YES upper case letters are also 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   139
# allowed. This is useful if you have classes or files whose names only differ 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   140
# in case and if your file system supports case sensitive file names. Windows 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   141
# users are adviced to set this option to NO.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   142
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   143
CASE_SENSE_NAMES       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   144
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   145
# 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
   146
# (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
   147
# doesn't support long names like on DOS, Mac, or CD-ROM.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   148
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   149
SHORT_NAMES            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   150
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   151
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   152
# will show members with their full class and namespace scopes in the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   153
# documentation. If set to YES the scope will be hidden.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   154
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   155
HIDE_SCOPE_NAMES       = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   156
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   157
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   158
# will generate a verbatim copy of the header file for each class for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   159
# which an include is specified. Set to NO to disable this.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   160
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   161
VERBATIM_HEADERS       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   162
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   163
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   164
# will put list of the files that are included by a file in the documentation 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   165
# of that file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   166
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   167
SHOW_INCLUDE_FILES     = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   168
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   169
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   170
# 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
   171
# comment as the brief description. If set to NO, the JavaDoc 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   172
# comments  will behave just like the Qt-style comments (thus requiring an 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   173
# explict @brief command for a brief description.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   174
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   175
JAVADOC_AUTOBRIEF      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   176
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   177
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   178
# will output the detailed description near the top, like JavaDoc.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   179
# If set to NO, the detailed description appears after the member 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   180
# documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   181
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   182
DETAILS_AT_TOP         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   183
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   184
# 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
   185
# member inherits the documentation from any documented member that it 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   186
# reimplements.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   187
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   188
INHERIT_DOCS           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   189
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   190
# 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
   191
# is inserted in the documentation for inline members.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   192
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   193
INLINE_INFO            = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   194
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   195
# 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
   196
# will sort the (detailed) documentation of file and class members 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   197
# 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
   198
# declaration order.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   199
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   200
SORT_MEMBER_DOCS       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   201
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   202
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   203
# tag is set to YES, then doxygen will reuse the documentation of the first 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   204
# member in the group (if any) for the other members of the group. By default 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   205
# all members of a group must be documented explicitly.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   206
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   207
DISTRIBUTE_GROUP_DOC   = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   208
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   209
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   210
# Doxygen uses this value to replace tabs by spaces in code fragments.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   211
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   212
TAB_SIZE               = 4
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   213
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   214
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   215
# disable (NO) the todo list. This list is created by putting \todo 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   216
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   217
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   218
GENERATE_TODOLIST      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   219
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   220
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   221
# disable (NO) the test list. This list is created by putting \test 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   222
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   223
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   224
GENERATE_TESTLIST      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   225
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   226
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   227
# disable (NO) the bug list. This list is created by putting \bug 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   228
# commands in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   229
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   230
GENERATE_BUGLIST       = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   231
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   232
# This tag can be used to specify a number of aliases that acts 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   233
# as commands in the documentation. An alias has the form "name=value". 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   234
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   235
# put the command \sideeffect (or @sideeffect) in the documentation, which 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   236
# will result in a user defined paragraph with heading "Side Effects:". 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   237
# You can put \n's in the value part of an alias to insert newlines.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   238
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   239
ALIASES                = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   240
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   241
# The ENABLED_SECTIONS tag can be used to enable conditional 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   242
# documentation sections, marked by \if sectionname ... \endif.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   243
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   244
ENABLED_SECTIONS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   245
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   246
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   247
# the initial value of a variable or define consist of for it to appear in 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   248
# the documentation. If the initializer consists of more lines than specified 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   249
# 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
   250
# The appearance of the initializer of individual variables and defines in the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   251
# documentation can be controlled using \showinitializer or \hideinitializer 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   252
# command in the documentation regardless of this setting.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   253
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   254
MAX_INITIALIZER_LINES  = 30
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   255
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   256
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   257
# only. Doxygen will then generate output that is more tailored for C. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   258
# For instance some of the names that are used will be different. The list 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   259
# of all members will be omitted, etc.
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
OPTIMIZE_OUTPUT_FOR_C  = 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
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   264
# only. Doxygen will then generate output that is more tailored for Java. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   265
# For instance namespaces will be presented as packages, qualified scopes 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   266
# will look different, etc.
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
OPTIMIZE_OUTPUT_JAVA   = NO
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
# 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
   271
# 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
   272
# list will mention the files that were used to generate 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
SHOW_USED_FILES        = 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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   277
# configuration options related to warning and progress messages
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   278
#---------------------------------------------------------------------------
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
# 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
   281
# 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
   282
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   283
QUIET                  = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   284
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   285
# 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
   286
# generated by doxygen. Possible values are YES and NO. If left blank 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   287
# NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   288
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   289
WARNINGS               = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   290
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   291
# 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
   292
# 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
   293
# automatically be disabled.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   294
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   295
WARN_IF_UNDOCUMENTED   = YES
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
# The WARN_FORMAT tag determines the format of the warning messages that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   298
# doxygen can produce. The string should contain the $file, $line, and $text 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   299
# 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
   300
# warning originated and the warning text.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   301
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   302
WARN_FORMAT            = "$file:$line: $text"
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   303
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   304
# 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
   305
# 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
   306
# to stderr.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   307
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   308
WARN_LOGFILE           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   309
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   310
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   311
# configuration options related to the input files
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   314
# 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
   315
# documented source files. You may enter file names like "myfile.cpp" or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   316
# directories like "/usr/src/myproject". Separate the files or directories 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   317
# with spaces.
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
INPUT                  = physfs.h
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   320
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   321
# 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
   322
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   323
# 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
   324
# blank the following patterns are tested: 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   325
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   326
# *.h++ *.idl *.odl
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
FILE_PATTERNS          = 
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
# 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
   331
# 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
   332
# If left blank NO is used.
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
RECURSIVE              = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   335
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   336
# 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
   337
# 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
   338
# 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
   339
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   340
EXCLUDE                = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   341
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   342
# 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
   343
# 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
   344
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   345
EXCLUDE_SYMLINKS       = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   346
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   347
# 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
   348
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   349
# certain files from those directories.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   350
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   351
EXCLUDE_PATTERNS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   352
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   353
# 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
   354
# directories that contain example code fragments that are included (see 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   355
# the \include command).
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
EXAMPLE_PATH           = 
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
# 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
   360
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   361
# 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
   362
# blank all files are included.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   363
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   364
EXAMPLE_PATTERNS       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   365
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   366
# 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
   367
# searched for input files to be used with the \include or \dontinclude 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   368
# commands irrespective of the value of the RECURSIVE tag. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   369
# Possible values are YES and NO. If left blank NO is used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   370
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   371
EXAMPLE_RECURSIVE      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   372
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   373
# 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
   374
# directories that contain image that are included in the documentation (see 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   375
# the \image command).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   376
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   377
IMAGE_PATH             = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   378
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   379
# 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
   380
# 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
   381
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   382
# 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
   383
# 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
   384
# to standard output.
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
INPUT_FILTER           = 
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
# 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
   389
# INPUT_FILTER) will be used to filter the input files when producing source 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   390
# files to browse.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   391
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   392
FILTER_SOURCE_FILES    = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   393
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   394
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   395
# configuration options related to source browsing
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   398
# 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
   399
# be generated. Documented entities will be cross-referenced with these sources.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   400
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   401
SOURCE_BROWSER         = NO
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
# Setting the INLINE_SOURCES tag to YES will include the body 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   404
# of functions and classes directly in the documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   405
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   406
INLINE_SOURCES         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   407
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   408
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   409
# then for each documented function all documented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   410
# functions referencing it will be listed.
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
REFERENCED_BY_RELATION = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   413
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   414
# If the REFERENCES_RELATION tag is set to YES (the default) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   415
# then for each documented function all documented entities 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   416
# called/used by that function will be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   417
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   418
REFERENCES_RELATION    = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   419
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   420
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   421
# configuration options related to the alphabetical class index
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   424
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   425
# of all compounds will be generated. Enable this if the project 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   426
# contains a lot of classes, structs, unions or interfaces.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   427
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   428
ALPHABETICAL_INDEX     = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   429
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   430
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   431
# 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
   432
# 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
   433
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   434
COLS_IN_ALPHA_INDEX    = 5
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   435
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   436
# 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
   437
# classes will be put under the same header in the alphabetical index. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   438
# 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
   439
# should be ignored while generating the index headers.
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
IGNORE_PREFIX          =
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
# configuration options related to the HTML output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   445
#---------------------------------------------------------------------------
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
# 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
   448
# generate HTML output.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   449
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   450
GENERATE_HTML          = YES
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
# 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
   453
# 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
   454
# 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
   455
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   456
HTML_OUTPUT            = html
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   457
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   458
# 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
   459
# 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
   460
# doxygen will generate files with .html extension.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   461
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   462
HTML_FILE_EXTENSION    = .html
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
# 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
   465
# 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
   466
# standard header.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   467
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   468
HTML_HEADER            = 
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
# 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
   471
# 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
   472
# standard footer.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   473
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   474
HTML_FOOTER            = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   475
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   476
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   477
# 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
   478
# 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
   479
# will generate a default style sheet
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
HTML_STYLESHEET        = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   482
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   483
# 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
   484
# 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
   485
# NO a bullet list will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   486
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   487
HTML_ALIGN_MEMBERS     = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   488
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   489
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   490
# 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
   491
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   492
# of the generated HTML documentation.
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
GENERATE_HTMLHELP      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   495
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   496
# 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
   497
# controls if a separate .chi index file is generated (YES) or that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   498
# it should be included in the master .chm file (NO).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   499
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   500
GENERATE_CHI           = NO
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
# 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
   503
# controls whether a binary table of contents is generated (YES) or a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   504
# normal table of contents (NO) in the .chm file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   505
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   506
BINARY_TOC             = NO
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
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   509
# to the contents of the Html help documentation and to the tree view.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   510
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   511
TOC_EXPAND             = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   512
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   513
# 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
   514
# 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
   515
# the value YES disables it.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   516
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   517
DISABLE_INDEX          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   518
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   519
# 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
   520
# that doxygen will group on one line in the generated HTML documentation.
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
ENUM_VALUES_PER_LINE   = 4
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   523
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   524
# 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
   525
# generated containing a tree-like index structure (just like the one that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   526
# is generated for HTML Help). For this to work a browser that supports 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   527
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   528
# or Internet explorer 4.0+). Note that for large projects the tree generation 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   529
# can take a very long time. In such cases it is better to disable this feature. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   530
# Windows users are probably better off using the HTML help feature.
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
GENERATE_TREEVIEW      = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   533
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   534
# 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
   535
# 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
   536
# is shown.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   537
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   538
TREEVIEW_WIDTH         = 250
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   539
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
# configuration options related to the LaTeX output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   542
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   543
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   544
# 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
   545
# generate Latex output.
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
GENERATE_LATEX         = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   548
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   549
# 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
   550
# 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
   551
# 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
   552
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   553
LATEX_OUTPUT           = latex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   554
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   555
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   556
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   557
LATEX_CMD_NAME         = latex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   558
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   559
# 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
   560
# 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
   561
# default command name.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   562
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   563
MAKEINDEX_CMD_NAME     = makeindex
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   564
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   565
# 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
   566
# 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
   567
# save some trees in general.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   568
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   569
COMPACT_LATEX          = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   570
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   571
# 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
   572
# by the printer. Possible values are: a4, a4wide, letter, legal and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   573
# executive. If left blank a4wide will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   574
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   575
PAPER_TYPE             = a4wide
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   576
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   577
# 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
   578
# packages that should be included in the LaTeX output.
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
EXTRA_PACKAGES         = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   581
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   582
# 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
   583
# the generated latex document. The header should contain everything until 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   584
# the first chapter. If it is left blank doxygen will generate a 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   585
# 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
   586
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   587
LATEX_HEADER           = 
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
# 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
   590
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   591
# contain links (just like the HTML output) instead of page references 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   592
# This makes the output suitable for online browsing using a pdf viewer.
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
PDF_HYPERLINKS         = NO
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 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
   597
# 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
   598
# higher quality PDF documentation.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   599
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   600
USE_PDFLATEX           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   601
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   602
# 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
   603
# command to the generated LaTeX files. This will instruct LaTeX to keep 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   604
# running if errors occur, instead of asking the user for help. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   605
# This option is also used when generating formulas in HTML.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   606
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   607
LATEX_BATCHMODE        = NO
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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   610
# configuration options related to the RTF output
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   613
# 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
   614
# 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
   615
# other RTF readers or editors.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   616
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   617
GENERATE_RTF           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   618
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   619
# 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
   620
# 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
   621
# 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
   622
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   623
RTF_OUTPUT             = rtf
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   624
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   625
# 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
   626
# 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
   627
# save some trees in general.
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
COMPACT_RTF            = NO
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
# 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
   632
# will contain hyperlink fields. The RTF file will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   633
# contain links (just like the HTML output) instead of page references. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   634
# This makes the output suitable for online browsing using WORD or other 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   635
# programs which support those fields. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   636
# Note: wordpad (write) and others do not support links.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   637
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   638
RTF_HYPERLINKS         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   639
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   640
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   641
# 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
   642
# replacements, missing definitions are set to their default value.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   643
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   644
RTF_STYLESHEET_FILE    = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   645
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   646
# Set optional variables used in the generation of an rtf document. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   647
# Syntax is similar to doxygen's config file.
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
RTF_EXTENSIONS_FILE    = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   650
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
# configuration options related to the man page output
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   655
# 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
   656
# generate man pages
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   657
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   658
GENERATE_MAN           = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   659
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   660
# 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
   661
# 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
   662
# 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
   663
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   664
MAN_OUTPUT             = man
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
# The MAN_EXTENSION tag determines the extension that is added to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   667
# the generated man pages (default is the subroutine's section .3)
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   668
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   669
MAN_EXTENSION          = .3
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   670
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   671
# 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
   672
# then it will generate one additional man file for each entity 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   673
# documented in the real man page(s). These additional files 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   674
# only source the real man page, but without them the man command 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   675
# would be unable to find the correct page. The default is NO.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   676
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   677
MAN_LINKS              = YES
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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   680
# configuration options related to the XML output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   681
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   682
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   683
# If the GENERATE_XML tag is set to YES Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   684
# generate an XML file that captures the structure of 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   685
# the code including all documentation. Note that this 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   686
# feature is still experimental and incomplete at the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   687
# moment.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   688
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   689
GENERATE_XML           = NO
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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   692
# configuration options for the AutoGen Definitions output
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   693
#---------------------------------------------------------------------------
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
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   696
# generate an AutoGen Definitions (see autogen.sf.net) file 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   697
# that captures the structure of the code including all 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   698
# documentation. Note that this feature is still experimental 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   699
# and incomplete at the moment.
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
GENERATE_AUTOGEN_DEF   = NO
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
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   704
# Configuration options related to the preprocessor   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   705
#---------------------------------------------------------------------------
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
# 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
   708
# evaluate all C-preprocessor directives found in the sources and include 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   709
# files.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   710
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   711
ENABLE_PREPROCESSING   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   712
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   713
# 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
   714
# 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
   715
# compilation will be performed. Macro expansion can be done in a controlled 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   716
# way by setting EXPAND_ONLY_PREDEF to YES.
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
MACRO_EXPANSION        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   719
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   720
# 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
   721
# then the macro expansion is limited to the macros specified with the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   722
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
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
EXPAND_ONLY_PREDEF     = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   725
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   726
# 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
   727
# 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
   728
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   729
SEARCH_INCLUDES        = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   730
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   731
# 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
   732
# 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
   733
# the preprocessor.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   734
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   735
INCLUDE_PATH           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   736
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   737
# 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
   738
# 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
   739
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   740
# be used.
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
INCLUDE_FILE_PATTERNS  = 
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 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
   745
# 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
   746
# 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
   747
# or name=definition (no spaces). If the definition and the = are 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   748
# omitted =1 is assumed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   749
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   750
PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 __EXPORT__=
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   751
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   752
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   753
# 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
   754
# The macro definition that is found in the sources will be used. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   755
# 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
   756
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   757
EXPAND_AS_DEFINED      = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   758
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   759
# 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
   760
# doxygen's preprocessor will remove all function-like macros that are alone 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   761
# on a line and do not end with a semicolon. Such function macros are typically 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   762
# used for boiler-plate code, and will confuse the parser if not removed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   763
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   764
SKIP_FUNCTION_MACROS   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   765
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
# Configuration::addtions related to external references   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   768
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   769
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   770
# The TAGFILES tag can be used to specify one or more tagfiles.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   771
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   772
TAGFILES               = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   773
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   774
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   775
# a tag file that is based on the input files it reads.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   776
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   777
GENERATE_TAGFILE       = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   778
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   779
# 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
   780
# 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
   781
# will be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   782
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   783
ALLEXTERNALS           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   784
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   785
# 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
   786
# 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
   787
# be listed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   788
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   789
EXTERNAL_GROUPS        = YES
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
# 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
   792
# interpreter (i.e. the result of `which perl').
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   793
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   794
PERL_PATH              = /usr/bin/perl
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   795
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
# Configuration options related to the dot tool   
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
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   800
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   801
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   802
# 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
   803
# 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
   804
# recommended to install and use dot, since it yields more powerful graphs.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   805
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   806
CLASS_DIAGRAMS         = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   807
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   808
# If set to YES, the inheritance and collaboration graphs will hide 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   809
# inheritance and usage relations if the target is undocumented 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   810
# or is not a class.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   811
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   812
HIDE_UNDOC_RELATIONS   = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   813
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   814
# 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
   815
# 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
   816
# 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
   817
# have no effect if this option is set to NO (the default)
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   818
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   819
HAVE_DOT               = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   820
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   821
# 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
   822
# will generate a graph for each documented class showing the direct and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   823
# indirect inheritance relations. Setting this tag to YES will force the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   824
# the CLASS_DIAGRAMS tag to NO.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   825
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   826
CLASS_GRAPH            = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   827
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   828
# 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
   829
# will generate a graph for each documented class showing the direct and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   830
# indirect implementation dependencies (inheritance, containment, and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   831
# class references variables) of the class with other documented classes.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   832
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   833
COLLABORATION_GRAPH    = NO
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
# If set to YES, the inheritance and collaboration graphs will show the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   836
# relations between templates and their instances.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   837
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   838
TEMPLATE_RELATIONS     = NO
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
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   841
# 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
   842
# file showing the direct and indirect include dependencies of the file with 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   843
# other documented files.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   844
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   845
INCLUDE_GRAPH          = NO
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
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   848
# 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
   849
# documented header file showing the documented files that directly or 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   850
# indirectly include this file.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   851
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   852
INCLUDED_BY_GRAPH      = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   853
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   854
# 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
   855
# will graphical hierarchy of all classes instead of a textual one.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   856
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   857
GRAPHICAL_HIERARCHY    = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   858
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   859
# 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
   860
# generated by dot. Possible values are png, jpg, or gif
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   861
# If left blank png will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   862
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   863
DOT_IMAGE_FORMAT       = png
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   864
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   865
# 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
   866
# 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
   867
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   868
DOT_PATH               = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   869
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   870
# 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
   871
# contain dot files that are included in the documentation (see the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   872
# \dotfile command).
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   873
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   874
DOTFILE_DIRS           = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   875
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   876
# 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
   877
# (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
   878
# 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
   879
# the specified constraint. Beware that most browsers cannot cope with very 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   880
# large images.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   881
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   882
MAX_DOT_GRAPH_WIDTH    = 1024
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   883
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   884
# 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
   885
# (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
   886
# 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
   887
# the specified constraint. Beware that most browsers cannot cope with very 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   888
# large images.
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
MAX_DOT_GRAPH_HEIGHT   = 1024
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   891
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   892
# 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
   893
# generate a legend page explaining the meaning of the various boxes and 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   894
# arrows in the dot generated graphs.
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
GENERATE_LEGEND        = 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
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   899
# remove the intermedate dot files that are used to generate 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   900
# the various graphs.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   901
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   902
DOT_CLEANUP            = YES
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   903
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   904
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   905
# Configuration::addtions related to the search engine   
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   906
#---------------------------------------------------------------------------
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   907
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   908
# The SEARCHENGINE tag specifies whether or not a search engine should be 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   909
# 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
   910
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   911
SEARCHENGINE           = NO
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   912
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   913
# The CGI_NAME tag should be the name of the CGI script that 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   914
# starts the search engine (doxysearch) with the correct parameters. 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   915
# A script with this name will be generated by doxygen.
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
CGI_NAME               = search.cgi
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
# The CGI_URL tag should be the absolute URL to the directory where the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   920
# cgi binaries are located. See the documentation of your http daemon for 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   921
# details.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   922
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   923
CGI_URL                = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   924
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   925
# The DOC_URL tag should be the absolute URL to the directory where the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   926
# documentation is located. If left blank the absolute path to the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   927
# documentation, with file:// prepended to it, will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   928
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   929
DOC_URL                = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   930
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   931
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   932
# documentation is located. If left blank the directory on the local machine 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   933
# will be used.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   934
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   935
DOC_ABSPATH            = 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   936
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   937
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   938
# is installed.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   939
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   940
BIN_ABSPATH            = /usr/local/bin/
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
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   943
# documentation generated for other projects. This allows doxysearch to search 
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   944
# the documentation for these projects as well.
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   945
73699494faf9 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   946
EXT_DOC_PATHS          =