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