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 PROJECT_NAME = OpenTTD
12 OUTPUT_DIRECTORY = docs/source/
14 OUTPUT_LANGUAGE = English
15 BRIEF_MEMBER_DESC = YES
17 ABBREVIATE_BRIEF = "The $name class" \
28 ALWAYS_DETAILED_SEC = NO
29 INLINE_INHERITED_MEMB = NO
34 JAVADOC_AUTOBRIEF = YES
35 MULTILINE_CPP_IS_BRIEF = NO
37 DISTRIBUTE_GROUP_DOC = NO
40 OPTIMIZE_OUTPUT_FOR_C = YES
41 OPTIMIZE_OUTPUT_JAVA = NO
43 #---------------------------------------------------------------------------
44 # Build related configuration options
45 #---------------------------------------------------------------------------
49 EXTRACT_LOCAL_CLASSES = YES
50 EXTRACT_LOCAL_METHODS = YES
51 HIDE_UNDOC_MEMBERS = NO
52 HIDE_UNDOC_CLASSES = NO
53 HIDE_FRIEND_COMPOUNDS = NO
54 HIDE_IN_BODY_DOCS = NO
56 CASE_SENSE_NAMES = YES
58 SHOW_INCLUDE_FILES = YES
60 SORT_MEMBER_DOCS = YES
62 SORT_BY_SCOPE_NAME = NO
63 GENERATE_TODOLIST = YES
64 GENERATE_TESTLIST = YES
65 GENERATE_BUGLIST = YES
66 GENERATE_DEPRECATEDLIST= YES
68 MAX_INITIALIZER_LINES = 30
70 SHOW_DIRECTORIES = YES
72 #---------------------------------------------------------------------------
73 # configuration options related to warning and progress messages
74 #---------------------------------------------------------------------------
77 WARN_IF_UNDOCUMENTED = YES
78 WARN_IF_DOC_ERROR = YES
80 WARN_FORMAT = "$file:$line: $text"
82 #---------------------------------------------------------------------------
83 # configuration options related to the input files
84 #---------------------------------------------------------------------------
96 EXCLUDE_PATTERNS = */3rdparty */.svn */script/api
99 EXAMPLE_RECURSIVE = NO
103 FILTER_SOURCE_FILES = NO
104 #---------------------------------------------------------------------------
105 # configuration options related to source browsing
106 #---------------------------------------------------------------------------
109 STRIP_CODE_COMMENTS = YES
110 REFERENCED_BY_RELATION = YES
111 REFERENCES_RELATION = YES
112 VERBATIM_HEADERS = YES
113 #---------------------------------------------------------------------------
114 # configuration options related to the alphabetical class index
115 #---------------------------------------------------------------------------
116 ALPHABETICAL_INDEX = NO
117 COLS_IN_ALPHA_INDEX = 5
119 #---------------------------------------------------------------------------
120 # configuration options related to the HTML output
121 #---------------------------------------------------------------------------
124 HTML_FILE_EXTENSION = .html
128 HTML_ALIGN_MEMBERS = YES
129 GENERATE_HTMLHELP = YES
136 ENUM_VALUES_PER_LINE = 4
137 GENERATE_TREEVIEW = YES
139 #---------------------------------------------------------------------------
140 # configuration options related to the LaTeX output
141 #---------------------------------------------------------------------------
144 LATEX_CMD_NAME = latex
145 MAKEINDEX_CMD_NAME = makeindex
153 LATEX_HIDE_INDICES = NO
154 #---------------------------------------------------------------------------
155 # configuration options related to the RTF output
156 #---------------------------------------------------------------------------
161 RTF_STYLESHEET_FILE =
162 RTF_EXTENSIONS_FILE =
163 #---------------------------------------------------------------------------
164 # configuration options related to the man page output
165 #---------------------------------------------------------------------------
170 #---------------------------------------------------------------------------
171 # configuration options related to the XML output
172 #---------------------------------------------------------------------------
177 XML_PROGRAMLISTING = YES
178 #---------------------------------------------------------------------------
179 # configuration options for the AutoGen Definitions output
180 #---------------------------------------------------------------------------
181 GENERATE_AUTOGEN_DEF = NO
182 #---------------------------------------------------------------------------
183 # configuration options related to the Perl module output
184 #---------------------------------------------------------------------------
185 GENERATE_PERLMOD = NO
188 PERLMOD_MAKEVAR_PREFIX =
189 #---------------------------------------------------------------------------
190 # Configuration options related to the preprocessor
191 #---------------------------------------------------------------------------
192 ENABLE_PREPROCESSING = YES
193 MACRO_EXPANSION = YES
194 EXPAND_ONLY_PREDEF = YES
195 SEARCH_INCLUDES = YES
197 INCLUDE_FILE_PATTERNS =
198 PREDEFINED = ENABLE_NETWORK WITH_ZLIB WITH_LZO WITH_LZMA WITH_SDL WITH_PNG WITH_FONTCONFIG WITH_FREETYPE WITH_ICU_SORT WITH_ICU_LAYOUT UNICODE _UNICODE _GNU_SOURCE FINAL=
200 SKIP_FUNCTION_MACROS = YES
201 #---------------------------------------------------------------------------
202 # Configuration::additions related to external references
203 #---------------------------------------------------------------------------
205 GENERATE_TAGFILE = objs/openttd.tag
207 EXTERNAL_GROUPS = YES
208 PERL_PATH = /usr/bin/perl
209 #---------------------------------------------------------------------------
210 # Configuration options related to the dot tool
211 #---------------------------------------------------------------------------
213 HIDE_UNDOC_RELATIONS = YES
216 COLLABORATION_GRAPH = YES
219 TEMPLATE_RELATIONS = NO
221 INCLUDED_BY_GRAPH = YES
223 GRAPHICAL_HIERARCHY = YES
224 DIRECTORY_GRAPH = YES
225 DOT_IMAGE_FORMAT = png
228 MAX_DOT_GRAPH_DEPTH = 1000
230 DOT_MULTI_TARGETS = NO
231 GENERATE_LEGEND = YES
233 #---------------------------------------------------------------------------
234 # Configuration::additions related to the search engine
235 #---------------------------------------------------------------------------