Doxyfile 40 KB

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