src/script/api/Doxyfile_Game

   1 # $Id$
   2
   3 # This file is part of OpenTTD.
   4 # OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   5 # OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   6 # See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   7
   8 # Doxyfile 1.5.4
   9
  10 #---------------------------------------------------------------------------
  11 # Project related configuration options
  12 #---------------------------------------------------------------------------
  13 DOXYFILE_ENCODING      = UTF-8
  14 PROJECT_NAME           = "OpenTTD Game API"
  15 PROJECT_NUMBER         =
  16 OUTPUT_DIRECTORY       = ../../../docs/gamedocs/
  17 CREATE_SUBDIRS         = NO
  18 OUTPUT_LANGUAGE        = English
  19 BRIEF_MEMBER_DESC      = YES
  20 REPEAT_BRIEF           = YES
  21 ABBREVIATE_BRIEF       = "The $name class " \
  22                          "The $name widget " \
  23                          "The $name file " \
  24                          is \
  25                          provides \
  26                          specifies \
  27                          contains \
  28                          represents \
  29                          a \
  30                          an \
  31                          the
  32 ALWAYS_DETAILED_SEC    = NO
  33 INLINE_INHERITED_MEMB  = NO
  34 FULL_PATH_NAMES        = YES
  35 STRIP_FROM_PATH        = ./
  36 STRIP_FROM_INC_PATH    =
  37 SHORT_NAMES            = NO
  38 JAVADOC_AUTOBRIEF      = YES
  39 QT_AUTOBRIEF           = NO
  40 MULTILINE_CPP_IS_BRIEF = NO
  41 INHERIT_DOCS           = YES
  42 SEPARATE_MEMBER_PAGES  = NO
  43 TAB_SIZE               = 2
  44 ALIASES                =
  45 OPTIMIZE_OUTPUT_FOR_C  = YES
  46 OPTIMIZE_OUTPUT_JAVA   = NO
  47 BUILTIN_STL_SUPPORT    = NO
  48 CPP_CLI_SUPPORT        = NO
  49 SIP_SUPPORT            = NO
  50 DISTRIBUTE_GROUP_DOC   = NO
  51 SUBGROUPING            = YES
  52 TYPEDEF_HIDES_STRUCT   = NO
  53 #---------------------------------------------------------------------------
  54 # Build related configuration options
  55 #---------------------------------------------------------------------------
  56 EXTRACT_ALL            = NO
  57 EXTRACT_PRIVATE        = NO
  58 EXTRACT_STATIC         = YES
  59 EXTRACT_LOCAL_CLASSES  = YES
  60 EXTRACT_LOCAL_METHODS  = YES
  61 EXTRACT_ANON_NSPACES   = NO
  62 HIDE_UNDOC_MEMBERS     = NO
  63 HIDE_UNDOC_CLASSES     = NO
  64 HIDE_FRIEND_COMPOUNDS  = NO
  65 HIDE_IN_BODY_DOCS      = YES
  66 INTERNAL_DOCS          = YES
  67 CASE_SENSE_NAMES       = YES
  68 HIDE_SCOPE_NAMES       = NO
  69 SHOW_INCLUDE_FILES     = NO
  70 INLINE_INFO            = YES
  71 SORT_MEMBER_DOCS       = YES
  72 SORT_BRIEF_DOCS        = NO
  73 SORT_BY_SCOPE_NAME     = NO
  74 GENERATE_TODOLIST      = NO
  75 GENERATE_TESTLIST      = NO
  76 GENERATE_BUGLIST       = NO
  77 GENERATE_DEPRECATEDLIST= NO
  78 ENABLED_SECTIONS       =
  79 MAX_INITIALIZER_LINES  = 30
  80 SHOW_USED_FILES        = NO
  81 SHOW_DIRECTORIES       = NO
  82 FILE_VERSION_FILTER    =
  83 #---------------------------------------------------------------------------
  84 # configuration options related to warning and progress messages
  85 #---------------------------------------------------------------------------
  86 QUIET                  = NO
  87 WARNINGS               = YES
  88 WARN_IF_UNDOCUMENTED   = YES
  89 WARN_IF_DOC_ERROR      = YES
  90 WARN_NO_PARAMDOC       = YES
  91 WARN_FORMAT            = "$file:$line: $text "
  92 WARN_LOGFILE           =
  93 #---------------------------------------------------------------------------
  94 # configuration options related to the input files
  95 #---------------------------------------------------------------------------
  96 INPUT                  = .
  97 INPUT_ENCODING         = UTF-8
  98 FILE_PATTERNS          = script_*.hpp \
  99                          game_*.hpp
 100 RECURSIVE              = YES
 101 EXCLUDE                =
 102 EXCLUDE_SYMLINKS       = NO
 103 EXCLUDE_PATTERNS       =
 104 EXCLUDE_SYMBOLS        = GetClassName DECLARE_ENUM_AS_BIT_SET DECLARE_POSTFIX_INCREMENT
 105 EXAMPLE_PATH           =
 106 EXAMPLE_PATTERNS       = *
 107 EXAMPLE_RECURSIVE      = NO
 108 IMAGE_PATH             =
 109 INPUT_FILTER           = "./doxygen_filter.sh GS"
 110 FILTER_PATTERNS        =
 111 FILTER_SOURCE_FILES    = NO
 112 #---------------------------------------------------------------------------
 113 # configuration options related to source browsing
 114 #---------------------------------------------------------------------------
 115 SOURCE_BROWSER         = NO
 116 INLINE_SOURCES         = NO
 117 STRIP_CODE_COMMENTS    = YES
 118 REFERENCED_BY_RELATION = NO
 119 REFERENCES_RELATION    = NO
 120 REFERENCES_LINK_SOURCE = YES
 121 USE_HTAGS              = NO
 122 VERBATIM_HEADERS       = NO
 123 #---------------------------------------------------------------------------
 124 # configuration options related to the alphabetical class index
 125 #---------------------------------------------------------------------------
 126 ALPHABETICAL_INDEX     = NO
 127 COLS_IN_ALPHA_INDEX    = 5
 128 IGNORE_PREFIX          =
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the HTML output
 131 #---------------------------------------------------------------------------
 132 GENERATE_HTML          = YES
 133 HTML_OUTPUT            = html
 134 HTML_FILE_EXTENSION    = .html
 135 HTML_HEADER            =
 136 HTML_FOOTER            =
 137 HTML_STYLESHEET        =
 138 HTML_ALIGN_MEMBERS     = YES
 139 GENERATE_HTMLHELP      = NO
 140 HTML_DYNAMIC_SECTIONS  = NO
 141 CHM_FILE               =
 142 HHC_LOCATION           =
 143 GENERATE_CHI           = NO
 144 BINARY_TOC             = NO
 145 TOC_EXPAND             = NO
 146 DISABLE_INDEX          = NO
 147 ENUM_VALUES_PER_LINE   = 1
 148 GENERATE_TREEVIEW      = NO
 149 TREEVIEW_WIDTH         = 250
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the LaTeX output
 152 #---------------------------------------------------------------------------
 153 GENERATE_LATEX         = NO
 154 LATEX_OUTPUT           = latex
 155 LATEX_CMD_NAME         = latex
 156 MAKEINDEX_CMD_NAME     = makeindex
 157 COMPACT_LATEX          = NO
 158 PAPER_TYPE             = a4wide
 159 EXTRA_PACKAGES         =
 160 LATEX_HEADER           =
 161 PDF_HYPERLINKS         = NO
 162 USE_PDFLATEX           = NO
 163 LATEX_BATCHMODE        = NO
 164 LATEX_HIDE_INDICES     = NO
 165 #---------------------------------------------------------------------------
 166 # configuration options related to the RTF output
 167 #---------------------------------------------------------------------------
 168 GENERATE_RTF           = NO
 169 RTF_OUTPUT             = rtf
 170 COMPACT_RTF            = NO
 171 RTF_HYPERLINKS         = NO
 172 RTF_STYLESHEET_FILE    =
 173 RTF_EXTENSIONS_FILE    =
 174 #---------------------------------------------------------------------------
 175 # configuration options related to the man page output
 176 #---------------------------------------------------------------------------
 177 GENERATE_MAN           = NO
 178 MAN_OUTPUT             = man
 179 MAN_EXTENSION          = .3
 180 MAN_LINKS              = NO
 181 #---------------------------------------------------------------------------
 182 # configuration options related to the XML output
 183 #---------------------------------------------------------------------------
 184 GENERATE_XML           = NO
 185 XML_OUTPUT             = xml
 186 XML_SCHEMA             =
 187 XML_DTD                =
 188 XML_PROGRAMLISTING     = YES
 189 #---------------------------------------------------------------------------
 190 # configuration options for the AutoGen Definitions output
 191 #---------------------------------------------------------------------------
 192 GENERATE_AUTOGEN_DEF   = NO
 193 #---------------------------------------------------------------------------
 194 # configuration options related to the Perl module output
 195 #---------------------------------------------------------------------------
 196 GENERATE_PERLMOD       = NO
 197 PERLMOD_LATEX          = NO
 198 PERLMOD_PRETTY         = YES
 199 PERLMOD_MAKEVAR_PREFIX =
 200 #---------------------------------------------------------------------------
 201 # Configuration options related to the preprocessor
 202 #---------------------------------------------------------------------------
 203 ENABLE_PREPROCESSING   = YES
 204 MACRO_EXPANSION        = YES
 205 EXPAND_ONLY_PREDEF     = YES
 206 SEARCH_INCLUDES        = YES
 207 INCLUDE_PATH           =
 208 INCLUDE_FILE_PATTERNS  =
 209 PREDEFINED             = DOXYGEN_API
 210 EXPAND_AS_DEFINED      = DEF_COMMAND
 211 SKIP_FUNCTION_MACROS   = YES
 212 #---------------------------------------------------------------------------
 213 # Configuration::additions related to external references
 214 #---------------------------------------------------------------------------
 215 TAGFILES               =
 216 GENERATE_TAGFILE       = ../../../objs/openttd_nogo.tag
 217 ALLEXTERNALS           = NO
 218 EXTERNAL_GROUPS        = YES
 219 PERL_PATH              = /usr/bin/perl
 220 #---------------------------------------------------------------------------
 221 # Configuration options related to the dot tool
 222 #---------------------------------------------------------------------------
 223 CLASS_DIAGRAMS         = YES
 224 MSCGEN_PATH            =
 225 HIDE_UNDOC_RELATIONS   = YES
 226 HAVE_DOT               = NO
 227 CLASS_GRAPH            = YES
 228 COLLABORATION_GRAPH    = YES
 229 GROUP_GRAPHS           = YES
 230 UML_LOOK               = NO
 231 TEMPLATE_RELATIONS     = NO
 232 INCLUDE_GRAPH          = YES
 233 INCLUDED_BY_GRAPH      = YES
 234 CALL_GRAPH             = NO
 235 CALLER_GRAPH           = NO
 236 GRAPHICAL_HIERARCHY    = YES
 237 DIRECTORY_GRAPH        = YES
 238 DOT_IMAGE_FORMAT       = png
 239 DOT_PATH               =
 240 DOTFILE_DIRS           =
 241 DOT_GRAPH_MAX_NODES    = 50
 242 MAX_DOT_GRAPH_DEPTH    = 1000
 243 DOT_TRANSPARENT        = NO
 244 DOT_MULTI_TARGETS      = NO
 245 GENERATE_LEGEND        = NO
 246 DOT_CLEANUP            = YES
 247 #---------------------------------------------------------------------------
 248 # Configuration::additions related to the search engine
 249 #---------------------------------------------------------------------------
 250 SEARCHENGINE           = NO