jack2 codebase
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.

doxyfile 31KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808
  1. # Doxyfile 1.2.8.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. # 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 = "Jackdmp"
  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 = 1.90
  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 = build/default/
  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, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
  31. # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
  32. # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
  33. OUTPUT_LANGUAGE = English
  34. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  35. # documentation are documented, even if no documentation was available.
  36. # Private class members and static file members will be hidden unless
  37. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  38. EXTRACT_ALL = NO
  39. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  40. # will be included in the documentation.
  41. EXTRACT_PRIVATE = NO
  42. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  43. # will be included in the documentation.
  44. EXTRACT_STATIC = NO
  45. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  46. # undocumented members of documented classes, files or namespaces.
  47. # If set to NO (the default) these members will be included in the
  48. # various overviews, but no documentation section is generated.
  49. # This option has no effect if EXTRACT_ALL is enabled.
  50. HIDE_UNDOC_MEMBERS = NO
  51. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  52. # undocumented classes that are normally visible in the class hierarchy.
  53. # If set to NO (the default) these class will be included in the various
  54. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  55. HIDE_UNDOC_CLASSES = NO
  56. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  57. # include brief member descriptions after the members that are listed in
  58. # the file and class documentation (similar to JavaDoc).
  59. # Set to NO to disable this.
  60. BRIEF_MEMBER_DESC = YES
  61. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  62. # the brief description of a member or function before the detailed description.
  63. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  64. # brief descriptions will be completely suppressed.
  65. REPEAT_BRIEF = YES
  66. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  67. # Doxygen will generate a detailed section even if there is only a brief
  68. # description.
  69. ALWAYS_DETAILED_SEC = NO
  70. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  71. # path before files name in the file list and in the header files. If set
  72. # to NO the shortest path that makes the file name unique will be used.
  73. FULL_PATH_NAMES = NO
  74. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  75. # can be used to strip a user defined part of the path. Stripping is
  76. # only done if one of the specified strings matches the left-hand part of
  77. # the path. It is allowed to use relative paths in the argument list.
  78. STRIP_FROM_PATH =
  79. # The INTERNAL_DOCS tag determines if documentation
  80. # that is typed after a \internal command is included. If the tag is set
  81. # to NO (the default) then the documentation will be excluded.
  82. # Set it to YES to include the internal documentation.
  83. INTERNAL_DOCS = NO
  84. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  85. # generate a class diagram (in Html and LaTeX) for classes with base or
  86. # super classes. Setting the tag to NO turns the diagrams off.
  87. CLASS_DIAGRAMS = YES
  88. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  89. # be generated. Documented entities will be cross-referenced with these sources.
  90. SOURCE_BROWSER = YES
  91. # Setting the INLINE_SOURCES tag to YES will include the body
  92. # of functions and classes directly in the documentation.
  93. INLINE_SOURCES = NO
  94. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  95. # doxygen to hide any special comment blocks from generated source code
  96. # fragments. Normal C and C++ comments will always remain visible.
  97. STRIP_CODE_COMMENTS = YES
  98. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  99. # file names in lower case letters. If set to YES upper case letters are also
  100. # allowed. This is useful if you have classes or files whose names only differ
  101. # in case and if your file system supports case sensitive file names. Windows
  102. # users are adviced to set this option to NO.
  103. CASE_SENSE_NAMES = YES
  104. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  105. # (but less readable) file names. This can be useful is your file systems
  106. # doesn't support long names like on DOS, Mac, or CD-ROM.
  107. SHORT_NAMES = NO
  108. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  109. # will show members with their full class and namespace scopes in the
  110. # documentation. If set to YES the scope will be hidden.
  111. HIDE_SCOPE_NAMES = NO
  112. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  113. # will generate a verbatim copy of the header file for each class for
  114. # which an include is specified. Set to NO to disable this.
  115. VERBATIM_HEADERS = YES
  116. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  117. # will put list of the files that are included by a file in the documentation
  118. # of that file.
  119. SHOW_INCLUDE_FILES = YES
  120. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  121. # will interpret the first line (until the first dot) of a JavaDoc-style
  122. # comment as the brief description. If set to NO, the JavaDoc
  123. # comments will behave just like the Qt-style comments (thus requiring an
  124. # explict @brief command for a brief description.
  125. JAVADOC_AUTOBRIEF = NO
  126. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  127. # member inherits the documentation from any documented member that it
  128. # reimplements.
  129. INHERIT_DOCS = YES
  130. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  131. # is inserted in the documentation for inline members.
  132. INLINE_INFO = YES
  133. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  134. # will sort the (detailed) documentation of file and class members
  135. # alphabetically by member name. If set to NO the members will appear in
  136. # declaration order.
  137. SORT_MEMBER_DOCS = NO
  138. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  139. # tag is set to YES, then doxygen will reuse the documentation of the first
  140. # member in the group (if any) for the other members of the group. By default
  141. # all members of a group must be documented explicitly.
  142. DISTRIBUTE_GROUP_DOC = NO
  143. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  144. # Doxygen uses this value to replace tabs by spaces in code fragments.
  145. TAB_SIZE = 8
  146. # The ENABLED_SECTIONS tag can be used to enable conditional
  147. # documentation sections, marked by \if sectionname ... \endif.
  148. ENABLED_SECTIONS =
  149. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  150. # disable (NO) the todo list. This list is created by putting \todo
  151. # commands in the documentation.
  152. GENERATE_TODOLIST = YES
  153. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  154. # disable (NO) the test list. This list is created by putting \test
  155. # commands in the documentation.
  156. GENERATE_TESTLIST = YES
  157. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  158. # disable (NO) the bug list. This list is created by putting \bug
  159. # commands in the documentation.
  160. GENERATE_BUGLIST = YES
  161. # This tag can be used to specify a number of aliases that acts
  162. # as commands in the documentation. An alias has the form "name=value".
  163. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  164. # put the command \sideeffect (or @sideeffect) in the documentation, which
  165. # will result in a user defined paragraph with heading "Side Effects:".
  166. # You can put \n's in the value part of an alias to insert newlines.
  167. ALIASES =
  168. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  169. # the initial value of a variable or define consist of for it to appear in
  170. # the documentation. If the initializer consists of more lines than specified
  171. # here it will be hidden. Use a value of 0 to hide initializers completely.
  172. # The appearance of the initializer of individual variables and defines in the
  173. # documentation can be controlled using \showinitializer or \hideinitializer
  174. # command in the documentation regardless of this setting.
  175. MAX_INITIALIZER_LINES = 30
  176. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  177. # only. Doxygen will then generate output that is more tailored for C.
  178. # For instance some of the names that are used will be different. The list
  179. # of all members will be omitted, etc.
  180. OPTIMIZE_OUTPUT_FOR_C = NO
  181. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  182. # at the bottom of the documentation of classes and structs. If set to YES the
  183. # list will mention the files that were used to generate the documentation.
  184. SHOW_USED_FILES = YES
  185. #---------------------------------------------------------------------------
  186. # configuration options related to warning and progress messages
  187. #---------------------------------------------------------------------------
  188. # The QUIET tag can be used to turn on/off the messages that are generated
  189. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  190. QUIET = NO
  191. # The WARNINGS tag can be used to turn on/off the warning messages that are
  192. # generated by doxygen. Possible values are YES and NO. If left blank
  193. # NO is used.
  194. WARNINGS = YES
  195. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  196. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  197. # automatically be disabled.
  198. WARN_IF_UNDOCUMENTED = YES
  199. # The WARN_FORMAT tag determines the format of the warning messages that
  200. # doxygen can produce. The string should contain the $file, $line, and $text
  201. # tags, which will be replaced by the file and line number from which the
  202. # warning originated and the warning text.
  203. WARN_FORMAT =
  204. # The WARN_LOGFILE tag can be used to specify a file to which warning
  205. # and error messages should be written. If left blank the output is written
  206. # to stderr.
  207. WARN_LOGFILE =
  208. #---------------------------------------------------------------------------
  209. # configuration options related to the input files
  210. #---------------------------------------------------------------------------
  211. # The INPUT tag can be used to specify the files and/or directories that contain
  212. # documented source files. You may enter file names like "myfile.cpp" or
  213. # directories like "/usr/src/myproject". Separate the files or directories
  214. # with spaces.
  215. INPUT = common posix macosx macosx/coreaudio/ linux linux/alsa windows windows/portaudio common/jack/control.h
  216. # If the value of the INPUT tag contains directories, you can use the
  217. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  218. # and *.h) to filter out the source-files in the directories. If left
  219. # blank all files are included.
  220. FILE_PATTERNS = *.cpp *.h
  221. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  222. # should be searched for input files as well. Possible values are YES and NO.
  223. # If left blank NO is used.
  224. RECURSIVE = NO
  225. # The EXCLUDE tag can be used to specify files and/or directories that should
  226. # excluded from the INPUT source files. This way you can easily exclude a
  227. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  228. EXCLUDE = RPC
  229. # If the value of the INPUT tag contains directories, you can use the
  230. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  231. # certain files from those directories.
  232. EXCLUDE_PATTERNS =
  233. # The EXAMPLE_PATH tag can be used to specify one or more files or
  234. # directories that contain example code fragments that are included (see
  235. # the \include command).
  236. EXAMPLE_PATH =
  237. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  238. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  239. # and *.h) to filter out the source-files in the directories. If left
  240. # blank all files are included.
  241. EXAMPLE_PATTERNS =
  242. # The IMAGE_PATH tag can be used to specify one or more files or
  243. # directories that contain image that are included in the documentation (see
  244. # the \image command).
  245. IMAGE_PATH =
  246. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  247. # invoke to filter for each input file. Doxygen will invoke the filter program
  248. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  249. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  250. # input file. Doxygen will then use the output that the filter program writes
  251. # to standard output.
  252. INPUT_FILTER =
  253. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  254. # INPUT_FILTER) will be used to filter the input files when producing source
  255. # files to browse.
  256. FILTER_SOURCE_FILES = NO
  257. #---------------------------------------------------------------------------
  258. # configuration options related to the alphabetical class index
  259. #---------------------------------------------------------------------------
  260. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  261. # of all compounds will be generated. Enable this if the project
  262. # contains a lot of classes, structs, unions or interfaces.
  263. ALPHABETICAL_INDEX = NO
  264. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  265. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  266. # in which this list will be split (can be a number in the range [1..20])
  267. COLS_IN_ALPHA_INDEX = 5
  268. # In case all classes in a project start with a common prefix, all
  269. # classes will be put under the same header in the alphabetical index.
  270. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  271. # should be ignored while generating the index headers.
  272. IGNORE_PREFIX =
  273. #---------------------------------------------------------------------------
  274. # configuration options related to the HTML output
  275. #---------------------------------------------------------------------------
  276. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  277. # generate HTML output.
  278. GENERATE_HTML = YES
  279. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  280. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  281. # put in front of it. If left blank `html' will be used as the default path.
  282. HTML_OUTPUT =
  283. # The HTML_HEADER tag can be used to specify a personal HTML header for
  284. # each generated HTML page. If it is left blank doxygen will generate a
  285. # standard header.
  286. HTML_HEADER =
  287. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  288. # each generated HTML page. If it is left blank doxygen will generate a
  289. # standard footer.
  290. HTML_FOOTER =
  291. # The HTML_STYLESHEET tag can be used to specify a user defined cascading
  292. # style sheet that is used by each HTML page. It can be used to
  293. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  294. # will generate a default style sheet
  295. HTML_STYLESHEET =
  296. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  297. # files or namespaces will be aligned in HTML using tables. If set to
  298. # NO a bullet list will be used.
  299. HTML_ALIGN_MEMBERS = YES
  300. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  301. # will be generated that can be used as input for tools like the
  302. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  303. # of the generated HTML documentation.
  304. GENERATE_HTMLHELP = NO
  305. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  306. # controls if a separate .chi index file is generated (YES) or that
  307. # it should be included in the master .chm file (NO).
  308. GENERATE_CHI = NO
  309. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  310. # controls whether a binary table of contents is generated (YES) or a
  311. # normal table of contents (NO) in the .chm file.
  312. BINARY_TOC = NO
  313. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  314. # to the contents of the Html help documentation and to the tree view.
  315. TOC_EXPAND = NO
  316. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  317. # top of each HTML page. The value NO (the default) enables the index and
  318. # the value YES disables it.
  319. DISABLE_INDEX = NO
  320. # This tag can be used to set the number of enum values (range [1..20])
  321. # that doxygen will group on one line in the generated HTML documentation.
  322. ENUM_VALUES_PER_LINE = 4
  323. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  324. # generated containing a tree-like index structure (just like the one that
  325. # is generated for HTML Help). For this to work a browser that supports
  326. # JavaScript and frames is required (for instance Netscape 4.0+
  327. # or Internet explorer 4.0+).
  328. GENERATE_TREEVIEW = NO
  329. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  330. # used to set the initial width (in pixels) of the frame in which the tree
  331. # is shown.
  332. TREEVIEW_WIDTH = 250
  333. #---------------------------------------------------------------------------
  334. # configuration options related to the LaTeX output
  335. #---------------------------------------------------------------------------
  336. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  337. # generate Latex output.
  338. GENERATE_LATEX = NO
  339. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  340. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  341. # put in front of it. If left blank `latex' will be used as the default path.
  342. LATEX_OUTPUT =
  343. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  344. # LaTeX documents. This may be useful for small projects and may help to
  345. # save some trees in general.
  346. COMPACT_LATEX = NO
  347. # The PAPER_TYPE tag can be used to set the paper type that is used
  348. # by the printer. Possible values are: a4, a4wide, letter, legal and
  349. # executive. If left blank a4wide will be used.
  350. PAPER_TYPE = a4wide
  351. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  352. # packages that should be included in the LaTeX output.
  353. EXTRA_PACKAGES =
  354. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  355. # the generated latex document. The header should contain everything until
  356. # the first chapter. If it is left blank doxygen will generate a
  357. # standard header. Notice: only use this tag if you know what you are doing!
  358. LATEX_HEADER =
  359. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  360. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  361. # contain links (just like the HTML output) instead of page references
  362. # This makes the output suitable for online browsing using a pdf viewer.
  363. PDF_HYPERLINKS = NO
  364. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  365. # plain latex in the generated Makefile. Set this option to YES to get a
  366. # higher quality PDF documentation.
  367. USE_PDFLATEX = NO
  368. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  369. # command to the generated LaTeX files. This will instruct LaTeX to keep
  370. # running if errors occur, instead of asking the user for help.
  371. # This option is also used when generating formulas in HTML.
  372. LATEX_BATCHMODE = NO
  373. #---------------------------------------------------------------------------
  374. # configuration options related to the RTF output
  375. #---------------------------------------------------------------------------
  376. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  377. # The RTF output is optimised for Word 97 and may not look very pretty with
  378. # other RTF readers or editors.
  379. GENERATE_RTF = NO
  380. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  381. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  382. # put in front of it. If left blank `rtf' will be used as the default path.
  383. RTF_OUTPUT =
  384. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  385. # RTF documents. This may be useful for small projects and may help to
  386. # save some trees in general.
  387. COMPACT_RTF = NO
  388. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  389. # will contain hyperlink fields. The RTF file will
  390. # contain links (just like the HTML output) instead of page references.
  391. # This makes the output suitable for online browsing using WORD or other
  392. # programs which support those fields.
  393. # Note: wordpad (write) and others do not support links.
  394. RTF_HYPERLINKS = NO
  395. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  396. # config file, i.e. a series of assigments. You only have to provide
  397. # replacements, missing definitions are set to their default value.
  398. RTF_STYLESHEET_FILE =
  399. # Set optional variables used in the generation of an rtf document.
  400. # Syntax is similar to doxygen's config file.
  401. RTF_EXTENSIONS_FILE =
  402. #---------------------------------------------------------------------------
  403. # configuration options related to the man page output
  404. #---------------------------------------------------------------------------
  405. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  406. # generate man pages
  407. GENERATE_MAN = NO
  408. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  409. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  410. # put in front of it. If left blank `man' will be used as the default path.
  411. MAN_OUTPUT =
  412. # The MAN_EXTENSION tag determines the extension that is added to
  413. # the generated man pages (default is the subroutine's section .3)
  414. MAN_EXTENSION =
  415. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  416. # then it will generate one additional man file for each entity
  417. # documented in the real man page(s). These additional files
  418. # only source the real man page, but without them the man command
  419. # would be unable to find the correct page. The default is NO.
  420. MAN_LINKS = NO
  421. #---------------------------------------------------------------------------
  422. # Configuration options related to the preprocessor
  423. #---------------------------------------------------------------------------
  424. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  425. # evaluate all C-preprocessor directives found in the sources and include
  426. # files.
  427. ENABLE_PREPROCESSING = YES
  428. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  429. # names in the source code. If set to NO (the default) only conditional
  430. # compilation will be performed. Macro expansion can be done in a controlled
  431. # way by setting EXPAND_ONLY_PREDEF to YES.
  432. MACRO_EXPANSION = NO
  433. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  434. # then the macro expansion is limited to the macros specified with the
  435. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  436. EXPAND_ONLY_PREDEF = NO
  437. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  438. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  439. SEARCH_INCLUDES = YES
  440. # The INCLUDE_PATH tag can be used to specify one or more directories that
  441. # contain include files that are not input files but should be processed by
  442. # the preprocessor.
  443. INCLUDE_PATH =
  444. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  445. # patterns (like *.h and *.hpp) to filter out the header-files in the
  446. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  447. # be used.
  448. INCLUDE_FILE_PATTERNS =
  449. # The PREDEFINED tag can be used to specify one or more macro names that
  450. # are defined before the preprocessor is started (similar to the -D option of
  451. # gcc). The argument of the tag is a list of macros of the form: name
  452. # or name=definition (no spaces). If the definition and the = are
  453. # omitted =1 is assumed.
  454. PREDEFINED =
  455. # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
  456. # this tag can be used to specify a list of macro names that should be expanded.
  457. # The macro definition that is found in the sources will be used.
  458. # Use the PREDEFINED tag if you want to use a different macro definition.
  459. EXPAND_AS_DEFINED =
  460. #---------------------------------------------------------------------------
  461. # Configuration::addtions related to external references
  462. #---------------------------------------------------------------------------
  463. # The TAGFILES tag can be used to specify one or more tagfiles.
  464. TAGFILES =
  465. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  466. # a tag file that is based on the input files it reads.
  467. GENERATE_TAGFILE =
  468. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  469. # in the class index. If set to NO only the inherited external classes
  470. # will be listed.
  471. ALLEXTERNALS = NO
  472. # The PERL_PATH should be the absolute path and name of the perl script
  473. # interpreter (i.e. the result of `which perl').
  474. PERL_PATH =
  475. #---------------------------------------------------------------------------
  476. # Configuration options related to the dot tool
  477. #---------------------------------------------------------------------------
  478. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  479. # available from the path. This tool is part of Graphviz, a graph visualization
  480. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  481. # have no effect if this option is set to NO (the default)
  482. HAVE_DOT = NO
  483. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  484. # will generate a graph for each documented class showing the direct and
  485. # indirect inheritance relations. Setting this tag to YES will force the
  486. # the CLASS_DIAGRAMS tag to NO.
  487. CLASS_GRAPH = YES
  488. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  489. # will generate a graph for each documented class showing the direct and
  490. # indirect implementation dependencies (inheritance, containment, and
  491. # class references variables) of the class with other documented classes.
  492. COLLABORATION_GRAPH = YES
  493. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  494. # tags are set to YES then doxygen will generate a graph for each documented
  495. # file showing the direct and indirect include dependencies of the file with
  496. # other documented files.
  497. INCLUDE_GRAPH = YES
  498. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  499. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  500. # documented header file showing the documented files that directly or
  501. # indirectly include this file.
  502. INCLUDED_BY_GRAPH = YES
  503. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  504. # will graphical hierarchy of all classes instead of a textual one.
  505. GRAPHICAL_HIERARCHY = YES
  506. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  507. # found. If left blank, it is assumed the dot tool can be found on the path.
  508. DOT_PATH =
  509. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  510. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  511. # this value, doxygen will try to truncate the graph, so that it fits within
  512. # the specified constraint. Beware that most browsers cannot cope with very
  513. # large images.
  514. MAX_DOT_GRAPH_WIDTH = 1024
  515. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  516. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  517. # this value, doxygen will try to truncate the graph, so that it fits within
  518. # the specified constraint. Beware that most browsers cannot cope with very
  519. # large images.
  520. MAX_DOT_GRAPH_HEIGHT = 1024
  521. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  522. # generate a legend page explaining the meaning of the various boxes and
  523. # arrows in the dot generated graphs.
  524. GENERATE_LEGEND = YES
  525. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  526. # remove the intermedate dot files that are used to generate
  527. # the various graphs.
  528. DOT_CLEANUP = YES
  529. #---------------------------------------------------------------------------
  530. # Configuration::addtions related to the search engine
  531. #---------------------------------------------------------------------------
  532. # The SEARCHENGINE tag specifies whether or not a search engine should be
  533. # used. If set to NO the values of all tags below this one will be ignored.
  534. SEARCHENGINE = NO
  535. # The CGI_NAME tag should be the name of the CGI script that
  536. # starts the search engine (doxysearch) with the correct parameters.
  537. # A script with this name will be generated by doxygen.
  538. CGI_NAME =
  539. # The CGI_URL tag should be the absolute URL to the directory where the
  540. # cgi binaries are located. See the documentation of your http daemon for
  541. # details.
  542. CGI_URL =
  543. # The DOC_URL tag should be the absolute URL to the directory where the
  544. # documentation is located. If left blank the absolute path to the
  545. # documentation, with file:// prepended to it, will be used.
  546. DOC_URL =
  547. # The DOC_ABSPATH tag should be the absolute path to the directory where the
  548. # documentation is located. If left blank the directory on the local machine
  549. # will be used.
  550. DOC_ABSPATH =
  551. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
  552. # is installed.
  553. BIN_ABSPATH =
  554. # The EXT_DOC_PATHS tag can be used to specify one or more paths to
  555. # documentation generated for other projects. This allows doxysearch to search
  556. # the documentation for these projects as well.
  557. EXT_DOC_PATHS =