You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1626 lines
66KB

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