remove outdated comment
[supertux.git] / Doxyfile
1 # Doxyfile 1.3.7-KDevelop
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = SuperTux
7 PROJECT_NUMBER         = $VERSION$
8 OUTPUT_DIRECTORY       = 
9 CREATE_SUBDIRS         = NO
10 OUTPUT_LANGUAGE        = English
11 USE_WINDOWS_ENCODING   = NO
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = "The $name class" \
15                          "The $name widget" \
16                          "The $name file" \
17                          is \
18                          provides \
19                          specifies \
20                          contains \
21                          represents \
22                          a \
23                          an \
24                          the
25 ALWAYS_DETAILED_SEC    = YES
26 INLINE_INHERITED_MEMB  = NO
27 FULL_PATH_NAMES        = NO
28 STRIP_FROM_PATH        = ./
29 STRIP_FROM_INC_PATH    = 
30 SHORT_NAMES            = NO
31 JAVADOC_AUTOBRIEF      = NO
32 MULTILINE_CPP_IS_BRIEF = NO
33 DETAILS_AT_TOP         = NO
34 INHERIT_DOCS           = YES
35 DISTRIBUTE_GROUP_DOC   = NO
36 TAB_SIZE               = 8
37 ALIASES                = 
38 OPTIMIZE_OUTPUT_FOR_C  = NO
39 OPTIMIZE_OUTPUT_JAVA   = NO
40 SUBGROUPING            = YES
41 #---------------------------------------------------------------------------
42 # Build related configuration options
43 #---------------------------------------------------------------------------
44 EXTRACT_ALL            = YES
45 EXTRACT_PRIVATE        = YES
46 EXTRACT_STATIC         = YES
47 EXTRACT_LOCAL_CLASSES  = YES
48 EXTRACT_LOCAL_METHODS  = NO
49 HIDE_UNDOC_MEMBERS     = NO
50 HIDE_UNDOC_CLASSES     = NO
51 HIDE_FRIEND_COMPOUNDS  = NO
52 HIDE_IN_BODY_DOCS      = NO
53 INTERNAL_DOCS          = NO
54 CASE_SENSE_NAMES       = YES
55 HIDE_SCOPE_NAMES       = NO
56 SHOW_INCLUDE_FILES     = YES
57 INLINE_INFO            = YES
58 SORT_MEMBER_DOCS       = YES
59 SORT_BRIEF_DOCS        = NO
60 SORT_BY_SCOPE_NAME     = NO
61 GENERATE_TODOLIST      = YES
62 GENERATE_TESTLIST      = YES
63 GENERATE_BUGLIST       = YES
64 GENERATE_DEPRECATEDLIST= YES
65 ENABLED_SECTIONS       = 
66 MAX_INITIALIZER_LINES  = 30
67 SHOW_USED_FILES        = YES
68 #---------------------------------------------------------------------------
69 # configuration options related to warning and progress messages
70 #---------------------------------------------------------------------------
71 QUIET                  = NO
72 WARNINGS               = YES
73 WARN_IF_UNDOCUMENTED   = YES
74 WARN_IF_DOC_ERROR      = YES
75 WARN_FORMAT            = "$file:$line: $text"
76 WARN_LOGFILE           = 
77 #---------------------------------------------------------------------------
78 # configuration options related to the input files
79 #---------------------------------------------------------------------------
80 INPUT                  = ./lib
81 FILE_PATTERNS          = *.c \
82                          *.cc \
83                          *.cxx \
84                          *.cpp \
85                          *.c++ \
86                          *.java \
87                          *.ii \
88                          *.ixx \
89                          *.ipp \
90                          *.i++ \
91                          *.inl \
92                          *.h \
93                          *.hh \
94                          *.hxx \
95                          *.hpp \
96                          *.h++ \
97                          *.idl \
98                          *.odl \
99                          *.cs \
100                          *.php \
101                          *.php3 \
102                          *.inc \
103                          *.m \
104                          *.mm \
105                          *.C \
106                          *.CC \
107                          *.C++ \
108                          *.II \
109                          *.I++ \
110                          *.H \
111                          *.HH \
112                          *.H++ \
113                          *.CS \
114                          *.PHP \
115                          *.PHP3 \
116                          *.M \
117                          *.MM \
118                          *.C \
119                          *.H \
120                          *.tlh \
121                          *.diff \
122                          *.patch \
123                          *.moc \
124                          *.xpm \
125                          *.dox
126 RECURSIVE              = YES
127 EXCLUDE                = 
128 EXCLUDE_SYMLINKS       = NO
129 EXCLUDE_PATTERNS       = 
130 EXAMPLE_PATH           = 
131 EXAMPLE_PATTERNS       = *
132 EXAMPLE_RECURSIVE      = NO
133 IMAGE_PATH             = 
134 INPUT_FILTER           = 
135 FILTER_SOURCE_FILES    = NO
136 #---------------------------------------------------------------------------
137 # configuration options related to source browsing
138 #---------------------------------------------------------------------------
139 SOURCE_BROWSER         = NO
140 INLINE_SOURCES         = NO
141 STRIP_CODE_COMMENTS    = YES
142 REFERENCED_BY_RELATION = YES
143 REFERENCES_RELATION    = YES
144 VERBATIM_HEADERS       = YES
145 #---------------------------------------------------------------------------
146 # configuration options related to the alphabetical class index
147 #---------------------------------------------------------------------------
148 ALPHABETICAL_INDEX     = YES
149 COLS_IN_ALPHA_INDEX    = 5
150 IGNORE_PREFIX          = 
151 #---------------------------------------------------------------------------
152 # configuration options related to the HTML output
153 #---------------------------------------------------------------------------
154 GENERATE_HTML          = YES
155 HTML_OUTPUT            = html
156 HTML_FILE_EXTENSION    = .html
157 HTML_HEADER            = 
158 HTML_FOOTER            = 
159 HTML_STYLESHEET        = 
160 HTML_ALIGN_MEMBERS     = YES
161 GENERATE_HTMLHELP      = NO
162 CHM_FILE               = 
163 HHC_LOCATION           = 
164 GENERATE_CHI           = NO
165 BINARY_TOC             = NO
166 TOC_EXPAND             = YES
167 DISABLE_INDEX          = NO
168 ENUM_VALUES_PER_LINE   = 4
169 GENERATE_TREEVIEW      = YES
170 TREEVIEW_WIDTH         = 250
171 #---------------------------------------------------------------------------
172 # configuration options related to the LaTeX output
173 #---------------------------------------------------------------------------
174 GENERATE_LATEX         = NO
175 LATEX_OUTPUT           = latex
176 LATEX_CMD_NAME         = latex
177 MAKEINDEX_CMD_NAME     = makeindex
178 COMPACT_LATEX          = NO
179 PAPER_TYPE             = a4wide
180 EXTRA_PACKAGES         = 
181 LATEX_HEADER           = 
182 PDF_HYPERLINKS         = NO
183 USE_PDFLATEX           = NO
184 LATEX_BATCHMODE        = NO
185 LATEX_HIDE_INDICES     = NO
186 #---------------------------------------------------------------------------
187 # configuration options related to the RTF output
188 #---------------------------------------------------------------------------
189 GENERATE_RTF           = NO
190 RTF_OUTPUT             = rtf
191 COMPACT_RTF            = NO
192 RTF_HYPERLINKS         = NO
193 RTF_STYLESHEET_FILE    = 
194 RTF_EXTENSIONS_FILE    = 
195 #---------------------------------------------------------------------------
196 # configuration options related to the man page output
197 #---------------------------------------------------------------------------
198 GENERATE_MAN           = NO
199 MAN_OUTPUT             = man
200 MAN_EXTENSION          = .3
201 MAN_LINKS              = NO
202 #---------------------------------------------------------------------------
203 # configuration options related to the XML output
204 #---------------------------------------------------------------------------
205 GENERATE_XML           = NO
206 XML_OUTPUT             = xml
207 XML_SCHEMA             = 
208 XML_DTD                = 
209 XML_PROGRAMLISTING     = YES
210 #---------------------------------------------------------------------------
211 # configuration options for the AutoGen Definitions output
212 #---------------------------------------------------------------------------
213 GENERATE_AUTOGEN_DEF   = NO
214 #---------------------------------------------------------------------------
215 # configuration options related to the Perl module output
216 #---------------------------------------------------------------------------
217 GENERATE_PERLMOD       = NO
218 PERLMOD_LATEX          = NO
219 PERLMOD_PRETTY         = YES
220 PERLMOD_MAKEVAR_PREFIX = 
221 #---------------------------------------------------------------------------
222 # Configuration options related to the preprocessor   
223 #---------------------------------------------------------------------------
224 ENABLE_PREPROCESSING   = YES
225 MACRO_EXPANSION        = NO
226 EXPAND_ONLY_PREDEF     = NO
227 SEARCH_INCLUDES        = YES
228 INCLUDE_PATH           = 
229 INCLUDE_FILE_PATTERNS  = 
230 PREDEFINED             = 
231 EXPAND_AS_DEFINED      = 
232 SKIP_FUNCTION_MACROS   = YES
233 #---------------------------------------------------------------------------
234 # Configuration::additions related to external references   
235 #---------------------------------------------------------------------------
236 TAGFILES               = 
237 GENERATE_TAGFILE       = supertux.tag
238 ALLEXTERNALS           = NO
239 EXTERNAL_GROUPS        = YES
240 PERL_PATH              = /usr/bin/perl
241 #---------------------------------------------------------------------------
242 # Configuration options related to the dot tool   
243 #---------------------------------------------------------------------------
244 CLASS_DIAGRAMS         = YES
245 HIDE_UNDOC_RELATIONS   = YES
246 HAVE_DOT               = NO
247 CLASS_GRAPH            = YES
248 COLLABORATION_GRAPH    = YES
249 UML_LOOK               = NO
250 TEMPLATE_RELATIONS     = NO
251 INCLUDE_GRAPH          = YES
252 INCLUDED_BY_GRAPH      = YES
253 CALL_GRAPH             = NO
254 GRAPHICAL_HIERARCHY    = YES
255 DOT_IMAGE_FORMAT       = png
256 DOT_PATH               = 
257 DOTFILE_DIRS           = 
258 MAX_DOT_GRAPH_WIDTH    = 1024
259 MAX_DOT_GRAPH_HEIGHT   = 1024
260 MAX_DOT_GRAPH_DEPTH    = 1000
261 GENERATE_LEGEND        = YES
262 DOT_CLEANUP            = YES
263 #---------------------------------------------------------------------------
264 # Configuration::additions related to the search engine   
265 #---------------------------------------------------------------------------
266 SEARCHENGINE           = NO