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