Browse code

doxygen config file, so ppl just have to call doxygen in the libavcodec dir and a beatifull doxy is generated ;)

Originally committed as revision 1631 to svn://svn.ffmpeg.org/ffmpeg/trunk

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