public/doxygen/SourceMod.doxyfile
author David Anderson <dvander@alliedmods.net>
Fri Feb 16 03:47:10 2007 +0000 (2007-02-16)
changeset 501 e209a7296936
parent 372 47f21574db6d
permissions -rw-r--r--
removed this potential feature, not useful enough
dvander@372
     1
# Doxyfile 1.5.1-p1
dvander@372
     2
dvander@372
     3
#---------------------------------------------------------------------------
dvander@372
     4
# Project related configuration options
dvander@372
     5
#---------------------------------------------------------------------------
dvander@372
     6
PROJECT_NAME           = "SourceMod SDK"
dvander@372
     7
PROJECT_NUMBER         = 376
dvander@372
     8
OUTPUT_DIRECTORY       = c:\temp\sm-dox
dvander@372
     9
CREATE_SUBDIRS         = NO
dvander@372
    10
OUTPUT_LANGUAGE        = English
dvander@372
    11
USE_WINDOWS_ENCODING   = YES
dvander@372
    12
BRIEF_MEMBER_DESC      = YES
dvander@372
    13
REPEAT_BRIEF           = YES
dvander@372
    14
ABBREVIATE_BRIEF       = "The $name class" \
dvander@372
    15
                         "The $name widget" \
dvander@372
    16
                         "The $name file" \
dvander@372
    17
                         is \
dvander@372
    18
                         provides \
dvander@372
    19
                         specifies \
dvander@372
    20
                         contains \
dvander@372
    21
                         represents \
dvander@372
    22
                         a \
dvander@372
    23
                         an \
dvander@372
    24
                         the
dvander@372
    25
ALWAYS_DETAILED_SEC    = NO
dvander@372
    26
INLINE_INHERITED_MEMB  = NO
dvander@372
    27
FULL_PATH_NAMES        = YES
dvander@372
    28
STRIP_FROM_PATH        = r:\sourcemod\
dvander@372
    29
STRIP_FROM_INC_PATH    = 
dvander@372
    30
SHORT_NAMES            = NO
dvander@372
    31
JAVADOC_AUTOBRIEF      = NO
dvander@372
    32
MULTILINE_CPP_IS_BRIEF = NO
dvander@372
    33
DETAILS_AT_TOP         = NO
dvander@372
    34
INHERIT_DOCS           = YES
dvander@372
    35
SEPARATE_MEMBER_PAGES  = NO
dvander@372
    36
TAB_SIZE               = 10
dvander@372
    37
ALIASES                = 
dvander@372
    38
OPTIMIZE_OUTPUT_FOR_C  = NO
dvander@372
    39
OPTIMIZE_OUTPUT_JAVA   = NO
dvander@372
    40
BUILTIN_STL_SUPPORT    = NO
dvander@372
    41
DISTRIBUTE_GROUP_DOC   = NO
dvander@372
    42
SUBGROUPING            = YES
dvander@372
    43
#---------------------------------------------------------------------------
dvander@372
    44
# Build related configuration options
dvander@372
    45
#---------------------------------------------------------------------------
dvander@372
    46
EXTRACT_ALL            = NO
dvander@372
    47
EXTRACT_PRIVATE        = NO
dvander@372
    48
EXTRACT_STATIC         = NO
dvander@372
    49
EXTRACT_LOCAL_CLASSES  = YES
dvander@372
    50
EXTRACT_LOCAL_METHODS  = NO
dvander@372
    51
HIDE_UNDOC_MEMBERS     = YES
dvander@372
    52
HIDE_UNDOC_CLASSES     = YES
dvander@372
    53
HIDE_FRIEND_COMPOUNDS  = NO
dvander@372
    54
HIDE_IN_BODY_DOCS      = NO
dvander@372
    55
INTERNAL_DOCS          = NO
dvander@372
    56
CASE_SENSE_NAMES       = NO
dvander@372
    57
HIDE_SCOPE_NAMES       = NO
dvander@372
    58
SHOW_INCLUDE_FILES     = YES
dvander@372
    59
INLINE_INFO            = YES
dvander@372
    60
SORT_MEMBER_DOCS       = NO
dvander@372
    61
SORT_BRIEF_DOCS        = NO
dvander@372
    62
SORT_BY_SCOPE_NAME     = NO
dvander@372
    63
GENERATE_TODOLIST      = YES
dvander@372
    64
GENERATE_TESTLIST      = YES
dvander@372
    65
GENERATE_BUGLIST       = YES
dvander@372
    66
GENERATE_DEPRECATEDLIST= YES
dvander@372
    67
ENABLED_SECTIONS       = 
dvander@372
    68
MAX_INITIALIZER_LINES  = 30
dvander@372
    69
SHOW_USED_FILES        = YES
dvander@372
    70
SHOW_DIRECTORIES       = NO
dvander@372
    71
FILE_VERSION_FILTER    = 
dvander@372
    72
#---------------------------------------------------------------------------
dvander@372
    73
# configuration options related to warning and progress messages
dvander@372
    74
#---------------------------------------------------------------------------
dvander@372
    75
QUIET                  = NO
dvander@372
    76
WARNINGS               = YES
dvander@372
    77
WARN_IF_UNDOCUMENTED   = YES
dvander@372
    78
WARN_IF_DOC_ERROR      = YES
dvander@372
    79
WARN_NO_PARAMDOC       = NO
dvander@372
    80
WARN_FORMAT            = "$file:$line: $text"
dvander@372
    81
WARN_LOGFILE           = 
dvander@372
    82
#---------------------------------------------------------------------------
dvander@372
    83
# configuration options related to the input files
dvander@372
    84
#---------------------------------------------------------------------------
dvander@372
    85
INPUT                  = r:\sourcemod\trunk\public
dvander@372
    86
FILE_PATTERNS          = *.c \
dvander@372
    87
                         *.cc \
dvander@372
    88
                         *.cxx \
dvander@372
    89
                         *.cpp \
dvander@372
    90
                         *.c++ \
dvander@372
    91
                         *.d \
dvander@372
    92
                         *.java \
dvander@372
    93
                         *.ii \
dvander@372
    94
                         *.ixx \
dvander@372
    95
                         *.ipp \
dvander@372
    96
                         *.i++ \
dvander@372
    97
                         *.inl \
dvander@372
    98
                         *.h \
dvander@372
    99
                         *.hh \
dvander@372
   100
                         *.hxx \
dvander@372
   101
                         *.hpp \
dvander@372
   102
                         *.h++ \
dvander@372
   103
                         *.idl \
dvander@372
   104
                         *.odl \
dvander@372
   105
                         *.cs \
dvander@372
   106
                         *.php \
dvander@372
   107
                         *.php3 \
dvander@372
   108
                         *.inc \
dvander@372
   109
                         *.m \
dvander@372
   110
                         *.mm \
dvander@372
   111
                         *.dox \
dvander@372
   112
                         *.py
dvander@372
   113
RECURSIVE              = YES
dvander@372
   114
EXCLUDE                = 
dvander@372
   115
EXCLUDE_SYMLINKS       = NO
dvander@372
   116
EXCLUDE_PATTERNS       = 
dvander@372
   117
EXAMPLE_PATH           = 
dvander@372
   118
EXAMPLE_PATTERNS       = *
dvander@372
   119
EXAMPLE_RECURSIVE      = NO
dvander@372
   120
IMAGE_PATH             = 
dvander@372
   121
INPUT_FILTER           = 
dvander@372
   122
FILTER_PATTERNS        = 
dvander@372
   123
FILTER_SOURCE_FILES    = NO
dvander@372
   124
#---------------------------------------------------------------------------
dvander@372
   125
# configuration options related to source browsing
dvander@372
   126
#---------------------------------------------------------------------------
dvander@372
   127
SOURCE_BROWSER         = YES
dvander@372
   128
INLINE_SOURCES         = NO
dvander@372
   129
STRIP_CODE_COMMENTS    = NO
dvander@372
   130
REFERENCED_BY_RELATION = NO
dvander@372
   131
REFERENCES_RELATION    = NO
dvander@372
   132
REFERENCES_LINK_SOURCE = YES
dvander@372
   133
USE_HTAGS              = NO
dvander@372
   134
VERBATIM_HEADERS       = NO
dvander@372
   135
#---------------------------------------------------------------------------
dvander@372
   136
# configuration options related to the alphabetical class index
dvander@372
   137
#---------------------------------------------------------------------------
dvander@372
   138
ALPHABETICAL_INDEX     = NO
dvander@372
   139
COLS_IN_ALPHA_INDEX    = 5
dvander@372
   140
IGNORE_PREFIX          = 
dvander@372
   141
#---------------------------------------------------------------------------
dvander@372
   142
# configuration options related to the HTML output
dvander@372
   143
#---------------------------------------------------------------------------
dvander@372
   144
GENERATE_HTML          = YES
dvander@372
   145
HTML_OUTPUT            = html
dvander@372
   146
HTML_FILE_EXTENSION    = .html
dvander@372
   147
HTML_HEADER            = 
dvander@372
   148
HTML_FOOTER            = 
dvander@372
   149
HTML_STYLESHEET        = 
dvander@372
   150
HTML_ALIGN_MEMBERS     = YES
dvander@372
   151
GENERATE_HTMLHELP      = YES
dvander@372
   152
CHM_FILE               = SourceMod-SDK.chm
dvander@372
   153
HHC_LOCATION           = C:/temp/sm-dox/html/index.hhc
dvander@372
   154
GENERATE_CHI           = NO
dvander@372
   155
BINARY_TOC             = YES
dvander@372
   156
TOC_EXPAND             = YES
dvander@372
   157
DISABLE_INDEX          = NO
dvander@372
   158
ENUM_VALUES_PER_LINE   = 4
dvander@372
   159
GENERATE_TREEVIEW      = YES
dvander@372
   160
TREEVIEW_WIDTH         = 250
dvander@372
   161
#---------------------------------------------------------------------------
dvander@372
   162
# configuration options related to the LaTeX output
dvander@372
   163
#---------------------------------------------------------------------------
dvander@372
   164
GENERATE_LATEX         = NO
dvander@372
   165
LATEX_OUTPUT           = latex
dvander@372
   166
LATEX_CMD_NAME         = latex
dvander@372
   167
MAKEINDEX_CMD_NAME     = makeindex
dvander@372
   168
COMPACT_LATEX          = NO
dvander@372
   169
PAPER_TYPE             = a4wide
dvander@372
   170
EXTRA_PACKAGES         = 
dvander@372
   171
LATEX_HEADER           = 
dvander@372
   172
PDF_HYPERLINKS         = NO
dvander@372
   173
USE_PDFLATEX           = NO
dvander@372
   174
LATEX_BATCHMODE        = NO
dvander@372
   175
LATEX_HIDE_INDICES     = NO
dvander@372
   176
#---------------------------------------------------------------------------
dvander@372
   177
# configuration options related to the RTF output
dvander@372
   178
#---------------------------------------------------------------------------
dvander@372
   179
GENERATE_RTF           = NO
dvander@372
   180
RTF_OUTPUT             = rtf
dvander@372
   181
COMPACT_RTF            = NO
dvander@372
   182
RTF_HYPERLINKS         = NO
dvander@372
   183
RTF_STYLESHEET_FILE    = 
dvander@372
   184
RTF_EXTENSIONS_FILE    = 
dvander@372
   185
#---------------------------------------------------------------------------
dvander@372
   186
# configuration options related to the man page output
dvander@372
   187
#---------------------------------------------------------------------------
dvander@372
   188
GENERATE_MAN           = NO
dvander@372
   189
MAN_OUTPUT             = man
dvander@372
   190
MAN_EXTENSION          = .3
dvander@372
   191
MAN_LINKS              = NO
dvander@372
   192
#---------------------------------------------------------------------------
dvander@372
   193
# configuration options related to the XML output
dvander@372
   194
#---------------------------------------------------------------------------
dvander@372
   195
GENERATE_XML           = NO
dvander@372
   196
XML_OUTPUT             = xml
dvander@372
   197
XML_SCHEMA             = 
dvander@372
   198
XML_DTD                = 
dvander@372
   199
XML_PROGRAMLISTING     = YES
dvander@372
   200
#---------------------------------------------------------------------------
dvander@372
   201
# configuration options for the AutoGen Definitions output
dvander@372
   202
#---------------------------------------------------------------------------
dvander@372
   203
GENERATE_AUTOGEN_DEF   = NO
dvander@372
   204
#---------------------------------------------------------------------------
dvander@372
   205
# configuration options related to the Perl module output
dvander@372
   206
#---------------------------------------------------------------------------
dvander@372
   207
GENERATE_PERLMOD       = NO
dvander@372
   208
PERLMOD_LATEX          = NO
dvander@372
   209
PERLMOD_PRETTY         = YES
dvander@372
   210
PERLMOD_MAKEVAR_PREFIX = 
dvander@372
   211
#---------------------------------------------------------------------------
dvander@372
   212
# Configuration options related to the preprocessor   
dvander@372
   213
#---------------------------------------------------------------------------
dvander@372
   214
ENABLE_PREPROCESSING   = YES
dvander@372
   215
MACRO_EXPANSION        = NO
dvander@372
   216
EXPAND_ONLY_PREDEF     = NO
dvander@372
   217
SEARCH_INCLUDES        = YES
dvander@372
   218
INCLUDE_PATH           = 
dvander@372
   219
INCLUDE_FILE_PATTERNS  = 
dvander@372
   220
PREDEFINED             = SOURCEMOD_BUILD \
dvander@372
   221
                         SMEXT_CONF_METAMOD
dvander@372
   222
EXPAND_AS_DEFINED      = 
dvander@372
   223
SKIP_FUNCTION_MACROS   = YES
dvander@372
   224
#---------------------------------------------------------------------------
dvander@372
   225
# Configuration::additions related to external references   
dvander@372
   226
#---------------------------------------------------------------------------
dvander@372
   227
TAGFILES               = 
dvander@372
   228
GENERATE_TAGFILE       = 
dvander@372
   229
ALLEXTERNALS           = NO
dvander@372
   230
EXTERNAL_GROUPS        = YES
dvander@372
   231
PERL_PATH              = /usr/bin/perl
dvander@372
   232
#---------------------------------------------------------------------------
dvander@372
   233
# Configuration options related to the dot tool   
dvander@372
   234
#---------------------------------------------------------------------------
dvander@372
   235
CLASS_DIAGRAMS         = NO
dvander@372
   236
HIDE_UNDOC_RELATIONS   = YES
dvander@372
   237
HAVE_DOT               = YES
dvander@372
   238
CLASS_GRAPH            = YES
dvander@372
   239
COLLABORATION_GRAPH    = YES
dvander@372
   240
GROUP_GRAPHS           = YES
dvander@372
   241
UML_LOOK               = NO
dvander@372
   242
TEMPLATE_RELATIONS     = YES
dvander@372
   243
INCLUDE_GRAPH          = YES
dvander@372
   244
INCLUDED_BY_GRAPH      = YES
dvander@372
   245
CALL_GRAPH             = NO
dvander@372
   246
CALLER_GRAPH           = NO
dvander@372
   247
GRAPHICAL_HIERARCHY    = YES
dvander@372
   248
DIRECTORY_GRAPH        = YES
dvander@372
   249
DOT_IMAGE_FORMAT       = png
dvander@372
   250
DOT_PATH               = "C:/Program Files/ATT/Graphviz/bin"
dvander@372
   251
DOTFILE_DIRS           = 
dvander@372
   252
MAX_DOT_GRAPH_WIDTH    = 1024
dvander@372
   253
MAX_DOT_GRAPH_HEIGHT   = 1024
dvander@372
   254
MAX_DOT_GRAPH_DEPTH    = 1000
dvander@372
   255
DOT_TRANSPARENT        = NO
dvander@372
   256
DOT_MULTI_TARGETS      = NO
dvander@372
   257
GENERATE_LEGEND        = YES
dvander@372
   258
DOT_CLEANUP            = YES
dvander@372
   259
#---------------------------------------------------------------------------
dvander@372
   260
# Configuration::additions related to the search engine   
dvander@372
   261
#---------------------------------------------------------------------------
dvander@372
   262
SEARCHENGINE           = YES