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