Fix #10490: Allow ships to exit depots if another is not moving at the exit point...
[openttd-github.git] / src / script / api / Doxyfile_AI.in
blobcde1f21350d5839892c60373a745fd64e4da3f30
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.5.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 OUTPUT_DIRECTORY       = ${CPACK_BINARY_DIR}/docs/ai-api/
15 CREATE_SUBDIRS         = NO
16 OUTPUT_LANGUAGE        = English
17 BRIEF_MEMBER_DESC      = YES
18 REPEAT_BRIEF           = YES
19 ABBREVIATE_BRIEF       = "The $name class " \
20                          "The $name widget " \
21                          "The $name file " \
22                          is \
23                          provides \
24                          specifies \
25                          contains \
26                          represents \
27                          a \
28                          an \
29                          the
30 ALWAYS_DETAILED_SEC    = NO
31 INLINE_INHERITED_MEMB  = NO
32 FULL_PATH_NAMES        = YES
33 STRIP_FROM_PATH        = ./
34 STRIP_FROM_INC_PATH    =
35 SHORT_NAMES            = NO
36 JAVADOC_AUTOBRIEF      = YES
37 QT_AUTOBRIEF           = NO
38 MULTILINE_CPP_IS_BRIEF = NO
39 INHERIT_DOCS           = YES
40 SEPARATE_MEMBER_PAGES  = NO
41 TAB_SIZE               = 2
42 ALIASES                =
43 OPTIMIZE_OUTPUT_FOR_C  = YES
44 OPTIMIZE_OUTPUT_JAVA   = NO
45 BUILTIN_STL_SUPPORT    = NO
46 CPP_CLI_SUPPORT        = NO
47 SIP_SUPPORT            = NO
48 DISTRIBUTE_GROUP_DOC   = NO
49 SUBGROUPING            = YES
50 TYPEDEF_HIDES_STRUCT   = NO
51 #---------------------------------------------------------------------------
52 # Build related configuration options
53 #---------------------------------------------------------------------------
54 EXTRACT_ALL            = NO
55 EXTRACT_PRIVATE        = NO
56 EXTRACT_STATIC         = YES
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
64 INTERNAL_DOCS          = YES
65 CASE_SENSE_NAMES       = YES
66 HIDE_SCOPE_NAMES       = NO
67 SHOW_INCLUDE_FILES     = NO
68 INLINE_INFO            = YES
69 SORT_MEMBER_DOCS       = YES
70 SORT_BRIEF_DOCS        = NO
71 SORT_BY_SCOPE_NAME     = NO
72 GENERATE_TODOLIST      = NO
73 GENERATE_TESTLIST      = NO
74 GENERATE_BUGLIST       = NO
75 GENERATE_DEPRECATEDLIST= NO
76 ENABLED_SECTIONS       =
77 MAX_INITIALIZER_LINES  = 30
78 SHOW_USED_FILES        = NO
79 FILE_VERSION_FILTER    =
80 #---------------------------------------------------------------------------
81 # configuration options related to warning and progress messages
82 #---------------------------------------------------------------------------
83 QUIET                  = NO
84 WARNINGS               = YES
85 WARN_IF_UNDOCUMENTED   = YES
86 WARN_IF_DOC_ERROR      = YES
87 WARN_NO_PARAMDOC       = YES
88 WARN_FORMAT            = "$file:$line: $text "
89 WARN_LOGFILE           =
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 \
96                          ai_*.hpp
97 RECURSIVE              = YES
98 EXCLUDE                =
99 EXCLUDE_SYMLINKS       = NO
100 EXCLUDE_PATTERNS       = ai_includes.hpp
101 EXCLUDE_SYMBOLS        = GetClassName DECLARE_ENUM_AS_BIT_SET DECLARE_POSTFIX_INCREMENT
102 EXAMPLE_PATH           =
103 EXAMPLE_PATTERNS       = *
104 EXAMPLE_RECURSIVE      = NO
105 IMAGE_PATH             =
106 INPUT_FILTER           = "./doxygen_filter.sh AI"
107 FILTER_PATTERNS        =
108 FILTER_SOURCE_FILES    = NO
109 #---------------------------------------------------------------------------
110 # configuration options related to source browsing
111 #---------------------------------------------------------------------------
112 SOURCE_BROWSER         = NO
113 INLINE_SOURCES         = NO
114 STRIP_CODE_COMMENTS    = YES
115 REFERENCED_BY_RELATION = NO
116 REFERENCES_RELATION    = NO
117 REFERENCES_LINK_SOURCE = YES
118 USE_HTAGS              = NO
119 VERBATIM_HEADERS       = NO
120 #---------------------------------------------------------------------------
121 # configuration options related to the alphabetical class index
122 #---------------------------------------------------------------------------
123 ALPHABETICAL_INDEX     = NO
124 IGNORE_PREFIX          =
125 #---------------------------------------------------------------------------
126 # configuration options related to the HTML output
127 #---------------------------------------------------------------------------
128 GENERATE_HTML          = YES
129 HTML_OUTPUT            = html
130 HTML_FILE_EXTENSION    = .html
131 HTML_HEADER            =
132 HTML_FOOTER            =
133 HTML_STYLESHEET        =
134 GENERATE_HTMLHELP      = NO
135 HTML_DYNAMIC_SECTIONS  = NO
136 CHM_FILE               =
137 HHC_LOCATION           =
138 GENERATE_CHI           = NO
139 BINARY_TOC             = NO
140 TOC_EXPAND             = NO
141 DISABLE_INDEX          = NO
142 ENUM_VALUES_PER_LINE   = 1
143 GENERATE_TREEVIEW      = NO
144 TREEVIEW_WIDTH         = 250
145 #---------------------------------------------------------------------------
146 # configuration options related to the LaTeX output
147 #---------------------------------------------------------------------------
148 GENERATE_LATEX         = NO
149 LATEX_OUTPUT           = latex
150 LATEX_CMD_NAME         = latex
151 MAKEINDEX_CMD_NAME     = makeindex
152 COMPACT_LATEX          = NO
153 PAPER_TYPE             = a4
154 EXTRA_PACKAGES         =
155 LATEX_HEADER           =
156 PDF_HYPERLINKS         = NO
157 USE_PDFLATEX           = NO
158 LATEX_BATCHMODE        = NO
159 LATEX_HIDE_INDICES     = NO
160 #---------------------------------------------------------------------------
161 # configuration options related to the RTF output
162 #---------------------------------------------------------------------------
163 GENERATE_RTF           = NO
164 RTF_OUTPUT             = rtf
165 COMPACT_RTF            = NO
166 RTF_HYPERLINKS         = NO
167 RTF_STYLESHEET_FILE    =
168 RTF_EXTENSIONS_FILE    =
169 #---------------------------------------------------------------------------
170 # configuration options related to the man page output
171 #---------------------------------------------------------------------------
172 GENERATE_MAN           = NO
173 MAN_OUTPUT             = man
174 MAN_EXTENSION          = .3
175 MAN_LINKS              = NO
176 #---------------------------------------------------------------------------
177 # configuration options related to the XML output
178 #---------------------------------------------------------------------------
179 GENERATE_XML           = NO
180 XML_OUTPUT             = xml
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
190 PERLMOD_LATEX          = NO
191 PERLMOD_PRETTY         = YES
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
200 INCLUDE_PATH           =
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 #---------------------------------------------------------------------------
208 TAGFILES               =
209 GENERATE_TAGFILE       = ${CPACK_BINARY_DIR}/docs/openttd_ai_api.tag
210 ALLEXTERNALS           = NO
211 EXTERNAL_GROUPS        = YES
212 #---------------------------------------------------------------------------
213 # Configuration options related to the dot tool
214 #---------------------------------------------------------------------------
215 CLASS_DIAGRAMS         = YES
216 HIDE_UNDOC_RELATIONS   = YES
217 HAVE_DOT               = NO
218 CLASS_GRAPH            = YES
219 COLLABORATION_GRAPH    = YES
220 GROUP_GRAPHS           = YES
221 UML_LOOK               = NO
222 TEMPLATE_RELATIONS     = NO
223 INCLUDE_GRAPH          = YES
224 INCLUDED_BY_GRAPH      = YES
225 CALL_GRAPH             = NO
226 CALLER_GRAPH           = NO
227 GRAPHICAL_HIERARCHY    = YES
228 DIRECTORY_GRAPH        = YES
229 DOT_IMAGE_FORMAT       = png
230 DOT_PATH               =
231 DOTFILE_DIRS           =
232 DOT_GRAPH_MAX_NODES    = 50
233 MAX_DOT_GRAPH_DEPTH    = 1000
234 DOT_TRANSPARENT        = NO
235 DOT_MULTI_TARGETS      = NO
236 GENERATE_LEGEND        = NO
237 DOT_CLEANUP            = YES
238 #---------------------------------------------------------------------------
239 # Configuration::additions related to the search engine
240 #---------------------------------------------------------------------------
241 SEARCHENGINE           = NO