~nastasi/mysql-proxy/configure.in-fix

242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1
# Doxyfile 1.5.3
2
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
5
#
6
# All text after a hash (#) is considered a comment and will be ignored
7
# The format is:
8
#       TAG = value [value, ...]
9
# For lists items can also be appended using:
10
#       TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
12
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
16
17
# This tag specifies the encoding used for all characters in the config file that 
18
# follow. The default is UTF-8 which is also the encoding used for all text before 
19
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
20
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
21
# possible encodings.
22
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
23
DOXYFILE_ENCODING = UTF-8
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
24
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
26
# by quotes) that should identify the project.
27
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
28
PROJECT_NAME = "MySQL Proxy"
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
29
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
31
# This could be handy for archiving the generated documentation or 
32
# if some version control system is used.
33
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
34
PROJECT_NUMBER = 0.8.0
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
35
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
37
# base path where the generated documentation will be put. 
38
# If a relative path is entered, it will be relative to the location 
39
# where doxygen was started. If left blank the current directory will be used.
40
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
41
OUTPUT_DIRECTORY = doxygen/
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
42
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
45
# format and will distribute the generated files over these directories. 
46
# Enabling this option can be useful when feeding doxygen a huge amount of 
47
# source files, where putting all generated files in the same directory would 
48
# otherwise cause performance problems for the file system.
49
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
50
CREATE_SUBDIRS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
51
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
53
# documentation generated by doxygen is written. Doxygen will use this 
54
# information to generate all constant output in the proper language. 
55
# The default language is English, other supported languages are: 
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
57
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
58
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
59
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
60
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
61
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
62
OUTPUT_LANGUAGE = English
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
63
64
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
65
# include brief member descriptions after the members that are listed in 
66
# the file and class documentation (similar to JavaDoc). 
67
# Set to NO to disable this.
68
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
69
BRIEF_MEMBER_DESC = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
70
71
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
72
# the brief description of a member or function before the detailed description. 
73
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
74
# brief descriptions will be completely suppressed.
75
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
76
REPEAT_BRIEF = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
77
78
# This tag implements a quasi-intelligent brief description abbreviator 
79
# that is used to form the text in various listings. Each string 
80
# in this list, if found as the leading text of the brief description, will be 
81
# stripped from the text and the result after processing the whole list, is 
82
# used as the annotated text. Otherwise, the brief description is used as-is. 
83
# If left blank, the following values are used ("$name" is automatically 
84
# replaced with the name of the entity): "The $name class" "The $name widget" 
85
# "The $name file" "is" "provides" "specifies" "contains" 
86
# "represents" "a" "an" "the"
87
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
88
ABBREVIATE_BRIEF = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
89
90
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
91
# Doxygen will generate a detailed section even if there is only a brief 
92
# description.
93
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
94
ALWAYS_DETAILED_SEC = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
95
96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
97
# inherited members of a class in the documentation of that class as if those 
98
# members were ordinary class members. Constructors, destructors and assignment 
99
# operators of the base classes will not be shown.
100
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
101
INLINE_INHERITED_MEMB = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
102
103
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
104
# path before files name in the file list and in the header files. If set 
105
# to NO the shortest path that makes the file name unique will be used.
106
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
107
FULL_PATH_NAMES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
108
109
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
110
# can be used to strip a user-defined part of the path. Stripping is 
111
# only done if one of the specified strings matches the left-hand part of 
112
# the path. The tag can be used to show relative paths in the file list. 
113
# If left blank the directory from which doxygen is run is used as the 
114
# path to strip.
115
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
116
STRIP_FROM_PATH = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
117
118
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
119
# the path mentioned in the documentation of a class, which tells 
120
# the reader which header file to include in order to use a class. 
121
# If left blank only the name of the header file containing the class 
122
# definition is used. Otherwise one should specify the include paths that 
123
# are normally passed to the compiler using the -I flag.
124
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
125
STRIP_FROM_INC_PATH = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
126
127
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
128
# (but less readable) file names. This can be useful is your file systems 
129
# doesn't support long names like on DOS, Mac, or CD-ROM.
130
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
131
SHORT_NAMES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
132
133
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
134
# will interpret the first line (until the first dot) of a JavaDoc-style 
135
# comment as the brief description. If set to NO, the JavaDoc 
136
# comments will behave just like regular Qt-style comments 
137
# (thus requiring an explicit @brief command for a brief description.)
138
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
139
JAVADOC_AUTOBRIEF = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
140
141
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
142
# interpret the first line (until the first dot) of a Qt-style 
143
# comment as the brief description. If set to NO, the comments 
144
# will behave just like regular Qt-style comments (thus requiring 
145
# an explicit \brief command for a brief description.)
146
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
147
QT_AUTOBRIEF = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
148
149
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
150
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
151
# comments) as a brief description. This used to be the default behaviour. 
152
# The new default is to treat a multi-line C++ comment block as a detailed 
153
# description. Set this tag to YES if you prefer the old behaviour instead.
154
155
MULTILINE_CPP_IS_BRIEF = NO
156
157
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
158
# will output the detailed description near the top, like JavaDoc.
159
# If set to NO, the detailed description appears after the member 
160
# documentation.
161
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
162
DETAILS_AT_TOP = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
163
164
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
165
# member inherits the documentation from any documented member that it 
166
# re-implements.
167
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
168
INHERIT_DOCS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
169
170
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
171
# a new page for each member. If set to NO, the documentation of a member will 
172
# be part of the file/class/namespace that contains it.
173
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
174
SEPARATE_MEMBER_PAGES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
175
176
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
177
# Doxygen uses this value to replace tabs by spaces in code fragments.
178
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
179
TAB_SIZE = 8
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
180
181
# This tag can be used to specify a number of aliases that acts 
182
# as commands in the documentation. An alias has the form "name=value". 
183
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
184
# put the command \sideeffect (or @sideeffect) in the documentation, which 
185
# will result in a user-defined paragraph with heading "Side Effects:". 
186
# You can put \n's in the value part of an alias to insert newlines.
187
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
188
ALIASES = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
189
190
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
191
# sources only. Doxygen will then generate output that is more tailored for C. 
192
# For instance, some of the names that are used will be different. The list 
193
# of all members will be omitted, etc.
194
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
195
OPTIMIZE_OUTPUT_FOR_C = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
196
197
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
198
# sources only. Doxygen will then generate output that is more tailored for Java. 
199
# For instance, namespaces will be presented as packages, qualified scopes 
200
# will look different, etc.
201
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
202
OPTIMIZE_OUTPUT_JAVA = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
203
204
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
205
# include (a tag file for) the STL sources as input, then you should 
206
# set this tag to YES in order to let doxygen match functions declarations and 
207
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
208
# func(std::string) {}). This also make the inheritance and collaboration 
209
# diagrams that involve STL classes more complete and accurate.
210
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
211
BUILTIN_STL_SUPPORT = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
212
213
# If you use Microsoft's C++/CLI language, you should set this option to YES to
214
# enable parsing support.
215
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
216
CPP_CLI_SUPPORT = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
217
218
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
219
# tag is set to YES, then doxygen will reuse the documentation of the first 
220
# member in the group (if any) for the other members of the group. By default 
221
# all members of a group must be documented explicitly.
222
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
223
DISTRIBUTE_GROUP_DOC = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
224
225
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
226
# the same type (for instance a group of public functions) to be put as a 
227
# subgroup of that type (e.g. under the Public Functions section). Set it to 
228
# NO to prevent subgrouping. Alternatively, this can be done per class using 
229
# the \nosubgrouping command.
230
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
231
SUBGROUPING = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
232
233
#---------------------------------------------------------------------------
234
# Build related configuration options
235
#---------------------------------------------------------------------------
236
237
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
238
# documentation are documented, even if no documentation was available. 
239
# Private class members and static file members will be hidden unless 
240
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
241
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
242
EXTRACT_ALL = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
243
244
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
245
# will be included in the documentation.
246
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
247
EXTRACT_PRIVATE = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
248
249
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
250
# will be included in the documentation.
251
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
252
EXTRACT_STATIC = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
253
254
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
255
# defined locally in source files will be included in the documentation. 
256
# If set to NO only classes defined in header files are included.
257
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
258
EXTRACT_LOCAL_CLASSES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
259
260
# This flag is only useful for Objective-C code. When set to YES local 
261
# methods, which are defined in the implementation section but not in 
262
# the interface are included in the documentation. 
263
# If set to NO (the default) only methods in the interface are included.
264
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
265
EXTRACT_LOCAL_METHODS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
266
267
# If this flag is set to YES, the members of anonymous namespaces will be extracted 
268
# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
269
# where file will be replaced with the base name of the file that contains the anonymous 
270
# namespace. By default anonymous namespace are hidden.
271
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
272
EXTRACT_ANON_NSPACES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
273
274
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
275
# undocumented members of documented classes, files or namespaces. 
276
# If set to NO (the default) these members will be included in the 
277
# various overviews, but no documentation section is generated. 
278
# This option has no effect if EXTRACT_ALL is enabled.
279
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
280
HIDE_UNDOC_MEMBERS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
281
282
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
283
# undocumented classes that are normally visible in the class hierarchy. 
284
# If set to NO (the default) these classes will be included in the various 
285
# overviews. This option has no effect if EXTRACT_ALL is enabled.
286
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
287
HIDE_UNDOC_CLASSES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
288
289
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
290
# friend (class|struct|union) declarations. 
291
# If set to NO (the default) these declarations will be included in the 
292
# documentation.
293
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
294
HIDE_FRIEND_COMPOUNDS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
295
296
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
297
# documentation blocks found inside the body of a function. 
298
# If set to NO (the default) these blocks will be appended to the 
299
# function's detailed documentation block.
300
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
301
HIDE_IN_BODY_DOCS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
302
303
# The INTERNAL_DOCS tag determines if documentation 
304
# that is typed after a \internal command is included. If the tag is set 
305
# to NO (the default) then the documentation will be excluded. 
306
# Set it to YES to include the internal documentation.
307
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
308
INTERNAL_DOCS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
309
310
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
311
# file names in lower-case letters. If set to YES upper-case letters are also 
312
# allowed. This is useful if you have classes or files whose names only differ 
313
# in case and if your file system supports case sensitive file names. Windows 
314
# and Mac users are advised to set this option to NO.
315
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
316
CASE_SENSE_NAMES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
317
318
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
319
# will show members with their full class and namespace scopes in the 
320
# documentation. If set to YES the scope will be hidden.
321
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
322
HIDE_SCOPE_NAMES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
323
324
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
325
# will put a list of the files that are included by a file in the documentation 
326
# of that file.
327
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
328
SHOW_INCLUDE_FILES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
329
330
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
331
# is inserted in the documentation for inline members.
332
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
333
INLINE_INFO = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
334
335
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
336
# will sort the (detailed) documentation of file and class members 
337
# alphabetically by member name. If set to NO the members will appear in 
338
# declaration order.
339
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
340
SORT_MEMBER_DOCS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
341
342
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
343
# brief documentation of file, namespace and class members alphabetically 
344
# by member name. If set to NO (the default) the members will appear in 
345
# declaration order.
346
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
347
SORT_BRIEF_DOCS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
348
349
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
350
# sorted by fully-qualified names, including namespaces. If set to 
351
# NO (the default), the class list will be sorted only by class name, 
352
# not including the namespace part. 
353
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
354
# Note: This option applies only to the class list, not to the 
355
# alphabetical list.
356
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
357
SORT_BY_SCOPE_NAME = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
358
359
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
360
# disable (NO) the todo list. This list is created by putting \todo 
361
# commands in the documentation.
362
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
363
GENERATE_TODOLIST = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
364
365
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
366
# disable (NO) the test list. This list is created by putting \test 
367
# commands in the documentation.
368
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
369
GENERATE_TESTLIST = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
370
371
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
372
# disable (NO) the bug list. This list is created by putting \bug 
373
# commands in the documentation.
374
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
375
GENERATE_BUGLIST = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
376
377
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
378
# disable (NO) the deprecated list. This list is created by putting 
379
# \deprecated commands in the documentation.
380
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
381
GENERATE_DEPRECATEDLIST = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
382
383
# The ENABLED_SECTIONS tag can be used to enable conditional 
384
# documentation sections, marked by \if sectionname ... \endif.
385
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
386
ENABLED_SECTIONS = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
387
388
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
389
# the initial value of a variable or define consists of for it to appear in 
390
# the documentation. If the initializer consists of more lines than specified 
391
# here it will be hidden. Use a value of 0 to hide initializers completely. 
392
# The appearance of the initializer of individual variables and defines in the 
393
# documentation can be controlled using \showinitializer or \hideinitializer 
394
# command in the documentation regardless of this setting.
395
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
396
MAX_INITIALIZER_LINES = 30
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
397
398
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
399
# at the bottom of the documentation of classes and structs. If set to YES the 
400
# list will mention the files that were used to generate the documentation.
401
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
402
SHOW_USED_FILES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
403
404
# If the sources in your project are distributed over multiple directories 
405
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
406
# in the documentation. The default is NO.
407
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
408
SHOW_DIRECTORIES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
409
410
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
411
# doxygen should invoke to get the current version for each file (typically from the 
412
# version control system). Doxygen will invoke the program by executing (via 
413
# popen()) the command <command> <input-file>, where <command> is the value of 
414
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
415
# provided by doxygen. Whatever the program writes to standard output 
416
# is used as the file version. See the manual for examples.
417
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
418
FILE_VERSION_FILTER = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
419
420
#---------------------------------------------------------------------------
421
# configuration options related to warning and progress messages
422
#---------------------------------------------------------------------------
423
424
# The QUIET tag can be used to turn on/off the messages that are generated 
425
# by doxygen. Possible values are YES and NO. If left blank NO is used.
426
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
427
QUIET = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
428
429
# The WARNINGS tag can be used to turn on/off the warning messages that are 
430
# generated by doxygen. Possible values are YES and NO. If left blank 
431
# NO is used.
432
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
433
WARNINGS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
434
435
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
436
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
437
# automatically be disabled.
438
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
439
WARN_IF_UNDOCUMENTED = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
440
441
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
442
# potential errors in the documentation, such as not documenting some 
443
# parameters in a documented function, or documenting parameters that 
444
# don't exist or using markup commands wrongly.
445
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
446
WARN_IF_DOC_ERROR = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
447
448
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
449
# functions that are documented, but have no documentation for their parameters 
450
# or return value. If set to NO (the default) doxygen will only warn about 
451
# wrong or incomplete parameter documentation, but not about the absence of 
452
# documentation.
453
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
454
WARN_NO_PARAMDOC = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
455
456
# The WARN_FORMAT tag determines the format of the warning messages that 
457
# doxygen can produce. The string should contain the $file, $line, and $text 
458
# tags, which will be replaced by the file and line number from which the 
459
# warning originated and the warning text. Optionally the format may contain 
460
# $version, which will be replaced by the version of the file (if it could 
461
# be obtained via FILE_VERSION_FILTER)
462
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
463
WARN_FORMAT = "$file:$line: $text"
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
464
465
# The WARN_LOGFILE tag can be used to specify a file to which warning 
466
# and error messages should be written. If left blank the output is written 
467
# to stderr.
468
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
469
WARN_LOGFILE = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
470
471
#---------------------------------------------------------------------------
472
# configuration options related to the input files
473
#---------------------------------------------------------------------------
474
475
# The INPUT tag can be used to specify the files and/or directories that contain 
476
# documented source files. You may enter file names like "myfile.cpp" or 
477
# directories like "/usr/src/myproject". Separate the files or directories 
478
# with spaces.
479
658 by Kay Roepke
move tests/doc.txt to doc/, makes more sense
480
INPUT = src/ tests/unit/ doc/ plugins/proxy/ plugins/admin/
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
481
482
# This tag can be used to specify the character encoding of the source files that 
483
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
484
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
485
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
486
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
487
INPUT_ENCODING = UTF-8
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
488
489
# If the value of the INPUT tag contains directories, you can use the 
490
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
491
# and *.h) to filter out the source-files in the directories. If left 
492
# blank the following patterns are tested: 
493
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
494
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
495
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
496
FILE_PATTERNS = *.c *.h *.y *.txt
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
497
498
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
499
# should be searched for input files as well. Possible values are YES and NO. 
500
# If left blank NO is used.
501
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
502
RECURSIVE = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
503
504
# The EXCLUDE tag can be used to specify files and/or directories that should 
505
# excluded from the INPUT source files. This way you can easily exclude a 
506
# subdirectory from a directory tree whose root is specified with the INPUT tag.
507
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
508
EXCLUDE = src/sql-tokenizer.c tests/unit/sql-tokenizer.c
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
509
510
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
511
# directories that are symbolic links (a Unix filesystem feature) are excluded 
512
# from the input.
513
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
514
EXCLUDE_SYMLINKS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
515
516
# If the value of the INPUT tag contains directories, you can use the 
517
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
518
# certain files from those directories. Note that the wildcards are matched 
519
# against the file with absolute path, so to exclude all test directories 
520
# for example use the pattern */test/*
521
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
522
EXCLUDE_PATTERNS = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
523
524
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
525
# (namespaces, classes, functions, etc.) that should be excluded from the output. 
526
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
527
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
528
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
529
EXCLUDE_SYMBOLS = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
530
531
# The EXAMPLE_PATH tag can be used to specify one or more files or 
532
# directories that contain example code fragments that are included (see 
533
# the \include command).
534
680 by jan at mysql
added basic admin-plugin doc-comments and add lib/ to the example_path in doxygen to include lib/admin.lua as example
535
EXAMPLE_PATH = examples/ lib/
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
536
537
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
538
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
539
# and *.h) to filter out the source-files in the directories. If left 
540
# blank all files are included.
541
664 by jan at mysql
added the examples and the lua-classes to the documentation
542
EXAMPLE_PATTERNS = *.lua
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
543
544
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
545
# searched for input files to be used with the \include or \dontinclude 
546
# commands irrespective of the value of the RECURSIVE tag. 
547
# Possible values are YES and NO. If left blank NO is used.
548
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
549
EXAMPLE_RECURSIVE = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
550
551
# The IMAGE_PATH tag can be used to specify one or more files or 
552
# directories that contain image that are included in the documentation (see 
553
# the \image command).
554
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
555
IMAGE_PATH = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
556
557
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
558
# invoke to filter for each input file. Doxygen will invoke the filter program 
559
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
560
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
561
# input file. Doxygen will then use the output that the filter program writes 
562
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
563
# ignored.
564
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
565
INPUT_FILTER = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
566
567
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
568
# basis.  Doxygen will compare the file name with each pattern and apply the 
569
# filter if there is a match.  The filters are a list of the form: 
570
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
571
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
572
# is applied to all files.
573
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
574
FILTER_PATTERNS = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
575
576
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
577
# INPUT_FILTER) will be used to filter the input files when producing source 
578
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
579
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
580
FILTER_SOURCE_FILES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
581
582
#---------------------------------------------------------------------------
583
# configuration options related to source browsing
584
#---------------------------------------------------------------------------
585
586
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
587
# be generated. Documented entities will be cross-referenced with these sources. 
588
# Note: To get rid of all source code in the generated output, make sure also 
589
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 
590
# then you must also enable this option. If you don't then doxygen will produce 
591
# a warning and turn it on anyway
592
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
593
SOURCE_BROWSER = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
594
595
# Setting the INLINE_SOURCES tag to YES will include the body 
596
# of functions and classes directly in the documentation.
597
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
598
INLINE_SOURCES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
599
600
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
601
# doxygen to hide any special comment blocks from generated source code 
602
# fragments. Normal C and C++ comments will always remain visible.
603
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
604
STRIP_CODE_COMMENTS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
605
606
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
607
# then for each documented function all documented 
608
# functions referencing it will be listed.
609
610
REFERENCED_BY_RELATION = YES
611
612
# If the REFERENCES_RELATION tag is set to YES (the default) 
613
# then for each documented function all documented entities 
614
# called/used by that function will be listed.
615
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
616
REFERENCES_RELATION = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
617
618
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621
# link to the source code.  Otherwise they will link to the documentstion.
622
623
REFERENCES_LINK_SOURCE = YES
624
625
# If the USE_HTAGS tag is set to YES then the references to source code 
626
# will point to the HTML generated by the htags(1) tool instead of doxygen 
627
# built-in source browser. The htags tool is part of GNU's global source 
628
# tagging system (see http://www.gnu.org/software/global/global.html). You 
629
# will need version 4.8.6 or higher.
630
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
631
USE_HTAGS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
632
633
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
634
# will generate a verbatim copy of the header file for each class for 
635
# which an include is specified. Set to NO to disable this.
636
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
637
VERBATIM_HEADERS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
638
639
#---------------------------------------------------------------------------
640
# configuration options related to the alphabetical class index
641
#---------------------------------------------------------------------------
642
643
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
644
# of all compounds will be generated. Enable this if the project 
645
# contains a lot of classes, structs, unions or interfaces.
646
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
647
ALPHABETICAL_INDEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
648
649
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
650
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
651
# in which this list will be split (can be a number in the range [1..20])
652
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
653
COLS_IN_ALPHA_INDEX = 5
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
654
655
# In case all classes in a project start with a common prefix, all 
656
# classes will be put under the same header in the alphabetical index. 
657
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
658
# should be ignored while generating the index headers.
659
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
660
IGNORE_PREFIX = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
661
662
#---------------------------------------------------------------------------
663
# configuration options related to the HTML output
664
#---------------------------------------------------------------------------
665
666
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
667
# generate HTML output.
668
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
669
GENERATE_HTML = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
670
671
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
672
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
673
# put in front of it. If left blank `html' will be used as the default path.
674
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
675
HTML_OUTPUT = html
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
676
677
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
678
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
679
# doxygen will generate files with .html extension.
680
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
681
HTML_FILE_EXTENSION = .html
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
682
683
# The HTML_HEADER tag can be used to specify a personal HTML header for 
684
# each generated HTML page. If it is left blank doxygen will generate a 
685
# standard header.
686
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
687
HTML_HEADER = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
688
689
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
690
# each generated HTML page. If it is left blank doxygen will generate a 
691
# standard footer.
692
670 by Kay Roepke
added custom doxygen footer
693
HTML_FOOTER = doxygen-scripts/footer.html
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
694
695
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
696
# style sheet that is used by each HTML page. It can be used to 
697
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
698
# will generate a default style sheet. Note that doxygen will try to copy 
699
# the style sheet file to the HTML output directory, so don't put your own 
700
# stylesheet in the HTML output directory as well, or it will be erased!
701
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
702
HTML_STYLESHEET = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
703
704
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
705
# files or namespaces will be aligned in HTML using tables. If set to 
706
# NO a bullet list will be used.
707
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
708
HTML_ALIGN_MEMBERS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
709
710
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
711
# will be generated that can be used as input for tools like the 
712
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
713
# of the generated HTML documentation.
714
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
715
GENERATE_HTMLHELP = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
716
717
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
718
# documentation will contain sections that can be hidden and shown after the 
719
# page has loaded. For this to work a browser that supports 
720
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
721
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
722
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
723
HTML_DYNAMIC_SECTIONS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
724
725
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
726
# be used to specify the file name of the resulting .chm file. You 
727
# can add a path in front of the file if the result should not be 
728
# written to the html output directory.
729
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
730
CHM_FILE = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
731
732
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
733
# be used to specify the location (absolute path including file name) of 
734
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
735
# the HTML help compiler on the generated index.hhp.
736
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
737
HHC_LOCATION = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
738
739
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
740
# controls if a separate .chi index file is generated (YES) or that 
741
# it should be included in the master .chm file (NO).
742
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
743
GENERATE_CHI = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
744
745
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
746
# controls whether a binary table of contents is generated (YES) or a 
747
# normal table of contents (NO) in the .chm file.
748
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
749
BINARY_TOC = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
750
751
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
752
# to the contents of the HTML help documentation and to the tree view.
753
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
754
TOC_EXPAND = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
755
756
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
757
# top of each HTML page. The value NO (the default) enables the index and 
758
# the value YES disables it.
759
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
760
DISABLE_INDEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
761
762
# This tag can be used to set the number of enum values (range [1..20]) 
763
# that doxygen will group on one line in the generated HTML documentation.
764
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
765
ENUM_VALUES_PER_LINE = 4
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
766
767
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
768
# generated containing a tree-like index structure (just like the one that 
769
# is generated for HTML Help). For this to work a browser that supports 
770
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
771
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
772
# probably better off using the HTML help feature.
773
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
774
GENERATE_TREEVIEW = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
775
776
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
777
# used to set the initial width (in pixels) of the frame in which the tree 
778
# is shown.
779
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
780
TREEVIEW_WIDTH = 250
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
781
782
#---------------------------------------------------------------------------
783
# configuration options related to the LaTeX output
784
#---------------------------------------------------------------------------
785
786
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
787
# generate Latex output.
788
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
789
GENERATE_LATEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
790
791
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
792
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
793
# put in front of it. If left blank `latex' will be used as the default path.
794
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
795
LATEX_OUTPUT = latex
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
796
797
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
798
# invoked. If left blank `latex' will be used as the default command name.
799
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
800
LATEX_CMD_NAME = latex
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
801
802
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
803
# generate index for LaTeX. If left blank `makeindex' will be used as the 
804
# default command name.
805
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
806
MAKEINDEX_CMD_NAME = makeindex
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
807
808
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
809
# LaTeX documents. This may be useful for small projects and may help to 
810
# save some trees in general.
811
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
812
COMPACT_LATEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
813
814
# The PAPER_TYPE tag can be used to set the paper type that is used 
815
# by the printer. Possible values are: a4, a4wide, letter, legal and 
816
# executive. If left blank a4wide will be used.
817
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
818
PAPER_TYPE = a4wide
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
819
820
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
821
# packages that should be included in the LaTeX output.
822
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
823
EXTRA_PACKAGES = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
824
825
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
826
# the generated latex document. The header should contain everything until 
827
# the first chapter. If it is left blank doxygen will generate a 
828
# standard header. Notice: only use this tag if you know what you are doing!
829
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
830
LATEX_HEADER = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
831
832
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
833
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
834
# contain links (just like the HTML output) instead of page references 
835
# This makes the output suitable for online browsing using a pdf viewer.
836
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
837
PDF_HYPERLINKS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
838
839
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
840
# plain latex in the generated Makefile. Set this option to YES to get a 
841
# higher quality PDF documentation.
842
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
843
USE_PDFLATEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
844
845
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
846
# command to the generated LaTeX files. This will instruct LaTeX to keep 
847
# running if errors occur, instead of asking the user for help. 
848
# This option is also used when generating formulas in HTML.
849
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
850
LATEX_BATCHMODE = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
851
852
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
853
# include the index chapters (such as File Index, Compound Index, etc.) 
854
# in the output.
855
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
856
LATEX_HIDE_INDICES = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
857
858
#---------------------------------------------------------------------------
859
# configuration options related to the RTF output
860
#---------------------------------------------------------------------------
861
862
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
863
# The RTF output is optimized for Word 97 and may not look very pretty with 
864
# other RTF readers or editors.
865
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
866
GENERATE_RTF = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
867
868
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
869
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
870
# put in front of it. If left blank `rtf' will be used as the default path.
871
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
872
RTF_OUTPUT = rtf
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
873
874
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
875
# RTF documents. This may be useful for small projects and may help to 
876
# save some trees in general.
877
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
878
COMPACT_RTF = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
879
880
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
881
# will contain hyperlink fields. The RTF file will 
882
# contain links (just like the HTML output) instead of page references. 
883
# This makes the output suitable for online browsing using WORD or other 
884
# programs which support those fields. 
885
# Note: wordpad (write) and others do not support links.
886
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
887
RTF_HYPERLINKS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
888
889
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
890
# config file, i.e. a series of assignments. You only have to provide 
891
# replacements, missing definitions are set to their default value.
892
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
893
RTF_STYLESHEET_FILE = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
894
895
# Set optional variables used in the generation of an rtf document. 
896
# Syntax is similar to doxygen's config file.
897
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
898
RTF_EXTENSIONS_FILE = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
899
900
#---------------------------------------------------------------------------
901
# configuration options related to the man page output
902
#---------------------------------------------------------------------------
903
904
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
905
# generate man pages
906
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
907
GENERATE_MAN = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
908
909
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
910
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
911
# put in front of it. If left blank `man' will be used as the default path.
912
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
913
MAN_OUTPUT = man
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
914
915
# The MAN_EXTENSION tag determines the extension that is added to 
916
# the generated man pages (default is the subroutine's section .3)
917
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
918
MAN_EXTENSION = .3
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
919
920
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
921
# then it will generate one additional man file for each entity 
922
# documented in the real man page(s). These additional files 
923
# only source the real man page, but without them the man command 
924
# would be unable to find the correct page. The default is NO.
925
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
926
MAN_LINKS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
927
928
#---------------------------------------------------------------------------
929
# configuration options related to the XML output
930
#---------------------------------------------------------------------------
931
932
# If the GENERATE_XML tag is set to YES Doxygen will 
933
# generate an XML file that captures the structure of 
934
# the code including all documentation.
935
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
936
GENERATE_XML = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
937
938
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
939
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
940
# put in front of it. If left blank `xml' will be used as the default path.
941
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
942
XML_OUTPUT = xml
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
943
944
# The XML_SCHEMA tag can be used to specify an XML schema, 
945
# which can be used by a validating XML parser to check the 
946
# syntax of the XML files.
947
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
948
XML_SCHEMA = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
949
950
# The XML_DTD tag can be used to specify an XML DTD, 
951
# which can be used by a validating XML parser to check the 
952
# syntax of the XML files.
953
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
954
XML_DTD = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
955
956
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
957
# dump the program listings (including syntax highlighting 
958
# and cross-referencing information) to the XML output. Note that 
959
# enabling this will significantly increase the size of the XML output.
960
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
961
XML_PROGRAMLISTING = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
962
963
#---------------------------------------------------------------------------
964
# configuration options for the AutoGen Definitions output
965
#---------------------------------------------------------------------------
966
967
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
968
# generate an AutoGen Definitions (see autogen.sf.net) file 
969
# that captures the structure of the code including all 
970
# documentation. Note that this feature is still experimental 
971
# and incomplete at the moment.
972
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
973
GENERATE_AUTOGEN_DEF = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
974
975
#---------------------------------------------------------------------------
976
# configuration options related to the Perl module output
977
#---------------------------------------------------------------------------
978
979
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
980
# generate a Perl module file that captures the structure of 
981
# the code including all documentation. Note that this 
982
# feature is still experimental and incomplete at the 
983
# moment.
984
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
985
GENERATE_PERLMOD = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
986
987
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
988
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
989
# to generate PDF and DVI output from the Perl module output.
990
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
991
PERLMOD_LATEX = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
992
993
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
994
# nicely formatted so it can be parsed by a human reader.  This is useful 
995
# if you want to understand what is going on.  On the other hand, if this 
996
# tag is set to NO the size of the Perl module output will be much smaller 
997
# and Perl will parse it just the same.
998
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
999
PERLMOD_PRETTY = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1000
1001
# The names of the make variables in the generated doxyrules.make file 
1002
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1003
# This is useful so different doxyrules.make files included by the same 
1004
# Makefile don't overwrite each other's variables.
1005
1006
PERLMOD_MAKEVAR_PREFIX = 
1007
1008
#---------------------------------------------------------------------------
1009
# Configuration options related to the preprocessor   
1010
#---------------------------------------------------------------------------
1011
1012
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1013
# evaluate all C-preprocessor directives found in the sources and include 
1014
# files.
1015
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1016
ENABLE_PREPROCESSING = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1017
1018
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1019
# names in the source code. If set to NO (the default) only conditional 
1020
# compilation will be performed. Macro expansion can be done in a controlled 
1021
# way by setting EXPAND_ONLY_PREDEF to YES.
1022
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1023
MACRO_EXPANSION = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1024
1025
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1026
# then the macro expansion is limited to the macros specified with the 
1027
# PREDEFINED and EXPAND_AS_DEFINED tags.
1028
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1029
EXPAND_ONLY_PREDEF = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1030
1031
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1032
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1033
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1034
SEARCH_INCLUDES = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1035
1036
# The INCLUDE_PATH tag can be used to specify one or more directories that 
1037
# contain include files that are not input files but should be processed by 
1038
# the preprocessor.
1039
653 by Kay Roepke
add HAVE_LUA_H and HAVE_GTHREAD to doxygen's predefined macros, otherwise we are missing some members in lua_scope
1040
INCLUDE_PATH = src/
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1041
1042
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1043
# patterns (like *.h and *.hpp) to filter out the header-files in the 
1044
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
1045
# be used.
1046
653 by Kay Roepke
add HAVE_LUA_H and HAVE_GTHREAD to doxygen's predefined macros, otherwise we are missing some members in lua_scope
1047
INCLUDE_FILE_PATTERNS = *.h
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1048
1049
# The PREDEFINED tag can be used to specify one or more macro names that 
1050
# are defined before the preprocessor is started (similar to the -D option of 
1051
# gcc). The argument of the tag is a list of macros of the form: name 
1052
# or name=definition (no spaces). If the definition and the = are 
1053
# omitted =1 is assumed. To prevent a macro definition from being 
1054
# undefined via #undef or recursively expanded use the := operator 
1055
# instead of the = operator.
1056
653 by Kay Roepke
add HAVE_LUA_H and HAVE_GTHREAD to doxygen's predefined macros, otherwise we are missing some members in lua_scope
1057
PREDEFINED = GLIB_CHECK_VERSION(x,y,z)=1 HAVE_LUA_H HAVE_GTHREAD 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1058
1059
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1060
# this tag can be used to specify a list of macro names that should be expanded. 
1061
# The macro definition that is found in the sources will be used. 
1062
# Use the PREDEFINED tag if you want to use a different macro definition.
1063
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1064
EXPAND_AS_DEFINED = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1065
1066
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1067
# doxygen's preprocessor will remove all function-like macros that are alone 
1068
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
1069
# function macros are typically used for boiler-plate code, and will confuse 
1070
# the parser if not removed.
1071
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1072
SKIP_FUNCTION_MACROS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1073
1074
#---------------------------------------------------------------------------
1075
# Configuration::additions related to external references   
1076
#---------------------------------------------------------------------------
1077
1078
# The TAGFILES option can be used to specify one or more tagfiles. 
1079
# Optionally an initial location of the external documentation 
1080
# can be added for each tagfile. The format of a tag file without 
1081
# this location is as follows: 
1082
#   TAGFILES = file1 file2 ... 
1083
# Adding location for the tag files is done as follows: 
1084
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1085
# where "loc1" and "loc2" can be relative or absolute paths or 
1086
# URLs. If a location is present for each tag, the installdox tool 
1087
# does not have to be run to correct the links.
1088
# Note that each tag file must have a unique name
1089
# (where the name does NOT include the path)
1090
# If a tag file is not located in the directory in which doxygen 
1091
# is run, you must also specify the path to the tagfile here.
1092
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1093
TAGFILES = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1094
1095
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1096
# a tag file that is based on the input files it reads.
1097
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1098
GENERATE_TAGFILE = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1099
1100
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1101
# in the class index. If set to NO only the inherited external classes 
1102
# will be listed.
1103
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1104
ALLEXTERNALS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1105
1106
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1107
# in the modules index. If set to NO, only the current project's groups will 
1108
# be listed.
1109
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1110
EXTERNAL_GROUPS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1111
1112
# The PERL_PATH should be the absolute path and name of the perl script 
1113
# interpreter (i.e. the result of `which perl').
1114
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1115
PERL_PATH = /usr/bin/perl
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1116
1117
#---------------------------------------------------------------------------
1118
# Configuration options related to the dot tool   
1119
#---------------------------------------------------------------------------
1120
1121
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1122
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1123
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
1124
# this option is superseded by the HAVE_DOT option below. This is only a 
1125
# fallback. It is recommended to install and use dot, since it yields more 
1126
# powerful graphs.
1127
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1128
CLASS_DIAGRAMS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1129
1130
# You can define message sequence charts within doxygen comments using the \msc 
1131
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
1132
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
1133
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
1134
# be found in the default search path.
1135
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1136
MSCGEN_PATH = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1137
1138
# If set to YES, the inheritance and collaboration graphs will hide 
1139
# inheritance and usage relations if the target is undocumented 
1140
# or is not a class.
1141
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1142
HIDE_UNDOC_RELATIONS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1143
1144
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1145
# available from the path. This tool is part of Graphviz, a graph visualization 
1146
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1147
# have no effect if this option is set to NO (the default)
1148
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1149
HAVE_DOT = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1150
1151
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1152
# will generate a graph for each documented class showing the direct and 
1153
# indirect inheritance relations. Setting this tag to YES will force the 
1154
# the CLASS_DIAGRAMS tag to NO.
1155
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1156
CLASS_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1157
1158
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1159
# will generate a graph for each documented class showing the direct and 
1160
# indirect implementation dependencies (inheritance, containment, and 
1161
# class references variables) of the class with other documented classes.
1162
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1163
COLLABORATION_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1164
1165
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1166
# will generate a graph for groups, showing the direct groups dependencies
1167
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1168
GROUP_GRAPHS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1169
1170
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1171
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
1172
# Language.
1173
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1174
UML_LOOK = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1175
1176
# If set to YES, the inheritance and collaboration graphs will show the 
1177
# relations between templates and their instances.
1178
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1179
TEMPLATE_RELATIONS = NO
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1180
1181
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1182
# tags are set to YES then doxygen will generate a graph for each documented 
1183
# file showing the direct and indirect include dependencies of the file with 
1184
# other documented files.
1185
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1186
INCLUDE_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1187
1188
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1189
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1190
# documented header file showing the documented files that directly or 
1191
# indirectly include this file.
1192
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1193
INCLUDED_BY_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1194
1195
# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1196
# generate a call dependency graph for every global function or class method. 
1197
# Note that enabling this option will significantly increase the time of a run. 
1198
# So in most cases it will be better to enable call graphs for selected 
1199
# functions only using the \callgraph command.
1200
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1201
CALL_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1202
1203
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1204
# generate a caller dependency graph for every global function or class method. 
1205
# Note that enabling this option will significantly increase the time of a run. 
1206
# So in most cases it will be better to enable caller graphs for selected 
1207
# functions only using the \callergraph command.
1208
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1209
CALLER_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1210
1211
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1212
# will graphical hierarchy of all classes instead of a textual one.
1213
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1214
GRAPHICAL_HIERARCHY = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1215
1216
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1217
# then doxygen will show the dependencies a directory has on other directories 
1218
# in a graphical way. The dependency relations are determined by the #include
1219
# relations between the files in the directories.
1220
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1221
DIRECTORY_GRAPH = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1222
1223
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1224
# generated by dot. Possible values are png, jpg, or gif
1225
# If left blank png will be used.
1226
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1227
DOT_IMAGE_FORMAT = png
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1228
1229
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
1230
# found. If left blank, it is assumed the dot tool can be found in the path.
1231
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1232
DOT_PATH = 
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1233
1234
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
1235
# contain dot files that are included in the documentation (see the 
1236
# \dotfile command).
1237
664 by jan at mysql
added the examples and the lua-classes to the documentation
1238
DOTFILE_DIRS = doc/
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1239
1240
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1241
# nodes that will be shown in the graph. If the number of nodes in a graph 
1242
# becomes larger than this value, doxygen will truncate the graph, which is 
1243
# visualized by representing a node as a red box. Note that doxygen if the number 
1244
# of direct children of the root node in a graph is already larger than 
1245
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 
1246
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1247
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1248
DOT_GRAPH_MAX_NODES = 50
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1249
1250
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1251
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
1252
# from the root by following a path via at most 3 edges will be shown. Nodes 
1253
# that lay further from the root node will be omitted. Note that setting this 
1254
# option to 1 or 2 may greatly reduce the computation time needed for large 
1255
# code bases. Also note that the size of a graph can be further restricted by 
1256
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1257
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1258
MAX_DOT_GRAPH_DEPTH = 0
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1259
1260
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1261
# background. This is disabled by default, which results in a white background. 
1262
# Warning: Depending on the platform used, enabling this option may lead to 
1263
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1264
# read).
1265
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1266
DOT_TRANSPARENT = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1267
1268
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1269
# files in one run (i.e. multiple -o and -T options on the command line). This 
1270
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
1271
# support this, this feature is disabled by default.
1272
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1273
DOT_MULTI_TARGETS = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1274
1275
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1276
# generate a legend page explaining the meaning of the various boxes and 
1277
# arrows in the dot generated graphs.
1278
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1279
GENERATE_LEGEND = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1280
1281
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1282
# remove the intermediate dot files that are used to generate 
1283
# the various graphs.
1284
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1285
DOT_CLEANUP = YES
242 by jkneschke
added a walk-through and the doc-comments for Doxygen
1286
1287
#---------------------------------------------------------------------------
1288
# Configuration::additions related to the search engine   
1289
#---------------------------------------------------------------------------
1290
1291
# The SEARCHENGINE tag specifies whether or not a search engine should be 
1292
# used. If set to NO the values of all tags below this one will be ignored.
1293
646 by Kay Roepke
improve preprocessing, include call/caller graphs, don't show the TODO list for now, it's too cluttered
1294
SEARCHENGINE = NO