drawable: fix typo, should fix assertion with two or more videos
[vlc/asuraparaju-public.git] / doc / Doxyfile.in
blob4c234a8f4cdb40a047e03321e9d00a477ea7db67
1 # Doxyfile 1.6.2-20100208
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
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.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME           = VLC
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.
34 PROJECT_NUMBER         = @VERSION@
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY       = doxygen
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
50 CREATE_SUBDIRS         = NO
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63 OUTPUT_LANGUAGE        = English
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
70 BRIEF_MEMBER_DESC      = YES
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
77 REPEAT_BRIEF           = YES
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
89 ABBREVIATE_BRIEF       =
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
93 # description.
95 ALWAYS_DETAILED_SEC    = NO
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
102 INLINE_INHERITED_MEMB  = NO
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
108 FULL_PATH_NAMES        = YES
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
117 STRIP_FROM_PATH        = ..
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
126 STRIP_FROM_INC_PATH    =
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
132 SHORT_NAMES            = NO
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
140 JAVADOC_AUTOBRIEF      = YES
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
148 QT_AUTOBRIEF           = NO
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
156 MULTILINE_CPP_IS_BRIEF = NO
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it
160 # re-implements.
162 INHERIT_DOCS           = YES
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
168 SEPARATE_MEMBER_PAGES  = NO
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
173 TAB_SIZE               = 4
175 # This tag can be used to specify a number of aliases that acts
176 # as commands in the documentation. An alias has the form "name=value".
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
179 # will result in a user-defined paragraph with heading "Side Effects:".
180 # You can put \n's in the value part of an alias to insert newlines.
182 ALIASES                =
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
189 OPTIMIZE_OUTPUT_FOR_C  = YES
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
196 OPTIMIZE_OUTPUT_JAVA   = NO
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Fortran.
202 OPTIMIZE_FOR_FORTRAN   = NO
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
206 # VHDL.
208 OPTIMIZE_OUTPUT_VHDL   = NO
210 # Doxygen selects the parser to use depending on the extension of the files it parses.
211 # With this tag you can assign which parser to use for a given extension.
212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
213 # The format is ext=language, where ext is a file extension, and language is one of
214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
219 EXTENSION_MAPPING      =
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222 # to include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225 # func(std::string) {}). This also make the inheritance and collaboration
226 # diagrams that involve STL classes more complete and accurate.
228 BUILTIN_STL_SUPPORT    = NO
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
231 # enable parsing support.
233 CPP_CLI_SUPPORT        = NO
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236 # Doxygen will parse them like normal C++ but will assume all classes use public
237 # instead of private inheritance when no explicit protection keyword is present.
239 SIP_SUPPORT            = NO
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
242 # and setter methods for a property. Setting this option to YES (the default)
243 # will make doxygen to replace the get and set methods by a property in the
244 # documentation. This will only work if the methods are indeed getting or
245 # setting a simple type. If this is not the case, or you want to show the
246 # methods anyway, you should set this option to NO.
248 IDL_PROPERTY_SUPPORT   = YES
250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251 # tag is set to YES, then doxygen will reuse the documentation of the first
252 # member in the group (if any) for the other members of the group. By default
253 # all members of a group must be documented explicitly.
255 DISTRIBUTE_GROUP_DOC   = NO
257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258 # the same type (for instance a group of public functions) to be put as a
259 # subgroup of that type (e.g. under the Public Functions section). Set it to
260 # NO to prevent subgrouping. Alternatively, this can be done per class using
261 # the \nosubgrouping command.
263 SUBGROUPING            = YES
265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266 # is documented as struct, union, or enum with the name of the typedef. So
267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268 # with name TypeT. When disabled the typedef will appear as a member of a file,
269 # namespace, or class. And the struct will be named TypeS. This can typically
270 # be useful for C code in case the coding convention dictates that all compound
271 # types are typedef'ed and only the typedef is referenced, never the tag name.
273 TYPEDEF_HIDES_STRUCT   = NO
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276 # determine which symbols to keep in memory and which to flush to disk.
277 # When the cache is full, less often used symbols will be written to disk.
278 # For small to medium size projects (<1000 input files) the default value is
279 # probably good enough. For larger projects a too small cache size can cause
280 # doxygen to be busy swapping symbols to and from disk most of the time
281 # causing a significant performance penality.
282 # If the system has enough physical memory increasing the cache will improve the
283 # performance by keeping more symbols in memory. Note that the value works on
284 # a logarithmic scale so increasing the size by one will rougly double the
285 # memory usage. The cache size is given by this formula:
286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287 # corresponding to a cache size of 2^16 = 65536 symbols
289 SYMBOL_CACHE_SIZE      = 0
291 #---------------------------------------------------------------------------
292 # Build related configuration options
293 #---------------------------------------------------------------------------
295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296 # documentation are documented, even if no documentation was available.
297 # Private class members and static file members will be hidden unless
298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
300 EXTRACT_ALL            = YES
302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303 # will be included in the documentation.
305 EXTRACT_PRIVATE        = NO
307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
308 # will be included in the documentation.
310 EXTRACT_STATIC         = YES
312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313 # defined locally in source files will be included in the documentation.
314 # If set to NO only classes defined in header files are included.
316 EXTRACT_LOCAL_CLASSES  = YES
318 # This flag is only useful for Objective-C code. When set to YES local
319 # methods, which are defined in the implementation section but not in
320 # the interface are included in the documentation.
321 # If set to NO (the default) only methods in the interface are included.
323 EXTRACT_LOCAL_METHODS  = NO
325 # If this flag is set to YES, the members of anonymous namespaces will be
326 # extracted and appear in the documentation as a namespace called
327 # 'anonymous_namespace{file}', where file will be replaced with the base
328 # name of the file that contains the anonymous namespace. By default
329 # anonymous namespace are hidden.
331 EXTRACT_ANON_NSPACES   = NO
333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334 # undocumented members of documented classes, files or namespaces.
335 # If set to NO (the default) these members will be included in the
336 # various overviews, but no documentation section is generated.
337 # This option has no effect if EXTRACT_ALL is enabled.
339 HIDE_UNDOC_MEMBERS     = NO
341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342 # undocumented classes that are normally visible in the class hierarchy.
343 # If set to NO (the default) these classes will be included in the various
344 # overviews. This option has no effect if EXTRACT_ALL is enabled.
346 HIDE_UNDOC_CLASSES     = NO
348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349 # friend (class|struct|union) declarations.
350 # If set to NO (the default) these declarations will be included in the
351 # documentation.
353 HIDE_FRIEND_COMPOUNDS  = NO
355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356 # documentation blocks found inside the body of a function.
357 # If set to NO (the default) these blocks will be appended to the
358 # function's detailed documentation block.
360 HIDE_IN_BODY_DOCS      = NO
362 # The INTERNAL_DOCS tag determines if documentation
363 # that is typed after a \internal command is included. If the tag is set
364 # to NO (the default) then the documentation will be excluded.
365 # Set it to YES to include the internal documentation.
367 INTERNAL_DOCS          = YES
369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370 # file names in lower-case letters. If set to YES upper-case letters are also
371 # allowed. This is useful if you have classes or files whose names only differ
372 # in case and if your file system supports case sensitive file names. Windows
373 # and Mac users are advised to set this option to NO.
375 CASE_SENSE_NAMES       = YES
377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378 # will show members with their full class and namespace scopes in the
379 # documentation. If set to YES the scope will be hidden.
381 HIDE_SCOPE_NAMES       = NO
383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384 # will put a list of the files that are included by a file in the documentation
385 # of that file.
387 SHOW_INCLUDE_FILES     = NO
389 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
390 # will list include files with double quotes in the documentation
391 # rather than with sharp brackets.
393 FORCE_LOCAL_INCLUDES   = NO
395 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
396 # is inserted in the documentation for inline members.
398 INLINE_INFO            = YES
400 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
401 # will sort the (detailed) documentation of file and class members
402 # alphabetically by member name. If set to NO the members will appear in
403 # declaration order.
405 SORT_MEMBER_DOCS       = YES
407 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
408 # brief documentation of file, namespace and class members alphabetically
409 # by member name. If set to NO (the default) the members will appear in
410 # declaration order.
412 SORT_BRIEF_DOCS        = NO
414 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
416 SORT_MEMBERS_CTORS_1ST = NO
418 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419 # hierarchy of group names into alphabetical order. If set to NO (the default)
420 # the group names will appear in their defined order.
422 SORT_GROUP_NAMES       = NO
424 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
425 # sorted by fully-qualified names, including namespaces. If set to
426 # NO (the default), the class list will be sorted only by class name,
427 # not including the namespace part.
428 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
429 # Note: This option applies only to the class list, not to the
430 # alphabetical list.
432 SORT_BY_SCOPE_NAME     = NO
434 # The GENERATE_TODOLIST tag can be used to enable (YES) or
435 # disable (NO) the todo list. This list is created by putting \todo
436 # commands in the documentation.
438 GENERATE_TODOLIST      = YES
440 # The GENERATE_TESTLIST tag can be used to enable (YES) or
441 # disable (NO) the test list. This list is created by putting \test
442 # commands in the documentation.
444 GENERATE_TESTLIST      = YES
446 # The GENERATE_BUGLIST tag can be used to enable (YES) or
447 # disable (NO) the bug list. This list is created by putting \bug
448 # commands in the documentation.
450 GENERATE_BUGLIST       = YES
452 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453 # disable (NO) the deprecated list. This list is created by putting
454 # \deprecated commands in the documentation.
456 GENERATE_DEPRECATEDLIST= YES
458 # The ENABLED_SECTIONS tag can be used to enable conditional
459 # documentation sections, marked by \if sectionname ... \endif.
461 ENABLED_SECTIONS       =
463 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
464 # the initial value of a variable or define consists of for it to appear in
465 # the documentation. If the initializer consists of more lines than specified
466 # here it will be hidden. Use a value of 0 to hide initializers completely.
467 # The appearance of the initializer of individual variables and defines in the
468 # documentation can be controlled using \showinitializer or \hideinitializer
469 # command in the documentation regardless of this setting.
471 MAX_INITIALIZER_LINES  = 30
473 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
474 # at the bottom of the documentation of classes and structs. If set to YES the
475 # list will mention the files that were used to generate the documentation.
477 SHOW_USED_FILES        = YES
479 # If the sources in your project are distributed over multiple directories
480 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
481 # in the documentation. The default is NO.
483 SHOW_DIRECTORIES       = YES
485 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
486 # This will remove the Files entry from the Quick Index and from the
487 # Folder Tree View (if specified). The default is YES.
489 SHOW_FILES             = YES
491 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492 # Namespaces page.
493 # This will remove the Namespaces entry from the Quick Index
494 # and from the Folder Tree View (if specified). The default is YES.
496 SHOW_NAMESPACES        = YES
498 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
499 # doxygen should invoke to get the current version for each file (typically from
500 # the version control system). Doxygen will invoke the program by executing (via
501 # popen()) the command <command> <input-file>, where <command> is the value of
502 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
503 # provided by doxygen. Whatever the program writes to standard output
504 # is used as the file version. See the manual for examples.
506 FILE_VERSION_FILTER    =
508 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
509 # doxygen. The layout file controls the global structure of the generated output files
510 # in an output format independent way. The create the layout file that represents
511 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
512 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
513 # of the layout file.
515 LAYOUT_FILE            =
517 #---------------------------------------------------------------------------
518 # configuration options related to warning and progress messages
519 #---------------------------------------------------------------------------
521 # The QUIET tag can be used to turn on/off the messages that are generated
522 # by doxygen. Possible values are YES and NO. If left blank NO is used.
524 QUIET                  = NO
526 # The WARNINGS tag can be used to turn on/off the warning messages that are
527 # generated by doxygen. Possible values are YES and NO. If left blank
528 # NO is used.
530 WARNINGS               = YES
532 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
533 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
534 # automatically be disabled.
536 WARN_IF_UNDOCUMENTED   = YES
538 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
539 # potential errors in the documentation, such as not documenting some
540 # parameters in a documented function, or documenting parameters that
541 # don't exist or using markup commands wrongly.
543 WARN_IF_DOC_ERROR      = YES
545 # This WARN_NO_PARAMDOC option can be abled to get warnings for
546 # functions that are documented, but have no documentation for their parameters
547 # or return value. If set to NO (the default) doxygen will only warn about
548 # wrong or incomplete parameter documentation, but not about the absence of
549 # documentation.
551 WARN_NO_PARAMDOC       = NO
553 # The WARN_FORMAT tag determines the format of the warning messages that
554 # doxygen can produce. The string should contain the $file, $line, and $text
555 # tags, which will be replaced by the file and line number from which the
556 # warning originated and the warning text. Optionally the format may contain
557 # $version, which will be replaced by the version of the file (if it could
558 # be obtained via FILE_VERSION_FILTER)
560 WARN_FORMAT            = "$file:$line: $text"
562 # The WARN_LOGFILE tag can be used to specify a file to which warning
563 # and error messages should be written. If left blank the output is written
564 # to stderr.
566 WARN_LOGFILE           =
568 #---------------------------------------------------------------------------
569 # configuration options related to the input files
570 #---------------------------------------------------------------------------
572 # The INPUT tag can be used to specify the files and/or directories that contain
573 # documented source files. You may enter file names like "myfile.cpp" or
574 # directories like "/usr/src/myproject". Separate the files or directories
575 # with spaces.
577 INPUT                  = @top_srcdir@/src \
578                          @top_srcdir@/include
580 # This tag can be used to specify the character encoding of the source files
581 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
582 # also the default input encoding. Doxygen uses libiconv (or the iconv built
583 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
584 # the list of possible encodings.
586 INPUT_ENCODING         = UTF-8
588 # If the value of the INPUT tag contains directories, you can use the
589 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
590 # and *.h) to filter out the source-files in the directories. If left
591 # blank the following patterns are tested:
592 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
593 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
595 FILE_PATTERNS          =
597 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
598 # should be searched for input files as well. Possible values are YES and NO.
599 # If left blank NO is used.
601 RECURSIVE              = YES
603 # The EXCLUDE tag can be used to specify files and/or directories that should
604 # excluded from the INPUT source files. This way you can easily exclude a
605 # subdirectory from a directory tree whose root is specified with the INPUT tag.
607 EXCLUDE                = @top_srcdir@/src/extras
609 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
610 # directories that are symbolic links (a Unix filesystem feature) are excluded
611 # from the input.
613 EXCLUDE_SYMLINKS       = NO
615 # If the value of the INPUT tag contains directories, you can use the
616 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
617 # certain files from those directories. Note that the wildcards are matched
618 # against the file with absolute path, so to exclude all test directories
619 # for example use the pattern */test/*
621 EXCLUDE_PATTERNS       =
623 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624 # (namespaces, classes, functions, etc.) that should be excluded from the
625 # output. The symbol name can be a fully qualified name, a word, or if the
626 # wildcard * is used, a substring. Examples: ANamespace, AClass,
627 # AClass::ANamespace, ANamespace::*Test
629 EXCLUDE_SYMBOLS        =
631 # The EXAMPLE_PATH tag can be used to specify one or more files or
632 # directories that contain example code fragments that are included (see
633 # the \include command).
635 EXAMPLE_PATH           =
637 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
638 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639 # and *.h) to filter out the source-files in the directories. If left
640 # blank all files are included.
642 EXAMPLE_PATTERNS       =
644 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645 # searched for input files to be used with the \include or \dontinclude
646 # commands irrespective of the value of the RECURSIVE tag.
647 # Possible values are YES and NO. If left blank NO is used.
649 EXAMPLE_RECURSIVE      = NO
651 # The IMAGE_PATH tag can be used to specify one or more files or
652 # directories that contain image that are included in the documentation (see
653 # the \image command).
655 IMAGE_PATH             =
657 # The INPUT_FILTER tag can be used to specify a program that doxygen should
658 # invoke to filter for each input file. Doxygen will invoke the filter program
659 # by executing (via popen()) the command <filter> <input-file>, where <filter>
660 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661 # input file. Doxygen will then use the output that the filter program writes
662 # to standard output.
663 # If FILTER_PATTERNS is specified, this tag will be
664 # ignored.
666 INPUT_FILTER           = "@top_srcdir@/toolbox --add-include"
668 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
669 # basis.
670 # Doxygen will compare the file name with each pattern and apply the
671 # filter if there is a match.
672 # The filters are a list of the form:
673 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
675 # is applied to all files.
677 FILTER_PATTERNS        =
679 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680 # INPUT_FILTER) will be used to filter the input files when producing source
681 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
683 FILTER_SOURCE_FILES    = NO
685 #---------------------------------------------------------------------------
686 # configuration options related to source browsing
687 #---------------------------------------------------------------------------
689 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
690 # be generated. Documented entities will be cross-referenced with these sources.
691 # Note: To get rid of all source code in the generated output, make sure also
692 # VERBATIM_HEADERS is set to NO.
694 SOURCE_BROWSER         = NO
696 # Setting the INLINE_SOURCES tag to YES will include the body
697 # of functions and classes directly in the documentation.
699 INLINE_SOURCES         = NO
701 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702 # doxygen to hide any special comment blocks from generated source code
703 # fragments. Normal C and C++ comments will always remain visible.
705 STRIP_CODE_COMMENTS    = NO
707 # If the REFERENCED_BY_RELATION tag is set to YES
708 # then for each documented function all documented
709 # functions referencing it will be listed.
711 REFERENCED_BY_RELATION = YES
713 # If the REFERENCES_RELATION tag is set to YES
714 # then for each documented function all documented entities
715 # called/used by that function will be listed.
717 REFERENCES_RELATION    = YES
719 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
722 # link to the source code.
723 # Otherwise they will link to the documentation.
725 REFERENCES_LINK_SOURCE = YES
727 # If the USE_HTAGS tag is set to YES then the references to source code
728 # will point to the HTML generated by the htags(1) tool instead of doxygen
729 # built-in source browser. The htags tool is part of GNU's global source
730 # tagging system (see http://www.gnu.org/software/global/global.html). You
731 # will need version 4.8.6 or higher.
733 USE_HTAGS              = NO
735 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736 # will generate a verbatim copy of the header file for each class for
737 # which an include is specified. Set to NO to disable this.
739 VERBATIM_HEADERS       = YES
741 #---------------------------------------------------------------------------
742 # configuration options related to the alphabetical class index
743 #---------------------------------------------------------------------------
745 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746 # of all compounds will be generated. Enable this if the project
747 # contains a lot of classes, structs, unions or interfaces.
749 ALPHABETICAL_INDEX     = NO
751 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
753 # in which this list will be split (can be a number in the range [1..20])
755 COLS_IN_ALPHA_INDEX    = 5
757 # In case all classes in a project start with a common prefix, all
758 # classes will be put under the same header in the alphabetical index.
759 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
760 # should be ignored while generating the index headers.
762 IGNORE_PREFIX          =
764 #---------------------------------------------------------------------------
765 # configuration options related to the HTML output
766 #---------------------------------------------------------------------------
768 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
769 # generate HTML output.
771 GENERATE_HTML          = YES
773 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
774 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
775 # put in front of it. If left blank `html' will be used as the default path.
777 HTML_OUTPUT            = html
779 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
780 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
781 # doxygen will generate files with .html extension.
783 HTML_FILE_EXTENSION    = .html
785 # The HTML_HEADER tag can be used to specify a personal HTML header for
786 # each generated HTML page. If it is left blank doxygen will generate a
787 # standard header.
789 HTML_HEADER            =
791 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
792 # each generated HTML page. If it is left blank doxygen will generate a
793 # standard footer.
795 HTML_FOOTER            =
797 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
798 # style sheet that is used by each HTML page. It can be used to
799 # fine-tune the look of the HTML output. If the tag is left blank doxygen
800 # will generate a default style sheet. Note that doxygen will try to copy
801 # the style sheet file to the HTML output directory, so don't put your own
802 # stylesheet in the HTML output directory as well, or it will be erased!
804 HTML_STYLESHEET        =
806 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
807 # page will contain the date and time when the page was generated. Setting
808 # this to NO can help when comparing the output of multiple runs.
810 HTML_TIMESTAMP         = NO
812 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
813 # files or namespaces will be aligned in HTML using tables. If set to
814 # NO a bullet list will be used.
816 HTML_ALIGN_MEMBERS     = YES
818 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
819 # documentation will contain sections that can be hidden and shown after the
820 # page has loaded. For this to work a browser that supports
821 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
822 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
824 HTML_DYNAMIC_SECTIONS  = NO
826 # If the GENERATE_DOCSET tag is set to YES, additional index files
827 # will be generated that can be used as input for Apple's Xcode 3
828 # integrated development environment, introduced with OSX 10.5 (Leopard).
829 # To create a documentation set, doxygen will generate a Makefile in the
830 # HTML output directory. Running make will produce the docset in that
831 # directory and running "make install" will install the docset in
832 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
833 # it at startup.
834 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
836 GENERATE_DOCSET        = NO
838 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
839 # feed. A documentation feed provides an umbrella under which multiple
840 # documentation sets from a single provider (such as a company or product suite)
841 # can be grouped.
843 DOCSET_FEEDNAME        = "Doxygen generated docs"
845 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
846 # should uniquely identify the documentation set bundle. This should be a
847 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
848 # will append .docset to the name.
850 DOCSET_BUNDLE_ID       = org.videolan.vlc
852 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
853 # will be generated that can be used as input for tools like the
854 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
855 # of the generated HTML documentation.
857 GENERATE_HTMLHELP      = NO
859 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
860 # be used to specify the file name of the resulting .chm file. You
861 # can add a path in front of the file if the result should not be
862 # written to the html output directory.
864 CHM_FILE               =
866 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
867 # be used to specify the location (absolute path including file name) of
868 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
869 # the HTML help compiler on the generated index.hhp.
871 HHC_LOCATION           =
873 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
874 # controls if a separate .chi index file is generated (YES) or that
875 # it should be included in the master .chm file (NO).
877 GENERATE_CHI           = NO
879 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
880 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
881 # content.
883 CHM_INDEX_ENCODING     =
885 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
886 # controls whether a binary table of contents is generated (YES) or a
887 # normal table of contents (NO) in the .chm file.
889 BINARY_TOC             = NO
891 # The TOC_EXPAND flag can be set to YES to add extra items for group members
892 # to the contents of the HTML help documentation and to the tree view.
894 TOC_EXPAND             = NO
896 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
897 # are set, an additional index file will be generated that can be used as input for
898 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
899 # HTML documentation.
901 GENERATE_QHP           = NO
903 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
904 # be used to specify the file name of the resulting .qch file.
905 # The path specified is relative to the HTML output folder.
907 QCH_FILE               =
909 # The QHP_NAMESPACE tag specifies the namespace to use when generating
910 # Qt Help Project output. For more information please see
911 # http://doc.trolltech.com/qthelpproject.html#namespace
913 QHP_NAMESPACE          = org.doxygen.Project
915 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
916 # Qt Help Project output. For more information please see
917 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
919 QHP_VIRTUAL_FOLDER     = doc
921 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
922 # For more information please see
923 # http://doc.trolltech.com/qthelpproject.html#custom-filters
925 QHP_CUST_FILTER_NAME   =
927 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
928 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
930 QHP_CUST_FILTER_ATTRS  =
932 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
933 # filter section matches.
934 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
936 QHP_SECT_FILTER_ATTRS  =
938 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
939 # be used to specify the location of Qt's qhelpgenerator.
940 # If non-empty doxygen will try to run qhelpgenerator on the generated
941 # .qhp file.
943 QHG_LOCATION           =
945 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
946 #  will be generated, which together with the HTML files, form an Eclipse help
947 #  plugin. To install this plugin and make it available under the help contents
948 # menu in Eclipse, the contents of the directory containing the HTML and XML
949 # files needs to be copied into the plugins directory of eclipse. The name of
950 # the directory within the plugins directory should be the same as
951 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
953 GENERATE_ECLIPSEHELP   = NO
955 # A unique identifier for the eclipse help plugin. When installing the plugin
956 # the directory name containing the HTML and XML files should also have
957 # this name.
959 ECLIPSE_DOC_ID         = org.doxygen.Project
961 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
962 # top of each HTML page. The value NO (the default) enables the index and
963 # the value YES disables it.
965 DISABLE_INDEX          = NO
967 # This tag can be used to set the number of enum values (range [1..20])
968 # that doxygen will group on one line in the generated HTML documentation.
970 ENUM_VALUES_PER_LINE   = 4
972 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
973 # structure should be generated to display hierarchical information.
974 # If the tag value is set to YES, a side panel will be generated
975 # containing a tree-like index structure (just like the one that
976 # is generated for HTML Help). For this to work a browser that supports
977 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
978 # Windows users are probably better off using the HTML help feature.
980 GENERATE_TREEVIEW      = NO
982 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
983 # and Class Hierarchy pages using a tree view instead of an ordered list.
985 USE_INLINE_TREES       = NO
987 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
988 # used to set the initial width (in pixels) of the frame in which the tree
989 # is shown.
991 TREEVIEW_WIDTH         = 250
993 # Use this tag to change the font size of Latex formulas included
994 # as images in the HTML documentation. The default is 10. Note that
995 # when you change the font size after a successful doxygen run you need
996 # to manually remove any form_*.png images from the HTML output directory
997 # to force them to be regenerated.
999 FORMULA_FONTSIZE       = 10
1001 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1002 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
1003 # typically be disabled. For large projects the javascript based search engine
1004 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1006 SEARCHENGINE           = YES
1008 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
1009 # file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
1010 # and does not have live searching capabilities.
1012 SERVER_BASED_SEARCH    = NO
1014 #---------------------------------------------------------------------------
1015 # configuration options related to the LaTeX output
1016 #---------------------------------------------------------------------------
1018 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1019 # generate Latex output.
1021 GENERATE_LATEX         = YES
1023 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1024 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1025 # put in front of it. If left blank `latex' will be used as the default path.
1027 LATEX_OUTPUT           = latex
1029 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1030 # invoked. If left blank `latex' will be used as the default command name.
1031 # Note that when enabling USE_PDFLATEX this option is only used for
1032 # generating bitmaps for formulas in the HTML output, but not in the
1033 # Makefile that is written to the output directory.
1035 LATEX_CMD_NAME         = latex
1037 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1038 # generate index for LaTeX. If left blank `makeindex' will be used as the
1039 # default command name.
1041 MAKEINDEX_CMD_NAME     = makeindex
1043 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1044 # LaTeX documents. This may be useful for small projects and may help to
1045 # save some trees in general.
1047 COMPACT_LATEX          = NO
1049 # The PAPER_TYPE tag can be used to set the paper type that is used
1050 # by the printer. Possible values are: a4, a4wide, letter, legal and
1051 # executive. If left blank a4wide will be used.
1053 PAPER_TYPE             = a4wide
1055 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1056 # packages that should be included in the LaTeX output.
1058 EXTRA_PACKAGES         =
1060 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1061 # the generated latex document. The header should contain everything until
1062 # the first chapter. If it is left blank doxygen will generate a
1063 # standard header. Notice: only use this tag if you know what you are doing!
1065 LATEX_HEADER           =
1067 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1068 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1069 # contain links (just like the HTML output) instead of page references
1070 # This makes the output suitable for online browsing using a pdf viewer.
1072 PDF_HYPERLINKS         = NO
1074 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1075 # plain latex in the generated Makefile. Set this option to YES to get a
1076 # higher quality PDF documentation.
1078 USE_PDFLATEX           = NO
1080 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1081 # command to the generated LaTeX files. This will instruct LaTeX to keep
1082 # running if errors occur, instead of asking the user for help.
1083 # This option is also used when generating formulas in HTML.
1085 LATEX_BATCHMODE        = NO
1087 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1088 # include the index chapters (such as File Index, Compound Index, etc.)
1089 # in the output.
1091 LATEX_HIDE_INDICES     = NO
1093 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1095 LATEX_SOURCE_CODE      = NO
1097 #---------------------------------------------------------------------------
1098 # configuration options related to the RTF output
1099 #---------------------------------------------------------------------------
1101 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1102 # The RTF output is optimized for Word 97 and may not look very pretty with
1103 # other RTF readers or editors.
1105 GENERATE_RTF           = NO
1107 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1108 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1109 # put in front of it. If left blank `rtf' will be used as the default path.
1111 RTF_OUTPUT             = rtf
1113 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1114 # RTF documents. This may be useful for small projects and may help to
1115 # save some trees in general.
1117 COMPACT_RTF            = NO
1119 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1120 # will contain hyperlink fields. The RTF file will
1121 # contain links (just like the HTML output) instead of page references.
1122 # This makes the output suitable for online browsing using WORD or other
1123 # programs which support those fields.
1124 # Note: wordpad (write) and others do not support links.
1126 RTF_HYPERLINKS         = NO
1128 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1129 # config file, i.e. a series of assignments. You only have to provide
1130 # replacements, missing definitions are set to their default value.
1132 RTF_STYLESHEET_FILE    =
1134 # Set optional variables used in the generation of an rtf document.
1135 # Syntax is similar to doxygen's config file.
1137 RTF_EXTENSIONS_FILE    =
1139 #---------------------------------------------------------------------------
1140 # configuration options related to the man page output
1141 #---------------------------------------------------------------------------
1143 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1144 # generate man pages
1146 GENERATE_MAN           = NO
1148 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1149 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1150 # put in front of it. If left blank `man' will be used as the default path.
1152 MAN_OUTPUT             = man
1154 # The MAN_EXTENSION tag determines the extension that is added to
1155 # the generated man pages (default is the subroutine's section .3)
1157 MAN_EXTENSION          = .3
1159 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1160 # then it will generate one additional man file for each entity
1161 # documented in the real man page(s). These additional files
1162 # only source the real man page, but without them the man command
1163 # would be unable to find the correct page. The default is NO.
1165 MAN_LINKS              = NO
1167 #---------------------------------------------------------------------------
1168 # configuration options related to the XML output
1169 #---------------------------------------------------------------------------
1171 # If the GENERATE_XML tag is set to YES Doxygen will
1172 # generate an XML file that captures the structure of
1173 # the code including all documentation.
1175 GENERATE_XML           = NO
1177 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1178 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1179 # put in front of it. If left blank `xml' will be used as the default path.
1181 XML_OUTPUT             = xml
1183 # The XML_SCHEMA tag can be used to specify an XML schema,
1184 # which can be used by a validating XML parser to check the
1185 # syntax of the XML files.
1187 XML_SCHEMA             =
1189 # The XML_DTD tag can be used to specify an XML DTD,
1190 # which can be used by a validating XML parser to check the
1191 # syntax of the XML files.
1193 XML_DTD                =
1195 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1196 # dump the program listings (including syntax highlighting
1197 # and cross-referencing information) to the XML output. Note that
1198 # enabling this will significantly increase the size of the XML output.
1200 XML_PROGRAMLISTING     = YES
1202 #---------------------------------------------------------------------------
1203 # configuration options for the AutoGen Definitions output
1204 #---------------------------------------------------------------------------
1206 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1207 # generate an AutoGen Definitions (see autogen.sf.net) file
1208 # that captures the structure of the code including all
1209 # documentation. Note that this feature is still experimental
1210 # and incomplete at the moment.
1212 GENERATE_AUTOGEN_DEF   = NO
1214 #---------------------------------------------------------------------------
1215 # configuration options related to the Perl module output
1216 #---------------------------------------------------------------------------
1218 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1219 # generate a Perl module file that captures the structure of
1220 # the code including all documentation. Note that this
1221 # feature is still experimental and incomplete at the
1222 # moment.
1224 GENERATE_PERLMOD       = NO
1226 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1227 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1228 # to generate PDF and DVI output from the Perl module output.
1230 PERLMOD_LATEX          = NO
1232 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1233 # nicely formatted so it can be parsed by a human reader.
1234 # This is useful
1235 # if you want to understand what is going on.
1236 # On the other hand, if this
1237 # tag is set to NO the size of the Perl module output will be much smaller
1238 # and Perl will parse it just the same.
1240 PERLMOD_PRETTY         = YES
1242 # The names of the make variables in the generated doxyrules.make file
1243 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1244 # This is useful so different doxyrules.make files included by the same
1245 # Makefile don't overwrite each other's variables.
1247 PERLMOD_MAKEVAR_PREFIX =
1249 #---------------------------------------------------------------------------
1250 # Configuration options related to the preprocessor
1251 #---------------------------------------------------------------------------
1253 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1254 # evaluate all C-preprocessor directives found in the sources and include
1255 # files.
1257 ENABLE_PREPROCESSING   = YES
1259 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1260 # names in the source code. If set to NO (the default) only conditional
1261 # compilation will be performed. Macro expansion can be done in a controlled
1262 # way by setting EXPAND_ONLY_PREDEF to YES.
1264 MACRO_EXPANSION        = YES
1266 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1267 # then the macro expansion is limited to the macros specified with the
1268 # PREDEFINED and EXPAND_AS_DEFINED tags.
1270 EXPAND_ONLY_PREDEF     = NO
1272 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1273 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1275 SEARCH_INCLUDES        = YES
1277 # The INCLUDE_PATH tag can be used to specify one or more directories that
1278 # contain include files that are not input files but should be processed by
1279 # the preprocessor.
1281 INCLUDE_PATH           = @top_srcdir@/include \
1282                          @top_srcdir@/include/vlc
1284 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1285 # patterns (like *.h and *.hpp) to filter out the header-files in the
1286 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1287 # be used.
1289 INCLUDE_FILE_PATTERNS  =
1291 # The PREDEFINED tag can be used to specify one or more macro names that
1292 # are defined before the preprocessor is started (similar to the -D option of
1293 # gcc). The argument of the tag is a list of macros of the form: name
1294 # or name=definition (no spaces). If the definition and the = are
1295 # omitted =1 is assumed. To prevent a macro definition from being
1296 # undefined via #undef or recursively expanded use the := operator
1297 # instead of the = operator.
1299 PREDEFINED             =
1301 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1302 # this tag can be used to specify a list of macro names that should be expanded.
1303 # The macro definition that is found in the sources will be used.
1304 # Use the PREDEFINED tag if you want to use a different macro definition.
1306 EXPAND_AS_DEFINED      =
1308 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1309 # doxygen's preprocessor will remove all function-like macros that are alone
1310 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1311 # function macros are typically used for boiler-plate code, and will confuse
1312 # the parser if not removed.
1314 SKIP_FUNCTION_MACROS   = NO
1316 #---------------------------------------------------------------------------
1317 # Configuration::additions related to external references
1318 #---------------------------------------------------------------------------
1320 # The TAGFILES option can be used to specify one or more tagfiles.
1321 # Optionally an initial location of the external documentation
1322 # can be added for each tagfile. The format of a tag file without
1323 # this location is as follows:
1325 # TAGFILES = file1 file2 ...
1326 # Adding location for the tag files is done as follows:
1328 # TAGFILES = file1=loc1 "file2 = loc2" ...
1329 # where "loc1" and "loc2" can be relative or absolute paths or
1330 # URLs. If a location is present for each tag, the installdox tool
1331 # does not have to be run to correct the links.
1332 # Note that each tag file must have a unique name
1333 # (where the name does NOT include the path)
1334 # If a tag file is not located in the directory in which doxygen
1335 # is run, you must also specify the path to the tagfile here.
1337 TAGFILES               =
1339 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1340 # a tag file that is based on the input files it reads.
1342 GENERATE_TAGFILE       = vlc.tags
1344 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1345 # in the class index. If set to NO only the inherited external classes
1346 # will be listed.
1348 ALLEXTERNALS           = NO
1350 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1351 # in the modules index. If set to NO, only the current project's groups will
1352 # be listed.
1354 EXTERNAL_GROUPS        = YES
1356 # The PERL_PATH should be the absolute path and name of the perl script
1357 # interpreter (i.e. the result of `which perl').
1359 PERL_PATH              = /usr/bin/perl
1361 #---------------------------------------------------------------------------
1362 # Configuration options related to the dot tool
1363 #---------------------------------------------------------------------------
1365 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1366 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1367 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1368 # this option is superseded by the HAVE_DOT option below. This is only a
1369 # fallback. It is recommended to install and use dot, since it yields more
1370 # powerful graphs.
1372 CLASS_DIAGRAMS         = YES
1374 # You can define message sequence charts within doxygen comments using the \msc
1375 # command. Doxygen will then run the mscgen tool (see
1376 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1377 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1378 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1379 # default search path.
1381 MSCGEN_PATH            =
1383 # If set to YES, the inheritance and collaboration graphs will hide
1384 # inheritance and usage relations if the target is undocumented
1385 # or is not a class.
1387 HIDE_UNDOC_RELATIONS   = YES
1389 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1390 # available from the path. This tool is part of Graphviz, a graph visualization
1391 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1392 # have no effect if this option is set to NO (the default)
1394 HAVE_DOT               = YES
1396 # By default doxygen will write a font called FreeSans.ttf to the output
1397 # directory and reference it in all dot files that doxygen generates. This
1398 # font does not include all possible unicode characters however, so when you need
1399 # these (or just want a differently looking font) you can specify the font name
1400 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1401 # which can be done by putting it in a standard location or by setting the
1402 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1403 # containing the font.
1405 DOT_FONTNAME           = FreeSans
1407 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1408 # The default size is 10pt.
1410 DOT_FONTSIZE           = 10
1412 # By default doxygen will tell dot to use the output directory to look for the
1413 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1414 # different font using DOT_FONTNAME you can set the path where dot
1415 # can find it using this tag.
1417 DOT_FONTPATH           =
1419 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1420 # will generate a graph for each documented class showing the direct and
1421 # indirect inheritance relations. Setting this tag to YES will force the
1422 # the CLASS_DIAGRAMS tag to NO.
1424 CLASS_GRAPH            = YES
1426 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1427 # will generate a graph for each documented class showing the direct and
1428 # indirect implementation dependencies (inheritance, containment, and
1429 # class references variables) of the class with other documented classes.
1431 COLLABORATION_GRAPH    = YES
1433 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1434 # will generate a graph for groups, showing the direct groups dependencies
1436 GROUP_GRAPHS           = YES
1438 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1439 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1440 # Language.
1442 UML_LOOK               = NO
1444 # If set to YES, the inheritance and collaboration graphs will show the
1445 # relations between templates and their instances.
1447 TEMPLATE_RELATIONS     = YES
1449 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1450 # tags are set to YES then doxygen will generate a graph for each documented
1451 # file showing the direct and indirect include dependencies of the file with
1452 # other documented files.
1454 INCLUDE_GRAPH          = YES
1456 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1457 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1458 # documented header file showing the documented files that directly or
1459 # indirectly include this file.
1461 INCLUDED_BY_GRAPH      = NO
1463 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1464 # doxygen will generate a call dependency graph for every global function
1465 # or class method. Note that enabling this option will significantly increase
1466 # the time of a run. So in most cases it will be better to enable call graphs
1467 # for selected functions only using the \callgraph command.
1469 CALL_GRAPH             = NO
1471 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1472 # doxygen will generate a caller dependency graph for every global function
1473 # or class method. Note that enabling this option will significantly increase
1474 # the time of a run. So in most cases it will be better to enable caller
1475 # graphs for selected functions only using the \callergraph command.
1477 CALLER_GRAPH           = NO
1479 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1480 # will graphical hierarchy of all classes instead of a textual one.
1482 GRAPHICAL_HIERARCHY    = YES
1484 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1485 # then doxygen will show the dependencies a directory has on other directories
1486 # in a graphical way. The dependency relations are determined by the #include
1487 # relations between the files in the directories.
1489 DIRECTORY_GRAPH        = YES
1491 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1492 # generated by dot. Possible values are png, jpg, or gif
1493 # If left blank png will be used.
1495 DOT_IMAGE_FORMAT       = png
1497 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1498 # found. If left blank, it is assumed the dot tool can be found in the path.
1500 DOT_PATH               =
1502 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1503 # contain dot files that are included in the documentation (see the
1504 # \dotfile command).
1506 DOTFILE_DIRS           =
1508 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1509 # nodes that will be shown in the graph. If the number of nodes in a graph
1510 # becomes larger than this value, doxygen will truncate the graph, which is
1511 # visualized by representing a node as a red box. Note that doxygen if the
1512 # number of direct children of the root node in a graph is already larger than
1513 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1514 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1516 DOT_GRAPH_MAX_NODES    = 50
1518 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1519 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1520 # from the root by following a path via at most 3 edges will be shown. Nodes
1521 # that lay further from the root node will be omitted. Note that setting this
1522 # option to 1 or 2 may greatly reduce the computation time needed for large
1523 # code bases. Also note that the size of a graph can be further restricted by
1524 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1526 MAX_DOT_GRAPH_DEPTH    = 0
1528 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1529 # background. This is disabled by default, because dot on Windows does not
1530 # seem to support this out of the box. Warning: Depending on the platform used,
1531 # enabling this option may lead to badly anti-aliased labels on the edges of
1532 # a graph (i.e. they become hard to read).
1534 DOT_TRANSPARENT        = NO
1536 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1537 # files in one run (i.e. multiple -o and -T options on the command line). This
1538 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1539 # support this, this feature is disabled by default.
1541 DOT_MULTI_TARGETS      = NO
1543 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1544 # generate a legend page explaining the meaning of the various boxes and
1545 # arrows in the dot generated graphs.
1547 GENERATE_LEGEND        = YES
1549 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1550 # remove the intermediate dot files that are used to generate
1551 # the various graphs.
1553 DOT_CLEANUP            = YES