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/>.
8 #---------------------------------------------------------------------------
9 # Project related configuration options
10 #---------------------------------------------------------------------------
11 DOXYFILE_ENCODING = UTF-8
12 PROJECT_NAME = "OpenTTD AI API"
13 PROJECT_NUMBER = ${REV_VERSION}
14 OUTPUT_DIRECTORY = ${CPACK_BINARY_DIR}/docs/ai-api/
16 OUTPUT_LANGUAGE = English
17 BRIEF_MEMBER_DESC = YES
19 ABBREVIATE_BRIEF = "The $name class " \
30 ALWAYS_DETAILED_SEC = NO
31 INLINE_INHERITED_MEMB = NO
36 JAVADOC_AUTOBRIEF = YES
38 MULTILINE_CPP_IS_BRIEF = NO
40 SEPARATE_MEMBER_PAGES = NO
43 OPTIMIZE_OUTPUT_FOR_C = YES
44 OPTIMIZE_OUTPUT_JAVA = NO
45 BUILTIN_STL_SUPPORT = NO
48 DISTRIBUTE_GROUP_DOC = NO
50 TYPEDEF_HIDES_STRUCT = NO
51 #---------------------------------------------------------------------------
52 # Build related configuration options
53 #---------------------------------------------------------------------------
57 EXTRACT_LOCAL_CLASSES = YES
58 EXTRACT_LOCAL_METHODS = YES
59 EXTRACT_ANON_NSPACES = NO
60 HIDE_UNDOC_MEMBERS = NO
61 HIDE_UNDOC_CLASSES = NO
62 HIDE_FRIEND_COMPOUNDS = NO
63 HIDE_IN_BODY_DOCS = YES
65 CASE_SENSE_NAMES = YES
67 SHOW_INCLUDE_FILES = NO
69 SORT_MEMBER_DOCS = YES
71 SORT_BY_SCOPE_NAME = NO
72 GENERATE_TODOLIST = NO
73 GENERATE_TESTLIST = NO
75 GENERATE_DEPRECATEDLIST= NO
77 MAX_INITIALIZER_LINES = 30
80 #---------------------------------------------------------------------------
81 # configuration options related to warning and progress messages
82 #---------------------------------------------------------------------------
85 WARN_IF_UNDOCUMENTED = YES
86 WARN_IF_DOC_ERROR = YES
87 WARN_NO_PARAMDOC = YES
88 WARN_FORMAT = "$file:$line: $text "
90 #---------------------------------------------------------------------------
91 # configuration options related to the input files
92 #---------------------------------------------------------------------------
93 INPUT = . ${FIND_VERSION_BINARY_DIR}/script/api
94 INPUT_ENCODING = UTF-8
95 FILE_PATTERNS = script_*.hpp \
100 EXCLUDE_PATTERNS = ai_includes.hpp
101 EXCLUDE_SYMBOLS = GetClassName DECLARE_ENUM_AS_BIT_SET DECLARE_POSTFIX_INCREMENT
104 EXAMPLE_RECURSIVE = NO
106 INPUT_FILTER = "./doxygen_filter.sh AI"
108 FILTER_SOURCE_FILES = NO
109 #---------------------------------------------------------------------------
110 # configuration options related to source browsing
111 #---------------------------------------------------------------------------
114 STRIP_CODE_COMMENTS = YES
115 REFERENCED_BY_RELATION = NO
116 REFERENCES_RELATION = NO
117 REFERENCES_LINK_SOURCE = YES
119 VERBATIM_HEADERS = NO
120 #---------------------------------------------------------------------------
121 # configuration options related to the alphabetical class index
122 #---------------------------------------------------------------------------
123 ALPHABETICAL_INDEX = NO
125 #---------------------------------------------------------------------------
126 # configuration options related to the HTML output
127 #---------------------------------------------------------------------------
130 HTML_FILE_EXTENSION = .html
134 GENERATE_HTMLHELP = NO
135 HTML_DYNAMIC_SECTIONS = NO
142 ENUM_VALUES_PER_LINE = 1
143 GENERATE_TREEVIEW = NO
145 #---------------------------------------------------------------------------
146 # configuration options related to the LaTeX output
147 #---------------------------------------------------------------------------
150 LATEX_CMD_NAME = latex
151 MAKEINDEX_CMD_NAME = makeindex
159 LATEX_HIDE_INDICES = NO
160 #---------------------------------------------------------------------------
161 # configuration options related to the RTF output
162 #---------------------------------------------------------------------------
167 RTF_STYLESHEET_FILE =
168 RTF_EXTENSIONS_FILE =
169 #---------------------------------------------------------------------------
170 # configuration options related to the man page output
171 #---------------------------------------------------------------------------
176 #---------------------------------------------------------------------------
177 # configuration options related to the XML output
178 #---------------------------------------------------------------------------
181 XML_PROGRAMLISTING = YES
182 #---------------------------------------------------------------------------
183 # configuration options for the AutoGen Definitions output
184 #---------------------------------------------------------------------------
185 GENERATE_AUTOGEN_DEF = NO
186 #---------------------------------------------------------------------------
187 # configuration options related to the Perl module output
188 #---------------------------------------------------------------------------
189 GENERATE_PERLMOD = NO
192 PERLMOD_MAKEVAR_PREFIX =
193 #---------------------------------------------------------------------------
194 # Configuration options related to the preprocessor
195 #---------------------------------------------------------------------------
196 ENABLE_PREPROCESSING = YES
197 MACRO_EXPANSION = YES
198 EXPAND_ONLY_PREDEF = YES
199 SEARCH_INCLUDES = YES
201 INCLUDE_FILE_PATTERNS =
202 PREDEFINED = DOXYGEN_API
203 EXPAND_AS_DEFINED = DEF_COMMAND
204 SKIP_FUNCTION_MACROS = YES
205 #---------------------------------------------------------------------------
206 # Configuration::additions related to external references
207 #---------------------------------------------------------------------------
209 GENERATE_TAGFILE = ${CPACK_BINARY_DIR}/docs/openttd_ai_api.tag
211 EXTERNAL_GROUPS = YES
212 #---------------------------------------------------------------------------
213 # Configuration options related to the dot tool
214 #---------------------------------------------------------------------------
216 HIDE_UNDOC_RELATIONS = YES
219 COLLABORATION_GRAPH = YES
222 TEMPLATE_RELATIONS = NO
224 INCLUDED_BY_GRAPH = YES
227 GRAPHICAL_HIERARCHY = YES
228 DIRECTORY_GRAPH = YES
229 DOT_IMAGE_FORMAT = png
232 DOT_GRAPH_MAX_NODES = 50
233 MAX_DOT_GRAPH_DEPTH = 1000
235 DOT_MULTI_TARGETS = NO
238 #---------------------------------------------------------------------------
239 # Configuration::additions related to the search engine
240 #---------------------------------------------------------------------------