Doxyfile

   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 #---------------------------------------------------------------------------
   9 # Project related configuration options
  10 #---------------------------------------------------------------------------
  11 PROJECT_NAME           = OpenTTD
  12 OUTPUT_DIRECTORY       = docs/source/
  13 CREATE_SUBDIRS         = NO
  14 OUTPUT_LANGUAGE        = English
  15 BRIEF_MEMBER_DESC      = YES
  16 REPEAT_BRIEF           = YES
  17 ABBREVIATE_BRIEF       = "The $name class" \
  18                          "The $name widget" \
  19                          "The $name file" \
  20                          is \
  21                          provides \
  22                          specifies \
  23                          contains \
  24                          represents \
  25                          a \
  26                          an \
  27                          the
  28 ALWAYS_DETAILED_SEC    = NO
  29 INLINE_INHERITED_MEMB  = NO
  30 FULL_PATH_NAMES        = YES
  31 STRIP_FROM_PATH        = ./
  32 STRIP_FROM_INC_PATH    =
  33 SHORT_NAMES            = NO
  34 JAVADOC_AUTOBRIEF      = YES
  35 MULTILINE_CPP_IS_BRIEF = NO
  36 INHERIT_DOCS           = YES
  37 DISTRIBUTE_GROUP_DOC   = NO
  38 TAB_SIZE               = 2
  39 ALIASES                =
  40 OPTIMIZE_OUTPUT_FOR_C  = YES
  41 OPTIMIZE_OUTPUT_JAVA   = NO
  42 SUBGROUPING            = YES
  43 #---------------------------------------------------------------------------
  44 # Build related configuration options
  45 #---------------------------------------------------------------------------
  46 EXTRACT_ALL            = NO
  47 EXTRACT_PRIVATE        = YES
  48 EXTRACT_STATIC         = YES
  49 EXTRACT_LOCAL_CLASSES  = YES
  50 EXTRACT_LOCAL_METHODS  = YES
  51 HIDE_UNDOC_MEMBERS     = NO
  52 HIDE_UNDOC_CLASSES     = NO
  53 HIDE_FRIEND_COMPOUNDS  = NO
  54 HIDE_IN_BODY_DOCS      = NO
  55 INTERNAL_DOCS          = NO
  56 CASE_SENSE_NAMES       = YES
  57 HIDE_SCOPE_NAMES       = NO
  58 SHOW_INCLUDE_FILES     = YES
  59 INLINE_INFO            = YES
  60 SORT_MEMBER_DOCS       = YES
  61 SORT_BRIEF_DOCS        = NO
  62 SORT_BY_SCOPE_NAME     = NO
  63 GENERATE_TODOLIST      = YES
  64 GENERATE_TESTLIST      = YES
  65 GENERATE_BUGLIST       = YES
  66 GENERATE_DEPRECATEDLIST= YES
  67 ENABLED_SECTIONS       =
  68 MAX_INITIALIZER_LINES  = 30
  69 SHOW_USED_FILES        = YES
  70 SHOW_DIRECTORIES       = YES
  71 FILE_VERSION_FILTER    =
  72 #---------------------------------------------------------------------------
  73 # configuration options related to warning and progress messages
  74 #---------------------------------------------------------------------------
  75 QUIET                  = NO
  76 WARNINGS               = YES
  77 WARN_IF_UNDOCUMENTED   = YES
  78 WARN_IF_DOC_ERROR      = YES
  79 WARN_NO_PARAMDOC       = NO
  80 WARN_FORMAT            = "$file:$line: $text"
  81 WARN_LOGFILE           =
  82 #---------------------------------------------------------------------------
  83 # configuration options related to the input files
  84 #---------------------------------------------------------------------------
  85 INPUT                  = ./src/
  86 FILE_PATTERNS          = *.c \
  87                          *.cc \
  88                          *.cxx \
  89                          *.cpp \
  90                          *.c++ \
  91                          *.h \
  92                          *.hpp
  93 RECURSIVE              = YES
  94 EXCLUDE                =
  95 EXCLUDE_SYMLINKS       = NO
  96 EXCLUDE_PATTERNS       = */3rdparty */.svn */script/api
  97 EXAMPLE_PATH           =
  98 EXAMPLE_PATTERNS       = *
  99 EXAMPLE_RECURSIVE      = NO
 100 IMAGE_PATH             =./docs/
 101 INPUT_FILTER           =
 102 FILTER_PATTERNS        =
 103 FILTER_SOURCE_FILES    = NO
 104 #---------------------------------------------------------------------------
 105 # configuration options related to source browsing
 106 #---------------------------------------------------------------------------
 107 SOURCE_BROWSER         = YES
 108 INLINE_SOURCES         = NO
 109 STRIP_CODE_COMMENTS    = YES
 110 REFERENCED_BY_RELATION = YES
 111 REFERENCES_RELATION    = YES
 112 VERBATIM_HEADERS       = YES
 113 #---------------------------------------------------------------------------
 114 # configuration options related to the alphabetical class index
 115 #---------------------------------------------------------------------------
 116 ALPHABETICAL_INDEX     = NO
 117 COLS_IN_ALPHA_INDEX    = 5
 118 IGNORE_PREFIX          =
 119 #---------------------------------------------------------------------------
 120 # configuration options related to the HTML output
 121 #---------------------------------------------------------------------------
 122 GENERATE_HTML          = YES
 123 HTML_OUTPUT            = html
 124 HTML_FILE_EXTENSION    = .html
 125 HTML_HEADER            =
 126 HTML_FOOTER            =
 127 HTML_STYLESHEET        =
 128 HTML_ALIGN_MEMBERS     = YES
 129 GENERATE_HTMLHELP      = YES
 130 CHM_FILE               =
 131 HHC_LOCATION           =
 132 GENERATE_CHI           = NO
 133 BINARY_TOC             = NO
 134 TOC_EXPAND             = YES
 135 DISABLE_INDEX          = NO
 136 ENUM_VALUES_PER_LINE   = 4
 137 GENERATE_TREEVIEW      = YES
 138 TREEVIEW_WIDTH         = 250
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the LaTeX output
 141 #---------------------------------------------------------------------------
 142 GENERATE_LATEX         = NO
 143 LATEX_OUTPUT           = latex
 144 LATEX_CMD_NAME         = latex
 145 MAKEINDEX_CMD_NAME     = makeindex
 146 COMPACT_LATEX          = NO
 147 PAPER_TYPE             = a4wide
 148 EXTRA_PACKAGES         =
 149 LATEX_HEADER           =
 150 PDF_HYPERLINKS         = NO
 151 USE_PDFLATEX           = NO
 152 LATEX_BATCHMODE        = NO
 153 LATEX_HIDE_INDICES     = NO
 154 #---------------------------------------------------------------------------
 155 # configuration options related to the RTF output
 156 #---------------------------------------------------------------------------
 157 GENERATE_RTF           = NO
 158 RTF_OUTPUT             = rtf
 159 COMPACT_RTF            = NO
 160 RTF_HYPERLINKS         = NO
 161 RTF_STYLESHEET_FILE    =
 162 RTF_EXTENSIONS_FILE    =
 163 #---------------------------------------------------------------------------
 164 # configuration options related to the man page output
 165 #---------------------------------------------------------------------------
 166 GENERATE_MAN           = NO
 167 MAN_OUTPUT             = man
 168 MAN_EXTENSION          = .3
 169 MAN_LINKS              = NO
 170 #---------------------------------------------------------------------------
 171 # configuration options related to the XML output
 172 #---------------------------------------------------------------------------
 173 GENERATE_XML           = NO
 174 XML_OUTPUT             = xml
 175 XML_SCHEMA             =
 176 XML_DTD                =
 177 XML_PROGRAMLISTING     = YES
 178 #---------------------------------------------------------------------------
 179 # configuration options for the AutoGen Definitions output
 180 #---------------------------------------------------------------------------
 181 GENERATE_AUTOGEN_DEF   = NO
 182 #---------------------------------------------------------------------------
 183 # configuration options related to the Perl module output
 184 #---------------------------------------------------------------------------
 185 GENERATE_PERLMOD       = NO
 186 PERLMOD_LATEX          = NO
 187 PERLMOD_PRETTY         = YES
 188 PERLMOD_MAKEVAR_PREFIX =
 189 #---------------------------------------------------------------------------
 190 # Configuration options related to the preprocessor
 191 #---------------------------------------------------------------------------
 192 ENABLE_PREPROCESSING   = YES
 193 MACRO_EXPANSION        = YES
 194 EXPAND_ONLY_PREDEF     = YES
 195 SEARCH_INCLUDES        = YES
 196 INCLUDE_PATH           =
 197 INCLUDE_FILE_PATTERNS  =
 198 PREDEFINED             = ENABLE_NETWORK WITH_ZLIB WITH_LZO WITH_LZMA WITH_SDL WITH_PNG WITH_FONTCONFIG WITH_FREETYPE WITH_ICU_SORT WITH_ICU_LAYOUT UNICODE _UNICODE _GNU_SOURCE FINAL=
 199 EXPAND_AS_DEFINED      =
 200 SKIP_FUNCTION_MACROS   = YES
 201 #---------------------------------------------------------------------------
 202 # Configuration::additions related to external references
 203 #---------------------------------------------------------------------------
 204 TAGFILES               =
 205 GENERATE_TAGFILE       = objs/openttd.tag
 206 ALLEXTERNALS           = NO
 207 EXTERNAL_GROUPS        = YES
 208 PERL_PATH              = /usr/bin/perl
 209 #---------------------------------------------------------------------------
 210 # Configuration options related to the dot tool
 211 #---------------------------------------------------------------------------
 212 CLASS_DIAGRAMS         = YES
 213 HIDE_UNDOC_RELATIONS   = YES
 214 HAVE_DOT               = NO
 215 CLASS_GRAPH            = YES
 216 COLLABORATION_GRAPH    = YES
 217 GROUP_GRAPHS           = YES
 218 UML_LOOK               = NO
 219 TEMPLATE_RELATIONS     = NO
 220 INCLUDE_GRAPH          = YES
 221 INCLUDED_BY_GRAPH      = YES
 222 CALL_GRAPH             = NO
 223 GRAPHICAL_HIERARCHY    = YES
 224 DIRECTORY_GRAPH        = YES
 225 DOT_IMAGE_FORMAT       = png
 226 DOT_PATH               =
 227 DOTFILE_DIRS           =
 228 MAX_DOT_GRAPH_DEPTH    = 1000
 229 DOT_TRANSPARENT        = NO
 230 DOT_MULTI_TARGETS      = NO
 231 GENERATE_LEGEND        = YES
 232 DOT_CLEANUP            = YES
 233 #---------------------------------------------------------------------------
 234 # Configuration::additions related to the search engine
 235 #---------------------------------------------------------------------------
 236 SEARCHENGINE           = NO