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