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