| blob | 71ed743b375dedd41d06c5c0d9fa67e90cf37fcb |
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 AI API"
13 PROJECT_NUMBER = ${REV_VERSION}
14 PROJECT_BRIEF =
15 PROJECT_LOGO =
16 OUTPUT_DIRECTORY = ${CPACK_BINARY_DIR}/docs/ai-api/
17 CREATE_SUBDIRS = NO
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 = 5
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 = NO
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 = NO
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 = YES
86 INTERNAL_DOCS = YES
87 CASE_SENSE_NAMES = YES
88 HIDE_SCOPE_NAMES = NO
89 HIDE_COMPOUND_REFERENCE= NO
90 SHOW_HEADERFILE = YES
91 SHOW_INCLUDE_FILES = NO
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 = YES
99 SORT_BY_SCOPE_NAME = NO
100 STRICT_PROTO_MATCHING = NO
101 GENERATE_TODOLIST = NO
102 GENERATE_TESTLIST = NO
103 GENERATE_BUGLIST = NO
104 GENERATE_DEPRECATEDLIST= NO
105 ENABLED_SECTIONS =
106 MAX_INITIALIZER_LINES = 30
107 SHOW_USED_FILES = NO
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 = YES
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 = . \
130 ${FIND_VERSION_BINARY_DIR}/script/api
131 INPUT_ENCODING = UTF-8
132 FILE_PATTERNS = script_*.hpp \
133 ai_*.hpp
134 RECURSIVE = YES
135 EXCLUDE =
136 EXCLUDE_SYMLINKS = NO
137 EXCLUDE_PATTERNS = ai_includes.hpp
138 EXCLUDE_SYMBOLS = GetClassName \
139 DECLARE_ENUM_AS_BIT_SET \
140 DECLARE_POSTFIX_INCREMENT
141 EXAMPLE_PATH =
142 EXAMPLE_PATTERNS = *
143 EXAMPLE_RECURSIVE = NO
144 IMAGE_PATH =
145 INPUT_FILTER = "./doxygen_filter.sh AI"
146 FILTER_PATTERNS =
147 FILTER_SOURCE_FILES = NO
148 FILTER_SOURCE_PATTERNS =
149 USE_MDFILE_AS_MAINPAGE =
150 #---------------------------------------------------------------------------
151 # Configuration options related to source browsing
152 #---------------------------------------------------------------------------
153 SOURCE_BROWSER = NO
154 INLINE_SOURCES = NO
155 STRIP_CODE_COMMENTS = YES
156 REFERENCED_BY_RELATION = NO
157 REFERENCES_RELATION = NO
158 REFERENCES_LINK_SOURCE = YES
159 SOURCE_TOOLTIPS = YES
160 USE_HTAGS = NO
161 VERBATIM_HEADERS = NO
162 CLANG_ASSISTED_PARSING = NO
163 CLANG_ADD_INC_PATHS = YES
164 CLANG_OPTIONS =
165 CLANG_DATABASE_PATH =
166 #---------------------------------------------------------------------------
167 # Configuration options related to the alphabetical class index
168 #---------------------------------------------------------------------------
169 ALPHABETICAL_INDEX = NO
170 IGNORE_PREFIX =
171 #---------------------------------------------------------------------------
172 # Configuration options related to the HTML output
173 #---------------------------------------------------------------------------
174 GENERATE_HTML = YES
175 HTML_OUTPUT = html
176 HTML_FILE_EXTENSION = .html
177 HTML_HEADER =
178 HTML_FOOTER =
179 HTML_STYLESHEET =
180 HTML_EXTRA_STYLESHEET =
181 HTML_EXTRA_FILES =
182 HTML_COLORSTYLE_HUE = 220
183 HTML_COLORSTYLE_SAT = 100
184 HTML_COLORSTYLE_GAMMA = 80
185 HTML_TIMESTAMP = NO
186 HTML_DYNAMIC_MENUS = YES
187 HTML_DYNAMIC_SECTIONS = NO
188 HTML_INDEX_NUM_ENTRIES = 100
189 GENERATE_DOCSET = NO
190 DOCSET_FEEDNAME = "Doxygen generated docs"
191 DOCSET_FEEDURL =
192 DOCSET_BUNDLE_ID = org.doxygen.Project
193 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
194 DOCSET_PUBLISHER_NAME = Publisher
195 GENERATE_HTMLHELP = NO
196 CHM_FILE =
197 HHC_LOCATION =
198 GENERATE_CHI = NO
199 CHM_INDEX_ENCODING =
200 BINARY_TOC = NO
201 TOC_EXPAND = NO
202 GENERATE_QHP = NO
203 QCH_FILE =
204 QHP_NAMESPACE = org.doxygen.Project
205 QHP_VIRTUAL_FOLDER = doc
206 QHP_CUST_FILTER_NAME =
207 QHP_CUST_FILTER_ATTRS =
208 QHP_SECT_FILTER_ATTRS =
209 QHG_LOCATION =
210 GENERATE_ECLIPSEHELP = NO
211 ECLIPSE_DOC_ID = org.doxygen.Project
212 DISABLE_INDEX = NO
213 GENERATE_TREEVIEW = NO
214 FULL_SIDEBAR = NO
215 ENUM_VALUES_PER_LINE = 1
216 TREEVIEW_WIDTH = 250
217 EXT_LINKS_IN_WINDOW = NO
218 OBFUSCATE_EMAILS = YES
219 HTML_FORMULA_FORMAT = png
220 FORMULA_FONTSIZE = 10
221 FORMULA_TRANSPARENT = YES
222 FORMULA_MACROFILE =
223 USE_MATHJAX = NO
224 MATHJAX_VERSION = MathJax_2
225 MATHJAX_FORMAT = HTML-CSS
226 MATHJAX_RELPATH =
227 MATHJAX_EXTENSIONS =
228 MATHJAX_CODEFILE =
229 SEARCHENGINE = NO
230 SERVER_BASED_SEARCH = NO
231 EXTERNAL_SEARCH = NO
232 SEARCHENGINE_URL =
233 SEARCHDATA_FILE = searchdata.xml
234 EXTERNAL_SEARCH_ID =
235 EXTRA_SEARCH_MAPPINGS =
236 #---------------------------------------------------------------------------
237 # Configuration options related to the LaTeX output
238 #---------------------------------------------------------------------------
239 GENERATE_LATEX = NO
240 LATEX_OUTPUT = latex
241 LATEX_CMD_NAME = latex
242 MAKEINDEX_CMD_NAME = makeindex
243 LATEX_MAKEINDEX_CMD = makeindex
244 COMPACT_LATEX = NO
245 PAPER_TYPE = a4
246 EXTRA_PACKAGES =
247 LATEX_HEADER =
248 LATEX_FOOTER =
249 LATEX_EXTRA_STYLESHEET =
250 LATEX_EXTRA_FILES =
251 PDF_HYPERLINKS = NO
252 USE_PDFLATEX = NO
253 LATEX_BATCHMODE = NO
254 LATEX_HIDE_INDICES = NO
255 LATEX_BIB_STYLE = plain
256 LATEX_TIMESTAMP = NO
257 LATEX_EMOJI_DIRECTORY =
258 #---------------------------------------------------------------------------
259 # Configuration options related to the RTF output
260 #---------------------------------------------------------------------------
261 GENERATE_RTF = NO
262 RTF_OUTPUT = rtf
263 COMPACT_RTF = NO
264 RTF_HYPERLINKS = NO
265 RTF_STYLESHEET_FILE =
266 RTF_EXTENSIONS_FILE =
267 #---------------------------------------------------------------------------
268 # Configuration options related to the man page output
269 #---------------------------------------------------------------------------
270 GENERATE_MAN = NO
271 MAN_OUTPUT = man
272 MAN_EXTENSION = .3
273 MAN_SUBDIR =
274 MAN_LINKS = NO
275 #---------------------------------------------------------------------------
276 # Configuration options related to the XML output
277 #---------------------------------------------------------------------------
278 GENERATE_XML = NO
279 XML_OUTPUT = xml
280 XML_PROGRAMLISTING = YES
281 XML_NS_MEMB_FILE_SCOPE = NO
282 #---------------------------------------------------------------------------
283 # Configuration options related to the DOCBOOK output
284 #---------------------------------------------------------------------------
285 GENERATE_DOCBOOK = NO
286 DOCBOOK_OUTPUT = docbook
287 #---------------------------------------------------------------------------
288 # Configuration options for the AutoGen Definitions output
289 #---------------------------------------------------------------------------
290 GENERATE_AUTOGEN_DEF = NO
291 #---------------------------------------------------------------------------
292 # Configuration options related to the Perl module output
293 #---------------------------------------------------------------------------
294 GENERATE_PERLMOD = NO
295 PERLMOD_LATEX = NO
296 PERLMOD_PRETTY = YES
297 PERLMOD_MAKEVAR_PREFIX =
298 #---------------------------------------------------------------------------
299 # Configuration options related to the preprocessor
300 #---------------------------------------------------------------------------
301 ENABLE_PREPROCESSING = YES
302 MACRO_EXPANSION = YES
303 EXPAND_ONLY_PREDEF = YES
304 SEARCH_INCLUDES = YES
305 INCLUDE_PATH =
306 INCLUDE_FILE_PATTERNS =
307 PREDEFINED = DOXYGEN_API
308 EXPAND_AS_DEFINED = DEF_COMMAND
309 SKIP_FUNCTION_MACROS = YES
310 #---------------------------------------------------------------------------
311 # Configuration options related to external references
312 #---------------------------------------------------------------------------
313 TAGFILES =
314 GENERATE_TAGFILE = ${CPACK_BINARY_DIR}/docs/openttd_ai_api.tag
315 ALLEXTERNALS = NO
316 EXTERNAL_GROUPS = YES
317 EXTERNAL_PAGES = YES
318 #---------------------------------------------------------------------------
319 # Configuration options related to the dot tool
320 #---------------------------------------------------------------------------
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 DOT_UML_DETAILS = NO
334 DOT_WRAP_THRESHOLD = 17
335 TEMPLATE_RELATIONS = NO
336 INCLUDE_GRAPH = YES
337 INCLUDED_BY_GRAPH = YES
338 CALL_GRAPH = NO
339 CALLER_GRAPH = NO
340 GRAPHICAL_HIERARCHY = YES
341 DIRECTORY_GRAPH = YES
342 DIR_GRAPH_MAX_DEPTH = 1
343 DOT_IMAGE_FORMAT = png
344 INTERACTIVE_SVG = NO
345 DOT_PATH =
346 DOTFILE_DIRS =
347 MSCFILE_DIRS =
348 DIAFILE_DIRS =
349 PLANTUML_JAR_PATH =
350 PLANTUML_CFG_FILE =
351 PLANTUML_INCLUDE_PATH =
352 DOT_GRAPH_MAX_NODES = 50
353 MAX_DOT_GRAPH_DEPTH = 1000
354 DOT_TRANSPARENT = NO
355 DOT_MULTI_TARGETS = NO
356 GENERATE_LEGEND = NO
357 DOT_CLEANUP = YES