~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/Doxyfile.api

  • Committer: Monty Taylor
  • Date: 2010-08-12 20:27:32 UTC
  • mto: (1720.1.5 build)
  • mto: This revision was merged to the branch mainline in revision 1722.
  • Revision ID: mordred@inaugust.com-20100812202732-9kzchbkvkyki4n3u
Merged libdrizzle directly into tree.

Show diffs side-by-side

added added

removed removed

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