Doxyfile.in

   1 # This file is part of OpenTTD.
   2 # 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.
   3 # 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.
   4 # 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/>.
   5
   6 #---------------------------------------------------------------------------
   7 # Project related configuration options
   8 #---------------------------------------------------------------------------
   9 DOXYFILE_ENCODING      = UTF-8
  10 PROJECT_NAME           = "OpenTTD Source"
  11 PROJECT_NUMBER         = ${REV_VERSION}
  12 PROJECT_BRIEF          =
  13 PROJECT_LOGO           =
  14 OUTPUT_DIRECTORY       = ${CPACK_BINARY_DIR}/docs/source/
  15 CREATE_SUBDIRS         = YES
  16 ALLOW_UNICODE_NAMES    = NO
  17 OUTPUT_LANGUAGE        = English
  18 BRIEF_MEMBER_DESC      = YES
  19 REPEAT_BRIEF           = YES
  20 ABBREVIATE_BRIEF       = "The $name class" \
  21                          "The $name widget" \
  22                          "The $name file" \
  23                          is \
  24                          provides \
  25                          specifies \
  26                          contains \
  27                          represents \
  28                          a \
  29                          an \
  30                          the
  31 ALWAYS_DETAILED_SEC    = NO
  32 INLINE_INHERITED_MEMB  = NO
  33 FULL_PATH_NAMES        = YES
  34 STRIP_FROM_PATH        = ./
  35 STRIP_FROM_INC_PATH    =
  36 SHORT_NAMES            = NO
  37 JAVADOC_AUTOBRIEF      = YES
  38 QT_AUTOBRIEF           = NO
  39 MULTILINE_CPP_IS_BRIEF = NO
  40 INHERIT_DOCS           = YES
  41 SEPARATE_MEMBER_PAGES  = NO
  42 TAB_SIZE               = 2
  43 ALIASES                =
  44 OPTIMIZE_OUTPUT_FOR_C  = YES
  45 OPTIMIZE_OUTPUT_JAVA   = NO
  46 OPTIMIZE_FOR_FORTRAN   = NO
  47 OPTIMIZE_OUTPUT_VHDL   = NO
  48 EXTENSION_MAPPING      =
  49 MARKDOWN_SUPPORT       = YES
  50 TOC_INCLUDE_HEADINGS   = 0
  51 AUTOLINK_SUPPORT       = YES
  52 BUILTIN_STL_SUPPORT    = NO
  53 CPP_CLI_SUPPORT        = NO
  54 SIP_SUPPORT            = NO
  55 IDL_PROPERTY_SUPPORT   = YES
  56 DISTRIBUTE_GROUP_DOC   = NO
  57 GROUP_NESTED_COMPOUNDS = NO
  58 SUBGROUPING            = YES
  59 INLINE_GROUPED_CLASSES = NO
  60 INLINE_SIMPLE_STRUCTS  = NO
  61 TYPEDEF_HIDES_STRUCT   = NO
  62 LOOKUP_CACHE_SIZE      = 0
  63 #---------------------------------------------------------------------------
  64 # Build related configuration options
  65 #---------------------------------------------------------------------------
  66 EXTRACT_ALL            = NO
  67 EXTRACT_PRIVATE        = YES
  68 EXTRACT_PACKAGE        = NO
  69 EXTRACT_STATIC         = YES
  70 EXTRACT_LOCAL_CLASSES  = YES
  71 EXTRACT_LOCAL_METHODS  = YES
  72 EXTRACT_ANON_NSPACES   = YES
  73 HIDE_UNDOC_MEMBERS     = NO
  74 HIDE_UNDOC_CLASSES     = NO
  75 HIDE_FRIEND_COMPOUNDS  = NO
  76 HIDE_IN_BODY_DOCS      = NO
  77 INTERNAL_DOCS          = NO
  78 CASE_SENSE_NAMES       = YES
  79 HIDE_SCOPE_NAMES       = NO
  80 HIDE_COMPOUND_REFERENCE= NO
  81 SHOW_INCLUDE_FILES     = YES
  82 SHOW_GROUPED_MEMB_INC  = NO
  83 FORCE_LOCAL_INCLUDES   = NO
  84 INLINE_INFO            = YES
  85 SORT_MEMBER_DOCS       = YES
  86 SORT_BRIEF_DOCS        = NO
  87 SORT_MEMBERS_CTORS_1ST = NO
  88 SORT_GROUP_NAMES       = NO
  89 SORT_BY_SCOPE_NAME     = NO
  90 STRICT_PROTO_MATCHING  = NO
  91 GENERATE_TODOLIST      = YES
  92 GENERATE_TESTLIST      = YES
  93 GENERATE_BUGLIST       = YES
  94 GENERATE_DEPRECATEDLIST= YES
  95 ENABLED_SECTIONS       =
  96 MAX_INITIALIZER_LINES  = 30
  97 SHOW_USED_FILES        = YES
  98 SHOW_FILES             = YES
  99 SHOW_NAMESPACES        = YES
 100 FILE_VERSION_FILTER    =
 101 LAYOUT_FILE            =
 102 CITE_BIB_FILES         =
 103 #---------------------------------------------------------------------------
 104 # Configuration options related to warning and progress messages
 105 #---------------------------------------------------------------------------
 106 QUIET                  = NO
 107 WARNINGS               = YES
 108 WARN_IF_UNDOCUMENTED   = YES
 109 WARN_IF_DOC_ERROR      = YES
 110 WARN_NO_PARAMDOC       = NO
 111 WARN_AS_ERROR          = NO
 112 WARN_FORMAT            = "$file:$line: $text"
 113 WARN_LOGFILE           =
 114 #---------------------------------------------------------------------------
 115 # Configuration options related to the input files
 116 #---------------------------------------------------------------------------
 117 INPUT                  = ./src/
 118 INPUT_ENCODING         = UTF-8
 119 FILE_PATTERNS          = *.c \
 120                          *.cc \
 121                          *.cxx \
 122                          *.cpp \
 123                          *.c++ \
 124                          *.h \
 125                          *.hpp
 126 RECURSIVE              = YES
 127 EXCLUDE                =
 128 EXCLUDE_SYMLINKS       = NO
 129 EXCLUDE_PATTERNS       = */3rdparty \
 130                          */script/api
 131 EXCLUDE_SYMBOLS        =
 132 EXAMPLE_PATH           =
 133 EXAMPLE_PATTERNS       = *
 134 EXAMPLE_RECURSIVE      = NO
 135 IMAGE_PATH             = ./docs/
 136 INPUT_FILTER           =
 137 FILTER_PATTERNS        =
 138 FILTER_SOURCE_FILES    = NO
 139 FILTER_SOURCE_PATTERNS =
 140 USE_MDFILE_AS_MAINPAGE =
 141 #---------------------------------------------------------------------------
 142 # Configuration options related to source browsing
 143 #---------------------------------------------------------------------------
 144 SOURCE_BROWSER         = YES
 145 INLINE_SOURCES         = NO
 146 STRIP_CODE_COMMENTS    = YES
 147 REFERENCED_BY_RELATION = YES
 148 REFERENCES_RELATION    = YES
 149 REFERENCES_LINK_SOURCE = YES
 150 SOURCE_TOOLTIPS        = YES
 151 USE_HTAGS              = NO
 152 VERBATIM_HEADERS       = YES
 153 #---------------------------------------------------------------------------
 154 # Configuration options related to the alphabetical class index
 155 #---------------------------------------------------------------------------
 156 ALPHABETICAL_INDEX     = NO
 157 IGNORE_PREFIX          =
 158 #---------------------------------------------------------------------------
 159 # Configuration options related to the HTML output
 160 #---------------------------------------------------------------------------
 161 GENERATE_HTML          = YES
 162 HTML_OUTPUT            = html
 163 HTML_FILE_EXTENSION    = .html
 164 HTML_HEADER            =
 165 HTML_FOOTER            =
 166 HTML_STYLESHEET        =
 167 HTML_EXTRA_STYLESHEET  =
 168 HTML_EXTRA_FILES       =
 169 HTML_COLORSTYLE_HUE    = 220
 170 HTML_COLORSTYLE_SAT    = 100
 171 HTML_COLORSTYLE_GAMMA  = 80
 172 HTML_TIMESTAMP         = NO
 173 HTML_DYNAMIC_MENUS     = YES
 174 HTML_DYNAMIC_SECTIONS  = NO
 175 HTML_INDEX_NUM_ENTRIES = 100
 176 GENERATE_DOCSET        = NO
 177 DOCSET_FEEDNAME        = "Doxygen generated docs"
 178 DOCSET_BUNDLE_ID       = org.doxygen.Project
 179 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 180 DOCSET_PUBLISHER_NAME  = Publisher
 181 GENERATE_HTMLHELP      = NO
 182 CHM_FILE               =
 183 HHC_LOCATION           =
 184 GENERATE_CHI           = NO
 185 CHM_INDEX_ENCODING     =
 186 BINARY_TOC             = NO
 187 TOC_EXPAND             = YES
 188 GENERATE_QHP           = NO
 189 QCH_FILE               =
 190 QHP_NAMESPACE          = org.doxygen.Project
 191 QHP_VIRTUAL_FOLDER     = doc
 192 QHP_CUST_FILTER_NAME   =
 193 QHP_CUST_FILTER_ATTRS  =
 194 QHP_SECT_FILTER_ATTRS  =
 195 QHG_LOCATION           =
 196 GENERATE_ECLIPSEHELP   = NO
 197 ECLIPSE_DOC_ID         = org.doxygen.Project
 198 DISABLE_INDEX          = NO
 199 GENERATE_TREEVIEW      = YES
 200 ENUM_VALUES_PER_LINE   = 4
 201 TREEVIEW_WIDTH         = 250
 202 EXT_LINKS_IN_WINDOW    = NO
 203 FORMULA_FONTSIZE       = 10
 204 FORMULA_TRANSPARENT    = YES
 205 USE_MATHJAX            = NO
 206 MATHJAX_FORMAT         = HTML-CSS
 207 MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/
 208 MATHJAX_EXTENSIONS     =
 209 MATHJAX_CODEFILE       =
 210 SEARCHENGINE           = NO
 211 SERVER_BASED_SEARCH    = NO
 212 EXTERNAL_SEARCH        = NO
 213 SEARCHENGINE_URL       =
 214 SEARCHDATA_FILE        = searchdata.xml
 215 EXTERNAL_SEARCH_ID     =
 216 EXTRA_SEARCH_MAPPINGS  =
 217 #---------------------------------------------------------------------------
 218 # Configuration options related to the LaTeX output
 219 #---------------------------------------------------------------------------
 220 GENERATE_LATEX         = NO
 221 LATEX_OUTPUT           = latex
 222 LATEX_CMD_NAME         = latex
 223 MAKEINDEX_CMD_NAME     = makeindex
 224 COMPACT_LATEX          = NO
 225 PAPER_TYPE             = a4
 226 EXTRA_PACKAGES         =
 227 LATEX_HEADER           =
 228 LATEX_FOOTER           =
 229 LATEX_EXTRA_STYLESHEET =
 230 LATEX_EXTRA_FILES      =
 231 PDF_HYPERLINKS         = NO
 232 USE_PDFLATEX           = NO
 233 LATEX_BATCHMODE        = NO
 234 LATEX_HIDE_INDICES     = NO
 235 LATEX_SOURCE_CODE      = NO
 236 LATEX_BIB_STYLE        = plain
 237 LATEX_TIMESTAMP        = NO
 238 #---------------------------------------------------------------------------
 239 # Configuration options related to the RTF output
 240 #---------------------------------------------------------------------------
 241 GENERATE_RTF           = NO
 242 RTF_OUTPUT             = rtf
 243 COMPACT_RTF            = NO
 244 RTF_HYPERLINKS         = NO
 245 RTF_STYLESHEET_FILE    =
 246 RTF_EXTENSIONS_FILE    =
 247 RTF_SOURCE_CODE        = NO
 248 #---------------------------------------------------------------------------
 249 # Configuration options related to the man page output
 250 #---------------------------------------------------------------------------
 251 GENERATE_MAN           = NO
 252 MAN_OUTPUT             = man
 253 MAN_EXTENSION          = .3
 254 MAN_SUBDIR             =
 255 MAN_LINKS              = NO
 256 #---------------------------------------------------------------------------
 257 # Configuration options related to the XML output
 258 #---------------------------------------------------------------------------
 259 GENERATE_XML           = NO
 260 XML_OUTPUT             = xml
 261 XML_PROGRAMLISTING     = YES
 262 #---------------------------------------------------------------------------
 263 # Configuration options related to the DOCBOOK output
 264 #---------------------------------------------------------------------------
 265 GENERATE_DOCBOOK       = NO
 266 DOCBOOK_OUTPUT         = docbook
 267 DOCBOOK_PROGRAMLISTING = NO
 268 #---------------------------------------------------------------------------
 269 # Configuration options for the AutoGen Definitions output
 270 #---------------------------------------------------------------------------
 271 GENERATE_AUTOGEN_DEF   = NO
 272 #---------------------------------------------------------------------------
 273 # Configuration options related to the Perl module output
 274 #---------------------------------------------------------------------------
 275 GENERATE_PERLMOD       = NO
 276 PERLMOD_LATEX          = NO
 277 PERLMOD_PRETTY         = YES
 278 PERLMOD_MAKEVAR_PREFIX =
 279 #---------------------------------------------------------------------------
 280 # Configuration options related to the preprocessor
 281 #---------------------------------------------------------------------------
 282 ENABLE_PREPROCESSING   = YES
 283 MACRO_EXPANSION        = YES
 284 EXPAND_ONLY_PREDEF     = YES
 285 SEARCH_INCLUDES        = YES
 286 INCLUDE_PATH           =
 287 INCLUDE_FILE_PATTERNS  =
 288 PREDEFINED             = WITH_ZLIB \
 289                          WITH_LZO \
 290                          WITH_LIBLZMA \
 291                          WITH_SDL \
 292                          WITH_PNG \
 293                          WITH_FONTCONFIG \
 294                          WITH_FREETYPE \
 295                          WITH_HARFBUZZ \
 296                          WITH_ICU_I18N \
 297                          UNICODE \
 298                          _UNICODE \
 299                          _GNU_SOURCE \
 300                          FINAL=
 301 EXPAND_AS_DEFINED      =
 302 SKIP_FUNCTION_MACROS   = YES
 303 #---------------------------------------------------------------------------
 304 # Configuration options related to external references
 305 #---------------------------------------------------------------------------
 306 TAGFILES               =
 307 GENERATE_TAGFILE       = ${CPACK_BINARY_DIR}/docs/openttd.tag
 308 ALLEXTERNALS           = NO
 309 EXTERNAL_GROUPS        = YES
 310 EXTERNAL_PAGES         = YES
 311 #---------------------------------------------------------------------------
 312 # Configuration options related to the dot tool
 313 #---------------------------------------------------------------------------
 314 CLASS_DIAGRAMS         = YES
 315 DIA_PATH               =
 316 HIDE_UNDOC_RELATIONS   = YES
 317 HAVE_DOT               = NO
 318 DOT_NUM_THREADS        = 0
 319 DOT_FONTNAME           = Helvetica
 320 DOT_FONTSIZE           = 10
 321 DOT_FONTPATH           =
 322 CLASS_GRAPH            = YES
 323 COLLABORATION_GRAPH    = YES
 324 GROUP_GRAPHS           = YES
 325 UML_LOOK               = NO
 326 UML_LIMIT_NUM_FIELDS   = 10
 327 TEMPLATE_RELATIONS     = NO
 328 INCLUDE_GRAPH          = YES
 329 INCLUDED_BY_GRAPH      = YES
 330 CALL_GRAPH             = NO
 331 CALLER_GRAPH           = NO
 332 GRAPHICAL_HIERARCHY    = YES
 333 DIRECTORY_GRAPH        = YES
 334 DOT_IMAGE_FORMAT       = png
 335 INTERACTIVE_SVG        = NO
 336 DOT_PATH               =
 337 DOTFILE_DIRS           =
 338 MSCFILE_DIRS           =
 339 DIAFILE_DIRS           =
 340 PLANTUML_JAR_PATH      =
 341 PLANTUML_CFG_FILE      =
 342 PLANTUML_INCLUDE_PATH  =
 343 DOT_GRAPH_MAX_NODES    = 50
 344 MAX_DOT_GRAPH_DEPTH    = 1000
 345 DOT_TRANSPARENT        = NO
 346 DOT_MULTI_TARGETS      = NO
 347 GENERATE_LEGEND        = YES
 348 DOT_CLEANUP            = YES