Statistics
| Branch: | Revision:

ffmpeg / Doxyfile @ f31abc6c

History | View | Annotate | Download (40 KB)

1
# Doxyfile 1.3-rc1
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           = FFmpeg
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       = doxy
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, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
43

    
44
OUTPUT_LANGUAGE        = English
45

    
46
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
47
# include brief member descriptions after the members that are listed in
48
# the file and class documentation (similar to JavaDoc).
49
# Set to NO to disable this.
50

    
51
BRIEF_MEMBER_DESC      = YES
52

    
53
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
54
# the brief description of a member or function before the detailed description.
55
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
56
# brief descriptions will be completely suppressed.
57

    
58
REPEAT_BRIEF           = YES
59

    
60
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
61
# Doxygen will generate a detailed section even if there is only a brief
62
# description.
63

    
64
ALWAYS_DETAILED_SEC    = NO
65

    
66
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
67
# inherited members of a class in the documentation of that class as if those
68
# members were ordinary class members. Constructors, destructors and assignment
69
# operators of the base classes will not be shown.
70

    
71
INLINE_INHERITED_MEMB  = NO
72

    
73
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
74
# path before files name in the file list and in the header files. If set
75
# to NO the shortest path that makes the file name unique will be used.
76

    
77
FULL_PATH_NAMES        = YES
78

    
79
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
80
# can be used to strip a user-defined part of the path. Stripping is
81
# only done if one of the specified strings matches the left-hand part of
82
# the path. It is allowed to use relative paths in the argument list.
83

    
84
STRIP_FROM_PATH        = .
85

    
86
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
87
# (but less readable) file names. This can be useful is your file systems
88
# doesn't support long names like on DOS, Mac, or CD-ROM.
89

    
90
SHORT_NAMES            = NO
91

    
92
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
93
# will interpret the first line (until the first dot) of a JavaDoc-style
94
# comment as the brief description. If set to NO, the JavaDoc
95
# comments will behave just like regular Qt-style comments
96
# (thus requiring an explicit @brief command for a brief description.)
97

    
98
JAVADOC_AUTOBRIEF      = YES
99

    
100
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
101
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
102
# comments) as a brief description. This used to be the default behaviour.
103
# The new default is to treat a multi-line C++ comment block as a detailed
104
# description. Set this tag to YES if you prefer the old behaviour instead.
105

    
106
MULTILINE_CPP_IS_BRIEF = NO
107

    
108
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
109
# will output the detailed description near the top, like JavaDoc.
110
# If set to NO, the detailed description appears after the member
111
# documentation.
112

    
113
DETAILS_AT_TOP         = NO
114

    
115
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
116
# member inherits the documentation from any documented member that it
117
# re-implements.
118

    
119
INHERIT_DOCS           = YES
120

    
121
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
122
# Doxygen uses this value to replace tabs by spaces in code fragments.
123

    
124
TAB_SIZE               = 8
125

    
126
# This tag can be used to specify a number of aliases that acts
127
# as commands in the documentation. An alias has the form "name=value".
128
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
129
# put the command \sideeffect (or @sideeffect) in the documentation, which
130
# will result in a user-defined paragraph with heading "Side Effects:".
131
# You can put \n's in the value part of an alias to insert newlines.
132

    
133
ALIASES                =
134

    
135
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
136
# sources only. Doxygen will then generate output that is more tailored for C.
137
# For instance, some of the names that are used will be different. The list
138
# of all members will be omitted, etc.
139

    
140
OPTIMIZE_OUTPUT_FOR_C  = YES
141

    
142
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
143
# sources only. Doxygen will then generate output that is more tailored for
144
# Java. For instance, namespaces will be presented as packages, qualified
145
# scopes will look different, etc.
146

    
147
OPTIMIZE_OUTPUT_JAVA   = NO
148

    
149
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
150
# documentation are documented, even if no documentation was available.
151
# Private class members and static file members will be hidden unless
152
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
153

    
154
EXTRACT_ALL            = YES
155

    
156
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
157
# will be included in the documentation.
158

    
159
EXTRACT_PRIVATE        = YES
160

    
161
# If the EXTRACT_STATIC tag is set to YES all static members of a file
162
# will be included in the documentation.
163

    
164
EXTRACT_STATIC         = YES
165

    
166
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
167
# defined locally in source files will be included in the documentation.
168
# If set to NO only classes defined in header files are included.
169

    
170
EXTRACT_LOCAL_CLASSES  = YES
171

    
172
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
173
# undocumented members of documented classes, files or namespaces.
174
# If set to NO (the default) these members will be included in the
175
# various overviews, but no documentation section is generated.
176
# This option has no effect if EXTRACT_ALL is enabled.
177

    
178
HIDE_UNDOC_MEMBERS     = NO
179

    
180
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
181
# undocumented classes that are normally visible in the class hierarchy.
182
# If set to NO (the default) these classes will be included in the various
183
# overviews. This option has no effect if EXTRACT_ALL is enabled.
184

    
185
HIDE_UNDOC_CLASSES     = NO
186

    
187
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
188
# friend (class|struct|union) declarations.
189
# If set to NO (the default) these declarations will be included in the
190
# documentation.
191

    
192
HIDE_FRIEND_COMPOUNDS  = NO
193

    
194
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
195
# documentation blocks found inside the body of a function.
196
# If set to NO (the default) these blocks will be appended to the
197
# function's detailed documentation block.
198

    
199
HIDE_IN_BODY_DOCS      = NO
200

    
201
# The INTERNAL_DOCS tag determines if documentation
202
# that is typed after a \internal command is included. If the tag is set
203
# to NO (the default) then the documentation will be excluded.
204
# Set it to YES to include the internal documentation.
205

    
206
INTERNAL_DOCS          = NO
207

    
208
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
209
# file names in lower-case letters. If set to YES upper-case letters are also
210
# allowed. This is useful if you have classes or files whose names only differ
211
# in case and if your file system supports case sensitive file names. Windows
212
# users are adviced to set this option to NO.
213

    
214
CASE_SENSE_NAMES       = YES
215

    
216
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
217
# will show members with their full class and namespace scopes in the
218
# documentation. If set to YES the scope will be hidden.
219

    
220
HIDE_SCOPE_NAMES       = NO
221

    
222
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
223
# will put a list of the files that are included by a file in the documentation
224
# of that file.
225

    
226
SHOW_INCLUDE_FILES     = YES
227

    
228
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
229
# is inserted in the documentation for inline members.
230

    
231
INLINE_INFO            = YES
232

    
233
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
234
# will sort the (detailed) documentation of file and class members
235
# alphabetically by member name. If set to NO the members will appear in
236
# declaration order.
237

    
238
SORT_MEMBER_DOCS       = YES
239

    
240
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
241
# tag is set to YES, then doxygen will reuse the documentation of the first
242
# member in the group (if any) for the other members of the group. By default
243
# all members of a group must be documented explicitly.
244

    
245
DISTRIBUTE_GROUP_DOC   = NO
246

    
247
# The GENERATE_TODOLIST tag can be used to enable (YES) or
248
# disable (NO) the todo list. This list is created by putting \todo
249
# commands in the documentation.
250

    
251
GENERATE_TODOLIST      = YES
252

    
253
# The GENERATE_TESTLIST tag can be used to enable (YES) or
254
# disable (NO) the test list. This list is created by putting \test
255
# commands in the documentation.
256

    
257
GENERATE_TESTLIST      = YES
258

    
259
# The GENERATE_BUGLIST tag can be used to enable (YES) or
260
# disable (NO) the bug list. This list is created by putting \bug
261
# commands in the documentation.
262

    
263
GENERATE_BUGLIST       = YES
264

    
265
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
266
# disable (NO) the deprecated list. This list is created by putting
267
# \deprecated commands in the documentation.
268

    
269
GENERATE_DEPRECATEDLIST= YES
270

    
271
# The ENABLED_SECTIONS tag can be used to enable conditional
272
# documentation sections, marked by \if sectionname ... \endif.
273

    
274
ENABLED_SECTIONS       =
275

    
276
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
277
# the initial value of a variable or define consists of for it to appear in
278
# the documentation. If the initializer consists of more lines than specified
279
# here it will be hidden. Use a value of 0 to hide initializers completely.
280
# The appearance of the initializer of individual variables and defines in the
281
# documentation can be controlled using \showinitializer or \hideinitializer
282
# command in the documentation regardless of this setting.
283

    
284
MAX_INITIALIZER_LINES  = 30
285

    
286
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
287
# at the bottom of the documentation of classes and structs. If set to YES the
288
# list will mention the files that were used to generate the documentation.
289

    
290
SHOW_USED_FILES        = YES
291

    
292
#---------------------------------------------------------------------------
293
# configuration options related to warning and progress messages
294
#---------------------------------------------------------------------------
295

    
296
# The QUIET tag can be used to turn on/off the messages that are generated
297
# by doxygen. Possible values are YES and NO. If left blank NO is used.
298

    
299
QUIET                  = NO
300

    
301
# The WARNINGS tag can be used to turn on/off the warning messages that are
302
# generated by doxygen. Possible values are YES and NO. If left blank
303
# NO is used.
304

    
305
WARNINGS               = YES
306

    
307
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
308
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
309
# automatically be disabled.
310

    
311
WARN_IF_UNDOCUMENTED   = YES
312

    
313
# The WARN_FORMAT tag determines the format of the warning messages that
314
# doxygen can produce. The string should contain the $file, $line, and $text
315
# tags, which will be replaced by the file and line number from which the
316
# warning originated and the warning text.
317

    
318
WARN_FORMAT            = "$file:$line: $text"
319

    
320
# The WARN_LOGFILE tag can be used to specify a file to which warning
321
# and error messages should be written. If left blank the output is written
322
# to stderr.
323

    
324
WARN_LOGFILE           =
325

    
326
#---------------------------------------------------------------------------
327
# configuration options related to the input files
328
#---------------------------------------------------------------------------
329

    
330
# The INPUT tag can be used to specify the files and/or directories that contain
331
# documented source files. You may enter file names like "myfile.cpp" or
332
# directories like "/usr/src/myproject". Separate the files or directories
333
# with spaces.
334

    
335
INPUT                  =
336

    
337
# If the value of the INPUT tag contains directories, you can use the
338
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
339
# and *.h) to filter out the source-files in the directories. If left
340
# blank the following patterns are tested:
341
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
342
# *.h++ *.idl *.odl
343

    
344
FILE_PATTERNS          =
345

    
346
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
347
# should be searched for input files as well. Possible values are YES and NO.
348
# If left blank NO is used.
349

    
350
RECURSIVE              = YES
351

    
352
# The EXCLUDE tag can be used to specify files and/or directories that should
353
# excluded from the INPUT source files. This way you can easily exclude a
354
# subdirectory from a directory tree whose root is specified with the INPUT tag.
355

    
356
EXCLUDE                =
357

    
358
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
359
# directories that are symbolic links (a Unix filesystem feature) are excluded
360
# from the input.
361

    
362
EXCLUDE_SYMLINKS       = NO
363

    
364
# If the value of the INPUT tag contains directories, you can use the
365
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
366
# certain files from those directories.
367

    
368
EXCLUDE_PATTERNS       = *.svn *.git
369

    
370
# The EXAMPLE_PATH tag can be used to specify one or more files or
371
# directories that contain example code fragments that are included (see
372
# the \include command).
373

    
374
EXAMPLE_PATH           =
375

    
376
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
377
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
378
# and *.h) to filter out the source-files in the directories. If left
379
# blank all files are included.
380

    
381
EXAMPLE_PATTERNS       =
382

    
383
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
384
# searched for input files to be used with the \include or \dontinclude
385
# commands irrespective of the value of the RECURSIVE tag.
386
# Possible values are YES and NO. If left blank NO is used.
387

    
388
EXAMPLE_RECURSIVE      = NO
389

    
390
# The IMAGE_PATH tag can be used to specify one or more files or
391
# directories that contain image that are included in the documentation (see
392
# the \image command).
393

    
394
IMAGE_PATH             =
395

    
396
# The INPUT_FILTER tag can be used to specify a program that doxygen should
397
# invoke to filter for each input file. Doxygen will invoke the filter program
398
# by executing (via popen()) the command <filter> <input-file>, where <filter>
399
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
400
# input file. Doxygen will then use the output that the filter program writes
401
# to standard output.
402

    
403
INPUT_FILTER           =
404

    
405
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
406
# INPUT_FILTER) will be used to filter the input files when producing source
407
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
408

    
409
FILTER_SOURCE_FILES    = NO
410

    
411
#---------------------------------------------------------------------------
412
# configuration options related to source browsing
413
#---------------------------------------------------------------------------
414

    
415
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
416
# be generated. Documented entities will be cross-referenced with these sources.
417

    
418
SOURCE_BROWSER         = YES
419

    
420
# Setting the INLINE_SOURCES tag to YES will include the body
421
# of functions and classes directly in the documentation.
422

    
423
INLINE_SOURCES         = NO
424

    
425
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
426
# doxygen to hide any special comment blocks from generated source code
427
# fragments. Normal C and C++ comments will always remain visible.
428

    
429
STRIP_CODE_COMMENTS    = YES
430

    
431
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
432
# then for each documented function all documented
433
# functions referencing it will be listed.
434

    
435
REFERENCED_BY_RELATION = YES
436

    
437
# If the REFERENCES_RELATION tag is set to YES (the default)
438
# then for each documented function all documented entities
439
# called/used by that function will be listed.
440

    
441
REFERENCES_RELATION    = NO
442

    
443
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
444
# will generate a verbatim copy of the header file for each class for
445
# which an include is specified. Set to NO to disable this.
446

    
447
VERBATIM_HEADERS       = YES
448

    
449
#---------------------------------------------------------------------------
450
# configuration options related to the alphabetical class index
451
#---------------------------------------------------------------------------
452

    
453
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
454
# of all compounds will be generated. Enable this if the project
455
# contains a lot of classes, structs, unions or interfaces.
456

    
457
ALPHABETICAL_INDEX     = YES
458

    
459
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
460
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
461
# in which this list will be split (can be a number in the range [1..20])
462

    
463
COLS_IN_ALPHA_INDEX    = 5
464

    
465
# In case all classes in a project start with a common prefix, all
466
# classes will be put under the same header in the alphabetical index.
467
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
468
# should be ignored while generating the index headers.
469

    
470
IGNORE_PREFIX          =
471

    
472
#---------------------------------------------------------------------------
473
# configuration options related to the HTML output
474
#---------------------------------------------------------------------------
475

    
476
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
477
# generate HTML output.
478

    
479
GENERATE_HTML          = YES
480

    
481
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
482
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
483
# put in front of it. If left blank `html' will be used as the default path.
484

    
485
HTML_OUTPUT            = html
486

    
487
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
488
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
489
# doxygen will generate files with .html extension.
490

    
491
HTML_FILE_EXTENSION    = .html
492

    
493
# The HTML_HEADER tag can be used to specify a personal HTML header for
494
# each generated HTML page. If it is left blank doxygen will generate a
495
# standard header.
496

    
497
HTML_HEADER            =
498

    
499
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
500
# each generated HTML page. If it is left blank doxygen will generate a
501
# standard footer.
502

    
503
HTML_FOOTER            =
504

    
505
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
506
# style sheet that is used by each HTML page. It can be used to
507
# fine-tune the look of the HTML output. If the tag is left blank doxygen
508
# will generate a default style sheet
509

    
510
HTML_STYLESHEET        =
511

    
512
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
513
# files or namespaces will be aligned in HTML using tables. If set to
514
# NO a bullet list will be used.
515

    
516
HTML_ALIGN_MEMBERS     = YES
517

    
518
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
519
# will be generated that can be used as input for tools like the
520
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
521
# of the generated HTML documentation.
522

    
523
GENERATE_HTMLHELP      = NO
524

    
525
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
526
# be used to specify the file name of the resulting .chm file. You
527
# can add a path in front of the file if the result should not be
528
# written to the html output directory.
529

    
530
CHM_FILE               =
531

    
532
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
533
# be used to specify the location (absolute path including file name) of
534
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
535
# the HTML help compiler on the generated index.hhp.
536

    
537
HHC_LOCATION           =
538

    
539
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
540
# controls if a separate .chi index file is generated (YES) or that
541
# it should be included in the master .chm file (NO).
542

    
543
GENERATE_CHI           = NO
544

    
545
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
546
# controls whether a binary table of contents is generated (YES) or a
547
# normal table of contents (NO) in the .chm file.
548

    
549
BINARY_TOC             = NO
550

    
551
# The TOC_EXPAND flag can be set to YES to add extra items for group members
552
# to the contents of the HTML help documentation and to the tree view.
553

    
554
TOC_EXPAND             = NO
555

    
556
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
557
# top of each HTML page. The value NO (the default) enables the index and
558
# the value YES disables it.
559

    
560
DISABLE_INDEX          = NO
561

    
562
# This tag can be used to set the number of enum values (range [1..20])
563
# that doxygen will group on one line in the generated HTML documentation.
564

    
565
ENUM_VALUES_PER_LINE   = 4
566

    
567
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
568
# generated containing a tree-like index structure (just like the one that
569
# is generated for HTML Help). For this to work a browser that supports
570
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
571
# or Internet explorer 4.0+). Note that for large projects the tree generation
572
# can take a very long time. In such cases it is better to disable this feature.
573
# Windows users are probably better off using the HTML help feature.
574

    
575
GENERATE_TREEVIEW      = NO
576

    
577
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
578
# used to set the initial width (in pixels) of the frame in which the tree
579
# is shown.
580

    
581
TREEVIEW_WIDTH         = 250
582

    
583
#---------------------------------------------------------------------------
584
# configuration options related to the LaTeX output
585
#---------------------------------------------------------------------------
586

    
587
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
588
# generate Latex output.
589

    
590
GENERATE_LATEX         = YES
591

    
592
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
593
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
594
# put in front of it. If left blank `latex' will be used as the default path.
595

    
596
LATEX_OUTPUT           = latex
597

    
598
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
599
# invoked. If left blank `latex' will be used as the default command name.
600

    
601
LATEX_CMD_NAME         = latex
602

    
603
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
604
# generate index for LaTeX. If left blank `makeindex' will be used as the
605
# default command name.
606

    
607
MAKEINDEX_CMD_NAME     = makeindex
608

    
609
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
610
# LaTeX documents. This may be useful for small projects and may help to
611
# save some trees in general.
612

    
613
COMPACT_LATEX          = NO
614

    
615
# The PAPER_TYPE tag can be used to set the paper type that is used
616
# by the printer. Possible values are: a4, a4wide, letter, legal and
617
# executive. If left blank a4wide will be used.
618

    
619
PAPER_TYPE             = a4wide
620

    
621
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
622
# packages that should be included in the LaTeX output.
623

    
624
EXTRA_PACKAGES         =
625

    
626
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
627
# the generated latex document. The header should contain everything until
628
# the first chapter. If it is left blank doxygen will generate a
629
# standard header. Notice: only use this tag if you know what you are doing!
630

    
631
LATEX_HEADER           =
632

    
633
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
634
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
635
# contain links (just like the HTML output) instead of page references
636
# This makes the output suitable for online browsing using a pdf viewer.
637

    
638
PDF_HYPERLINKS         = NO
639

    
640
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
641
# plain latex in the generated Makefile. Set this option to YES to get a
642
# higher quality PDF documentation.
643

    
644
USE_PDFLATEX           = NO
645

    
646
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
647
# command to the generated LaTeX files. This will instruct LaTeX to keep
648
# running if errors occur, instead of asking the user for help.
649
# This option is also used when generating formulas in HTML.
650

    
651
LATEX_BATCHMODE        = NO
652

    
653
#---------------------------------------------------------------------------
654
# configuration options related to the RTF output
655
#---------------------------------------------------------------------------
656

    
657
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
658
# The RTF output is optimized for Word 97 and may not look very pretty with
659
# other RTF readers or editors.
660

    
661
GENERATE_RTF           = NO
662

    
663
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
664
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
665
# put in front of it. If left blank `rtf' will be used as the default path.
666

    
667
RTF_OUTPUT             = rtf
668

    
669
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
670
# RTF documents. This may be useful for small projects and may help to
671
# save some trees in general.
672

    
673
COMPACT_RTF            = NO
674

    
675
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
676
# will contain hyperlink fields. The RTF file will
677
# contain links (just like the HTML output) instead of page references.
678
# This makes the output suitable for online browsing using WORD or other
679
# programs which support those fields.
680
# Note: wordpad (write) and others do not support links.
681

    
682
RTF_HYPERLINKS         = NO
683

    
684
# Load stylesheet definitions from file. Syntax is similar to doxygen's
685
# config file, i.e. a series of assignments. You only have to provide
686
# replacements, missing definitions are set to their default value.
687

    
688
RTF_STYLESHEET_FILE    =
689

    
690
# Set optional variables used in the generation of an rtf document.
691
# Syntax is similar to doxygen's config file.
692

    
693
RTF_EXTENSIONS_FILE    =
694

    
695
#---------------------------------------------------------------------------
696
# configuration options related to the man page output
697
#---------------------------------------------------------------------------
698

    
699
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
700
# generate man pages
701

    
702
GENERATE_MAN           = NO
703

    
704
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
705
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
706
# put in front of it. If left blank `man' will be used as the default path.
707

    
708
MAN_OUTPUT             = man
709

    
710
# The MAN_EXTENSION tag determines the extension that is added to
711
# the generated man pages (default is the subroutine's section .3)
712

    
713
MAN_EXTENSION          = .3
714

    
715
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
716
# then it will generate one additional man file for each entity
717
# documented in the real man page(s). These additional files
718
# only source the real man page, but without them the man command
719
# would be unable to find the correct page. The default is NO.
720

    
721
MAN_LINKS              = NO
722

    
723
#---------------------------------------------------------------------------
724
# configuration options related to the XML output
725
#---------------------------------------------------------------------------
726

    
727
# If the GENERATE_XML tag is set to YES Doxygen will
728
# generate an XML file that captures the structure of
729
# the code including all documentation. Note that this
730
# feature is still experimental and incomplete at the
731
# moment.
732

    
733
GENERATE_XML           = NO
734

    
735
# The XML_SCHEMA tag can be used to specify an XML schema,
736
# which can be used by a validating XML parser to check the
737
# syntax of the XML files.
738

    
739
XML_SCHEMA             =
740

    
741
# The XML_DTD tag can be used to specify an XML DTD,
742
# which can be used by a validating XML parser to check the
743
# syntax of the XML files.
744

    
745
XML_DTD                =
746

    
747
#---------------------------------------------------------------------------
748
# configuration options for the AutoGen Definitions output
749
#---------------------------------------------------------------------------
750

    
751
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
752
# generate an AutoGen Definitions (see autogen.sf.net) file
753
# that captures the structure of the code including all
754
# documentation. Note that this feature is still experimental
755
# and incomplete at the moment.
756

    
757
GENERATE_AUTOGEN_DEF   = NO
758

    
759
#---------------------------------------------------------------------------
760
# configuration options related to the Perl module output
761
#---------------------------------------------------------------------------
762

    
763
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
764
# generate a Perl module file that captures the structure of
765
# the code including all documentation. Note that this
766
# feature is still experimental and incomplete at the
767
# moment.
768

    
769
GENERATE_PERLMOD       = NO
770

    
771
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
772
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
773
# to generate PDF and DVI output from the Perl module output.
774

    
775
PERLMOD_LATEX          = NO
776

    
777
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
778
# nicely formatted so it can be parsed by a human reader.  This is useful
779
# if you want to understand what is going on.  On the other hand, if this
780
# tag is set to NO the size of the Perl module output will be much smaller
781
# and Perl will parse it just the same.
782

    
783
PERLMOD_PRETTY         = YES
784

    
785
# The names of the make variables in the generated doxyrules.make file
786
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
787
# This is useful so different doxyrules.make files included by the same
788
# Makefile don't overwrite each other's variables.
789

    
790
PERLMOD_MAKEVAR_PREFIX =
791

    
792
#---------------------------------------------------------------------------
793
# Configuration options related to the preprocessor
794
#---------------------------------------------------------------------------
795

    
796
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
797
# evaluate all C-preprocessor directives found in the sources and include
798
# files.
799

    
800
ENABLE_PREPROCESSING   = YES
801

    
802
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
803
# names in the source code. If set to NO (the default) only conditional
804
# compilation will be performed. Macro expansion can be done in a controlled
805
# way by setting EXPAND_ONLY_PREDEF to YES.
806

    
807
MACRO_EXPANSION        = YES
808

    
809
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
810
# then the macro expansion is limited to the macros specified with the
811
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
812

    
813
EXPAND_ONLY_PREDEF     = YES
814

    
815
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
816
# in the INCLUDE_PATH (see below) will be search if a #include is found.
817

    
818
SEARCH_INCLUDES        = YES
819

    
820
# The INCLUDE_PATH tag can be used to specify one or more directories that
821
# contain include files that are not input files but should be processed by
822
# the preprocessor.
823

    
824
INCLUDE_PATH           =
825

    
826
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
827
# patterns (like *.h and *.hpp) to filter out the header-files in the
828
# directories. If left blank, the patterns specified with FILE_PATTERNS will
829
# be used.
830

    
831
INCLUDE_FILE_PATTERNS  =
832

    
833
# The PREDEFINED tag can be used to specify one or more macro names that
834
# are defined before the preprocessor is started (similar to the -D option of
835
# gcc). The argument of the tag is a list of macros of the form: name
836
# or name=definition (no spaces). If the definition and the = are
837
# omitted =1 is assumed.
838

    
839
PREDEFINED             = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
840
                         HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
841

    
842
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
843
# this tag can be used to specify a list of macro names that should be expanded.
844
# The macro definition that is found in the sources will be used.
845
# Use the PREDEFINED tag if you want to use a different macro definition.
846

    
847
#EXPAND_AS_DEFINED      = FF_COMMON_FRAME
848
EXPAND_AS_DEFINED      = declare_idct(idct, table, idct_row_head, idct_row, idct_row_tail, idct_row_mid)
849

    
850
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
851
# doxygen's preprocessor will remove all function-like macros that are alone
852
# on a line, have an all uppercase name, and do not end with a semicolon. Such
853
# function macros are typically used for boiler-plate code, and will confuse
854
# the parser if not removed.
855

    
856
SKIP_FUNCTION_MACROS   = YES
857

    
858
#---------------------------------------------------------------------------
859
# Configuration::additions related to external references
860
#---------------------------------------------------------------------------
861

    
862
# The TAGFILES option can be used to specify one or more tagfiles.
863

    
864
TAGFILES               =
865

    
866
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
867
# a tag file that is based on the input files it reads.
868

    
869
GENERATE_TAGFILE       =
870

    
871
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
872
# in the class index. If set to NO only the inherited external classes
873
# will be listed.
874

    
875
ALLEXTERNALS           = NO
876

    
877
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
878
# in the modules index. If set to NO, only the current project's groups will
879
# be listed.
880

    
881
EXTERNAL_GROUPS        = YES
882

    
883
# The PERL_PATH should be the absolute path and name of the perl script
884
# interpreter (i.e. the result of `which perl').
885

    
886
PERL_PATH              = /usr/bin/perl
887

    
888
#---------------------------------------------------------------------------
889
# Configuration options related to the dot tool
890
#---------------------------------------------------------------------------
891

    
892
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
893
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
894
# or super classes. Setting the tag to NO turns the diagrams off. Note that
895
# this option is superseded by the HAVE_DOT option below. This is only a
896
# fallback. It is recommended to install and use dot, since it yields more
897
# powerful graphs.
898

    
899
CLASS_DIAGRAMS         = YES
900

    
901
# If set to YES, the inheritance and collaboration graphs will hide
902
# inheritance and usage relations if the target is undocumented
903
# or is not a class.
904

    
905
HIDE_UNDOC_RELATIONS   = YES
906

    
907
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
908
# available from the path. This tool is part of Graphviz, a graph visualization
909
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
910
# have no effect if this option is set to NO (the default)
911

    
912
HAVE_DOT               = NO
913

    
914
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
915
# will generate a graph for each documented class showing the direct and
916
# indirect inheritance relations. Setting this tag to YES will force the
917
# the CLASS_DIAGRAMS tag to NO.
918

    
919
CLASS_GRAPH            = YES
920

    
921
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
922
# will generate a graph for each documented class showing the direct and
923
# indirect implementation dependencies (inheritance, containment, and
924
# class references variables) of the class with other documented classes.
925

    
926
COLLABORATION_GRAPH    = YES
927

    
928
# If set to YES, the inheritance and collaboration graphs will show the
929
# relations between templates and their instances.
930

    
931
TEMPLATE_RELATIONS     = YES
932

    
933
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
934
# tags are set to YES then doxygen will generate a graph for each documented
935
# file showing the direct and indirect include dependencies of the file with
936
# other documented files.
937

    
938
INCLUDE_GRAPH          = YES
939

    
940
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
941
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
942
# documented header file showing the documented files that directly or
943
# indirectly include this file.
944

    
945
INCLUDED_BY_GRAPH      = YES
946

    
947
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
948
# will graphical hierarchy of all classes instead of a textual one.
949

    
950
GRAPHICAL_HIERARCHY    = YES
951

    
952
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
953
# generated by dot. Possible values are png, jpg, or gif
954
# If left blank png will be used.
955

    
956
DOT_IMAGE_FORMAT       = png
957

    
958
# The tag DOT_PATH can be used to specify the path where the dot tool can be
959
# found. If left blank, it is assumed the dot tool can be found in the path.
960

    
961
DOT_PATH               =
962

    
963
# The DOTFILE_DIRS tag can be used to specify one or more directories that
964
# contain dot files that are included in the documentation (see the
965
# \dotfile command).
966

    
967
DOTFILE_DIRS           =
968

    
969
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
970
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
971
# this value, doxygen will try to truncate the graph, so that it fits within
972
# the specified constraint. Beware that most browsers cannot cope with very
973
# large images.
974

    
975
MAX_DOT_GRAPH_WIDTH    = 1024
976

    
977
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
978
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
979
# this value, doxygen will try to truncate the graph, so that it fits within
980
# the specified constraint. Beware that most browsers cannot cope with very
981
# large images.
982

    
983
MAX_DOT_GRAPH_HEIGHT   = 1024
984

    
985
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
986
# generate a legend page explaining the meaning of the various boxes and
987
# arrows in the dot generated graphs.
988

    
989
GENERATE_LEGEND        = YES
990

    
991
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
992
# remove the intermediate dot files that are used to generate
993
# the various graphs.
994

    
995
DOT_CLEANUP            = YES
996

    
997
#---------------------------------------------------------------------------
998
# Configuration::additions related to the search engine
999
#---------------------------------------------------------------------------
1000

    
1001
# The SEARCHENGINE tag specifies whether or not a search engine should be
1002
# used. If set to NO the values of all tags below this one will be ignored.
1003

    
1004
SEARCHENGINE           = NO
1005

    
1006
# The CGI_NAME tag should be the name of the CGI script that
1007
# starts the search engine (doxysearch) with the correct parameters.
1008
# A script with this name will be generated by doxygen.
1009

    
1010
CGI_NAME               = search.cgi
1011

    
1012
# The CGI_URL tag should be the absolute URL to the directory where the
1013
# cgi binaries are located. See the documentation of your http daemon for
1014
# details.
1015

    
1016
CGI_URL                =
1017

    
1018
# The DOC_URL tag should be the absolute URL to the directory where the
1019
# documentation is located. If left blank the absolute path to the
1020
# documentation, with file:// prepended to it, will be used.
1021

    
1022
DOC_URL                =
1023

    
1024
# The DOC_ABSPATH tag should be the absolute path to the directory where the
1025
# documentation is located. If left blank the directory on the local machine
1026
# will be used.
1027

    
1028
DOC_ABSPATH            =
1029

    
1030
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1031
# is installed.
1032

    
1033
BIN_ABSPATH            = /usr/local/bin/
1034

    
1035
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1036
# documentation generated for other projects. This allows doxysearch to search
1037
# the documentation for these projects as well.
1038

    
1039
EXT_DOC_PATHS          =