~drizzle-trunk/drizzle/development

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