Rosegarden – music editor and MIDI/audio sequencer
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 49KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232
  1. # Doxyfile 1.4.4
  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. # 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 = Rosegarden
  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.7.0
  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 = /tmp
  26. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  27. # 4096 sub-directories (in 2 levels) under the output directory of each output
  28. # format and will distribute the generated files over these directories.
  29. # Enabling this option can be useful when feeding doxygen a huge amount of
  30. # source files, where putting all generated files in the same directory would
  31. # otherwise cause performance problems for the file system.
  32. CREATE_SUBDIRS = NO
  33. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  34. # documentation generated by doxygen is written. Doxygen will use this
  35. # information to generate all constant output in the proper language.
  36. # The default language is English, other supported languages are:
  37. # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
  38. # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
  39. # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
  40. # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
  41. # Swedish, and Ukrainian.
  42. OUTPUT_LANGUAGE = English
  43. # This tag can be used to specify the encoding used in the generated output.
  44. # The encoding is not always determined by the language that is chosen,
  45. # but also whether or not the output is meant for Windows or non-Windows users.
  46. # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
  47. # forces the Windows encoding (this is the default for the Windows binary),
  48. # whereas setting the tag to NO uses a Unix-style encoding (the default for
  49. # all platforms other than Windows).
  50. USE_WINDOWS_ENCODING = NO
  51. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  52. # include brief member descriptions after the members that are listed in
  53. # the file and class documentation (similar to JavaDoc).
  54. # Set to NO to disable this.
  55. BRIEF_MEMBER_DESC = YES
  56. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  57. # the brief description of a member or function before the detailed description.
  58. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  59. # brief descriptions will be completely suppressed.
  60. REPEAT_BRIEF = YES
  61. # This tag implements a quasi-intelligent brief description abbreviator
  62. # that is used to form the text in various listings. Each string
  63. # in this list, if found as the leading text of the brief description, will be
  64. # stripped from the text and the result after processing the whole list, is
  65. # used as the annotated text. Otherwise, the brief description is used as-is.
  66. # If left blank, the following values are used ("$name" is automatically
  67. # replaced with the name of the entity): "The $name class" "The $name widget"
  68. # "The $name file" "is" "provides" "specifies" "contains"
  69. # "represents" "a" "an" "the"
  70. ABBREVIATE_BRIEF =
  71. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  72. # Doxygen will generate a detailed section even if there is only a brief
  73. # description.
  74. ALWAYS_DETAILED_SEC = NO
  75. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  76. # inherited members of a class in the documentation of that class as if those
  77. # members were ordinary class members. Constructors, destructors and assignment
  78. # operators of the base classes will not be shown.
  79. INLINE_INHERITED_MEMB = YES
  80. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  81. # path before files name in the file list and in the header files. If set
  82. # to NO the shortest path that makes the file name unique will be used
  83. FULL_PATH_NAMES = YES
  84. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  85. # can be used to strip a user-defined part of the path. Stripping is
  86. # only done if one of the specified strings matches the left-hand part of
  87. # the path. The tag can be used to show relative paths in the file list.
  88. # If left blank the directory from which doxygen is run is used as the
  89. # path to strip.
  90. STRIP_FROM_PATH =
  91. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  92. # the path mentioned in the documentation of a class, which tells
  93. # the reader which header file to include in order to use a class.
  94. # If left blank only the name of the header file containing the class
  95. # definition is used. Otherwise one should specify the include paths that
  96. # are normally passed to the compiler using the -I flag.
  97. STRIP_FROM_INC_PATH =
  98. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  99. # (but less readable) file names. This can be useful is your file systems
  100. # doesn't support long names like on DOS, Mac, or CD-ROM.
  101. SHORT_NAMES = NO
  102. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  103. # will interpret the first line (until the first dot) of a JavaDoc-style
  104. # comment as the brief description. If set to NO, the JavaDoc
  105. # comments will behave just like the Qt-style comments (thus requiring an
  106. # explicit @brief command for a brief description.
  107. JAVADOC_AUTOBRIEF = NO
  108. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  109. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  110. # comments) as a brief description. This used to be the default behaviour.
  111. # The new default is to treat a multi-line C++ comment block as a detailed
  112. # description. Set this tag to YES if you prefer the old behaviour instead.
  113. MULTILINE_CPP_IS_BRIEF = NO
  114. # If the DETAILS_AT_TOP tag is set to YES then Doxygen
  115. # will output the detailed description near the top, like JavaDoc.
  116. # If set to NO, the detailed description appears after the member
  117. # documentation.
  118. DETAILS_AT_TOP = NO
  119. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  120. # member inherits the documentation from any documented member that it
  121. # re-implements.
  122. INHERIT_DOCS = YES
  123. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  124. # tag is set to YES, then doxygen will reuse the documentation of the first
  125. # member in the group (if any) for the other members of the group. By default
  126. # all members of a group must be documented explicitly.
  127. DISTRIBUTE_GROUP_DOC = NO
  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 = NO
  147. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
  148. # only. Doxygen will then generate output that is more tailored for Java.
  149. # For instance, namespaces will be presented as packages, qualified scopes
  150. # will look different, etc.
  151. OPTIMIZE_OUTPUT_JAVA = NO
  152. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  153. # the same type (for instance a group of public functions) to be put as a
  154. # subgroup of that type (e.g. under the Public Functions section). Set it to
  155. # NO to prevent subgrouping. Alternatively, this can be done per class using
  156. # the \nosubgrouping command.
  157. SUBGROUPING = YES
  158. #---------------------------------------------------------------------------
  159. # Build related configuration options
  160. #---------------------------------------------------------------------------
  161. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  162. # documentation are documented, even if no documentation was available.
  163. # Private class members and static file members will be hidden unless
  164. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  165. EXTRACT_ALL = YES
  166. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  167. # will be included in the documentation.
  168. EXTRACT_PRIVATE = YES
  169. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  170. # will be included in the documentation.
  171. EXTRACT_STATIC = YES
  172. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  173. # defined locally in source files will be included in the documentation.
  174. # If set to NO only classes defined in header files are included.
  175. EXTRACT_LOCAL_CLASSES = YES
  176. # This flag is only useful for Objective-C code. When set to YES local
  177. # methods, which are defined in the implementation section but not in
  178. # the interface are included in the documentation.
  179. # If set to NO (the default) only methods in the interface are included.
  180. EXTRACT_LOCAL_METHODS = NO
  181. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  182. # undocumented members of documented classes, files or namespaces.
  183. # If set to NO (the default) these members will be included in the
  184. # various overviews, but no documentation section is generated.
  185. # This option has no effect if EXTRACT_ALL is enabled.
  186. HIDE_UNDOC_MEMBERS = NO
  187. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  188. # undocumented classes that are normally visible in the class hierarchy.
  189. # If set to NO (the default) these classes will be included in the various
  190. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  191. HIDE_UNDOC_CLASSES = NO
  192. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  193. # friend (class|struct|union) declarations.
  194. # If set to NO (the default) these declarations will be included in the
  195. # documentation.
  196. HIDE_FRIEND_COMPOUNDS = NO
  197. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  198. # documentation blocks found inside the body of a function.
  199. # If set to NO (the default) these blocks will be appended to the
  200. # function's detailed documentation block.
  201. HIDE_IN_BODY_DOCS = NO
  202. # The INTERNAL_DOCS tag determines if documentation
  203. # that is typed after a \internal command is included. If the tag is set
  204. # to NO (the default) then the documentation will be excluded.
  205. # Set it to YES to include the internal documentation.
  206. INTERNAL_DOCS = NO
  207. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  208. # file names in lower-case letters. If set to YES upper-case letters are also
  209. # allowed. This is useful if you have classes or files whose names only differ
  210. # in case and if your file system supports case sensitive file names. Windows
  211. # and Mac users are advised to set this option to NO.
  212. CASE_SENSE_NAMES = YES
  213. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  214. # will show members with their full class and namespace scopes in the
  215. # documentation. If set to YES the scope will be hidden.
  216. HIDE_SCOPE_NAMES = NO
  217. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  218. # will put a list of the files that are included by a file in the documentation
  219. # of that file.
  220. SHOW_INCLUDE_FILES = YES
  221. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  222. # is inserted in the documentation for inline members.
  223. INLINE_INFO = YES
  224. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  225. # will sort the (detailed) documentation of file and class members
  226. # alphabetically by member name. If set to NO the members will appear in
  227. # declaration order.
  228. SORT_MEMBER_DOCS = YES
  229. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  230. # brief documentation of file, namespace and class members alphabetically
  231. # by member name. If set to NO (the default) the members will appear in
  232. # declaration order.
  233. SORT_BRIEF_DOCS = NO
  234. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  235. # sorted by fully-qualified names, including namespaces. If set to
  236. # NO (the default), the class list will be sorted only by class name,
  237. # not including the namespace part.
  238. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  239. # Note: This option applies only to the class list, not to the
  240. # alphabetical list.
  241. SORT_BY_SCOPE_NAME = NO
  242. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  243. # disable (NO) the todo list. This list is created by putting \todo
  244. # commands in the documentation.
  245. GENERATE_TODOLIST = YES
  246. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  247. # disable (NO) the test list. This list is created by putting \test
  248. # commands in the documentation.
  249. GENERATE_TESTLIST = YES
  250. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  251. # disable (NO) the bug list. This list is created by putting \bug
  252. # commands in the documentation.
  253. GENERATE_BUGLIST = YES
  254. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  255. # disable (NO) the deprecated list. This list is created by putting
  256. # \deprecated commands in the documentation.
  257. GENERATE_DEPRECATEDLIST= YES
  258. # The ENABLED_SECTIONS tag can be used to enable conditional
  259. # documentation sections, marked by \if sectionname ... \endif.
  260. ENABLED_SECTIONS =
  261. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  262. # the initial value of a variable or define consists of for it to appear in
  263. # the documentation. If the initializer consists of more lines than specified
  264. # here it will be hidden. Use a value of 0 to hide initializers completely.
  265. # The appearance of the initializer of individual variables and defines in the
  266. # documentation can be controlled using \showinitializer or \hideinitializer
  267. # command in the documentation regardless of this setting.
  268. MAX_INITIALIZER_LINES = 30
  269. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  270. # at the bottom of the documentation of classes and structs. If set to YES the
  271. # list will mention the files that were used to generate the documentation.
  272. SHOW_USED_FILES = YES
  273. # If the sources in your project are distributed over multiple directories
  274. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  275. # in the documentation. The default is YES.
  276. SHOW_DIRECTORIES = YES
  277. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  278. # doxygen should invoke to get the current version for each file (typically from the
  279. # version control system). Doxygen will invoke the program by executing (via
  280. # popen()) the command <command> <input-file>, where <command> is the value of
  281. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  282. # provided by doxygen. Whatever the progam writes to standard output
  283. # is used as the file version. See the manual for examples.
  284. FILE_VERSION_FILTER =
  285. #---------------------------------------------------------------------------
  286. # configuration options related to warning and progress messages
  287. #---------------------------------------------------------------------------
  288. # The QUIET tag can be used to turn on/off the messages that are generated
  289. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  290. QUIET = NO
  291. # The WARNINGS tag can be used to turn on/off the warning messages that are
  292. # generated by doxygen. Possible values are YES and NO. If left blank
  293. # NO is used.
  294. WARNINGS = YES
  295. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  296. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  297. # automatically be disabled.
  298. WARN_IF_UNDOCUMENTED = YES
  299. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  300. # potential errors in the documentation, such as not documenting some
  301. # parameters in a documented function, or documenting parameters that
  302. # don't exist or using markup commands wrongly.
  303. WARN_IF_DOC_ERROR = YES
  304. # This WARN_NO_PARAMDOC option can be abled to get warnings for
  305. # functions that are documented, but have no documentation for their parameters
  306. # or return value. If set to NO (the default) doxygen will only warn about
  307. # wrong or incomplete parameter documentation, but not about the absence of
  308. # documentation.
  309. WARN_NO_PARAMDOC = YES
  310. # The WARN_FORMAT tag determines the format of the warning messages that
  311. # doxygen can produce. The string should contain the $file, $line, and $text
  312. # tags, which will be replaced by the file and line number from which the
  313. # warning originated and the warning text. Optionally the format may contain
  314. # $version, which will be replaced by the version of the file (if it could
  315. # be obtained via FILE_VERSION_FILTER)
  316. WARN_FORMAT = "$file:$line: $text"
  317. # The WARN_LOGFILE tag can be used to specify a file to which warning
  318. # and error messages should be written. If left blank the output is written
  319. # to stderr.
  320. WARN_LOGFILE = docs/doxygen/warning.log
  321. #---------------------------------------------------------------------------
  322. # configuration options related to the input files
  323. #---------------------------------------------------------------------------
  324. # The INPUT tag can be used to specify the files and/or directories that contain
  325. # documented source files. You may enter file names like "myfile.cpp" or
  326. # directories like "/usr/src/myproject". Separate the files or directories
  327. # with spaces.
  328. INPUT = src/base/ src/commands/ src/document/ src/gui/ src/helpers/ src/misc/ src/sequencer/ src/sound/
  329. # If the value of the INPUT tag contains directories, you can use the
  330. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  331. # and *.h) to filter out the source-files in the directories. If left
  332. # blank the following patterns are tested:
  333. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  334. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
  335. FILE_PATTERNS = *.h \
  336. *.C \
  337. *.cpp \
  338. *.cc
  339. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  340. # should be searched for input files as well. Possible values are YES and NO.
  341. # If left blank NO is used.
  342. RECURSIVE = YES
  343. # The EXCLUDE tag can be used to specify files and/or directories that should
  344. # excluded from the INPUT source files. This way you can easily exclude a
  345. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  346. EXCLUDE =
  347. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  348. # directories that are symbolic links (a Unix filesystem feature) are excluded
  349. # from the input.
  350. EXCLUDE_SYMLINKS = NO
  351. # If the value of the INPUT tag contains directories, you can use the
  352. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  353. # certain files from those directories. Note that the wildcards are matched
  354. # against the file with absolute path, so to exclude all test directories
  355. # for example use the pattern */test/*
  356. EXCLUDE_PATTERNS = *.moc.cpp \
  357. *_skel.cpp
  358. # The EXAMPLE_PATH tag can be used to specify one or more files or
  359. # directories that contain example code fragments that are included (see
  360. # the \include command).
  361. EXAMPLE_PATH =
  362. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  363. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  364. # and *.h) to filter out the source-files in the directories. If left
  365. # blank all files are included.
  366. EXAMPLE_PATTERNS =
  367. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  368. # searched for input files to be used with the \include or \dontinclude
  369. # commands irrespective of the value of the RECURSIVE tag.
  370. # Possible values are YES and NO. If left blank NO is used.
  371. EXAMPLE_RECURSIVE = NO
  372. # The IMAGE_PATH tag can be used to specify one or more files or
  373. # directories that contain image that are included in the documentation (see
  374. # the \image command).
  375. IMAGE_PATH =
  376. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  377. # invoke to filter for each input file. Doxygen will invoke the filter program
  378. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  379. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  380. # input file. Doxygen will then use the output that the filter program writes
  381. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  382. # ignored.
  383. INPUT_FILTER =
  384. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  385. # basis. Doxygen will compare the file name with each pattern and apply the
  386. # filter if there is a match. The filters are a list of the form:
  387. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  388. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  389. # is applied to all files.
  390. FILTER_PATTERNS =
  391. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  392. # INPUT_FILTER) will be used to filter the input files when producing source
  393. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  394. FILTER_SOURCE_FILES = NO
  395. #---------------------------------------------------------------------------
  396. # configuration options related to source browsing
  397. #---------------------------------------------------------------------------
  398. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  399. # be generated. Documented entities will be cross-referenced with these sources.
  400. # Note: To get rid of all source code in the generated output, make sure also
  401. # VERBATIM_HEADERS is set to NO.
  402. SOURCE_BROWSER = YES
  403. # Setting the INLINE_SOURCES tag to YES will include the body
  404. # of functions and classes directly in the documentation.
  405. INLINE_SOURCES = NO
  406. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  407. # doxygen to hide any special comment blocks from generated source code
  408. # fragments. Normal C and C++ comments will always remain visible.
  409. STRIP_CODE_COMMENTS = YES
  410. # If the REFERENCED_BY_RELATION tag is set to YES (the default)
  411. # then for each documented function all documented
  412. # functions referencing it will be listed.
  413. REFERENCED_BY_RELATION = YES
  414. # If the REFERENCES_RELATION tag is set to YES (the default)
  415. # then for each documented function all documented entities
  416. # called/used by that function will be listed.
  417. REFERENCES_RELATION = YES
  418. # If the USE_HTAGS tag is set to YES then the references to source code
  419. # will point to the HTML generated by the htags(1) tool instead of doxygen
  420. # built-in source browser. The htags tool is part of GNU's global source
  421. # tagging system (see http://www.gnu.org/software/global/global.html). You
  422. # will need version 4.8.6 or higher.
  423. USE_HTAGS = NO
  424. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  425. # will generate a verbatim copy of the header file for each class for
  426. # which an include is specified. Set to NO to disable this.
  427. VERBATIM_HEADERS = YES
  428. #---------------------------------------------------------------------------
  429. # configuration options related to the alphabetical class index
  430. #---------------------------------------------------------------------------
  431. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  432. # of all compounds will be generated. Enable this if the project
  433. # contains a lot of classes, structs, unions or interfaces.
  434. ALPHABETICAL_INDEX = NO
  435. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  436. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  437. # in which this list will be split (can be a number in the range [1..20])
  438. COLS_IN_ALPHA_INDEX = 5
  439. # In case all classes in a project start with a common prefix, all
  440. # classes will be put under the same header in the alphabetical index.
  441. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  442. # should be ignored while generating the index headers.
  443. IGNORE_PREFIX =
  444. #---------------------------------------------------------------------------
  445. # configuration options related to the HTML output
  446. #---------------------------------------------------------------------------
  447. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  448. # generate HTML output.
  449. GENERATE_HTML = YES
  450. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  451. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  452. # put in front of it. If left blank `html' will be used as the default path.
  453. HTML_OUTPUT = html
  454. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  455. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  456. # doxygen will generate files with .html extension.
  457. HTML_FILE_EXTENSION = .html
  458. # The HTML_HEADER tag can be used to specify a personal HTML header for
  459. # each generated HTML page. If it is left blank doxygen will generate a
  460. # standard header.
  461. HTML_HEADER =
  462. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  463. # each generated HTML page. If it is left blank doxygen will generate a
  464. # standard footer.
  465. HTML_FOOTER =
  466. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  467. # style sheet that is used by each HTML page. It can be used to
  468. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  469. # will generate a default style sheet. Note that doxygen will try to copy
  470. # the style sheet file to the HTML output directory, so don't put your own
  471. # stylesheet in the HTML output directory as well, or it will be erased!
  472. HTML_STYLESHEET =
  473. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  474. # files or namespaces will be aligned in HTML using tables. If set to
  475. # NO a bullet list will be used.
  476. HTML_ALIGN_MEMBERS = YES
  477. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  478. # will be generated that can be used as input for tools like the
  479. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  480. # of the generated HTML documentation.
  481. GENERATE_HTMLHELP = NO
  482. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  483. # be used to specify the file name of the resulting .chm file. You
  484. # can add a path in front of the file if the result should not be
  485. # written to the html output directory.
  486. CHM_FILE =
  487. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  488. # be used to specify the location (absolute path including file name) of
  489. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  490. # the HTML help compiler on the generated index.hhp.
  491. HHC_LOCATION =
  492. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  493. # controls if a separate .chi index file is generated (YES) or that
  494. # it should be included in the master .chm file (NO).
  495. GENERATE_CHI = NO
  496. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  497. # controls whether a binary table of contents is generated (YES) or a
  498. # normal table of contents (NO) in the .chm file.
  499. BINARY_TOC = NO
  500. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  501. # to the contents of the HTML help documentation and to the tree view.
  502. TOC_EXPAND = NO
  503. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  504. # top of each HTML page. The value NO (the default) enables the index and
  505. # the value YES disables it.
  506. DISABLE_INDEX = NO
  507. # This tag can be used to set the number of enum values (range [1..20])
  508. # that doxygen will group on one line in the generated HTML documentation.
  509. ENUM_VALUES_PER_LINE = 4
  510. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  511. # generated containing a tree-like index structure (just like the one that
  512. # is generated for HTML Help). For this to work a browser that supports
  513. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
  514. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  515. # probably better off using the HTML help feature.
  516. GENERATE_TREEVIEW = NO
  517. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  518. # used to set the initial width (in pixels) of the frame in which the tree
  519. # is shown.
  520. TREEVIEW_WIDTH = 250
  521. #---------------------------------------------------------------------------
  522. # configuration options related to the LaTeX output
  523. #---------------------------------------------------------------------------
  524. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  525. # generate Latex output.
  526. GENERATE_LATEX = NO
  527. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  528. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  529. # put in front of it. If left blank `latex' will be used as the default path.
  530. LATEX_OUTPUT = latex
  531. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  532. # invoked. If left blank `latex' will be used as the default command name.
  533. LATEX_CMD_NAME = latex
  534. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  535. # generate index for LaTeX. If left blank `makeindex' will be used as the
  536. # default command name.
  537. MAKEINDEX_CMD_NAME = makeindex
  538. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  539. # LaTeX documents. This may be useful for small projects and may help to
  540. # save some trees in general.
  541. COMPACT_LATEX = NO
  542. # The PAPER_TYPE tag can be used to set the paper type that is used
  543. # by the printer. Possible values are: a4, a4wide, letter, legal and
  544. # executive. If left blank a4wide will be used.
  545. PAPER_TYPE = a4wide
  546. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  547. # packages that should be included in the LaTeX output.
  548. EXTRA_PACKAGES =
  549. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  550. # the generated latex document. The header should contain everything until
  551. # the first chapter. If it is left blank doxygen will generate a
  552. # standard header. Notice: only use this tag if you know what you are doing!
  553. LATEX_HEADER =
  554. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  555. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  556. # contain links (just like the HTML output) instead of page references
  557. # This makes the output suitable for online browsing using a pdf viewer.
  558. PDF_HYPERLINKS = NO
  559. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  560. # plain latex in the generated Makefile. Set this option to YES to get a
  561. # higher quality PDF documentation.
  562. USE_PDFLATEX = NO
  563. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  564. # command to the generated LaTeX files. This will instruct LaTeX to keep
  565. # running if errors occur, instead of asking the user for help.
  566. # This option is also used when generating formulas in HTML.
  567. LATEX_BATCHMODE = NO
  568. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  569. # include the index chapters (such as File Index, Compound Index, etc.)
  570. # in the output.
  571. LATEX_HIDE_INDICES = NO
  572. #---------------------------------------------------------------------------
  573. # configuration options related to the RTF output
  574. #---------------------------------------------------------------------------
  575. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  576. # The RTF output is optimized for Word 97 and may not look very pretty with
  577. # other RTF readers or editors.
  578. GENERATE_RTF = NO
  579. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  580. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  581. # put in front of it. If left blank `rtf' will be used as the default path.
  582. RTF_OUTPUT = rtf
  583. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  584. # RTF documents. This may be useful for small projects and may help to
  585. # save some trees in general.
  586. COMPACT_RTF = NO
  587. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  588. # will contain hyperlink fields. The RTF file will
  589. # contain links (just like the HTML output) instead of page references.
  590. # This makes the output suitable for online browsing using WORD or other
  591. # programs which support those fields.
  592. # Note: wordpad (write) and others do not support links.
  593. RTF_HYPERLINKS = NO
  594. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  595. # config file, i.e. a series of assignments. You only have to provide
  596. # replacements, missing definitions are set to their default value.
  597. RTF_STYLESHEET_FILE =
  598. # Set optional variables used in the generation of an rtf document.
  599. # Syntax is similar to doxygen's config file.
  600. RTF_EXTENSIONS_FILE =
  601. #---------------------------------------------------------------------------
  602. # configuration options related to the man page output
  603. #---------------------------------------------------------------------------
  604. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  605. # generate man pages
  606. GENERATE_MAN = NO
  607. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  608. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  609. # put in front of it. If left blank `man' will be used as the default path.
  610. MAN_OUTPUT = man
  611. # The MAN_EXTENSION tag determines the extension that is added to
  612. # the generated man pages (default is the subroutine's section .3)
  613. MAN_EXTENSION = .3
  614. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  615. # then it will generate one additional man file for each entity
  616. # documented in the real man page(s). These additional files
  617. # only source the real man page, but without them the man command
  618. # would be unable to find the correct page. The default is NO.
  619. MAN_LINKS = NO
  620. #---------------------------------------------------------------------------
  621. # configuration options related to the XML output
  622. #---------------------------------------------------------------------------
  623. # If the GENERATE_XML tag is set to YES Doxygen will
  624. # generate an XML file that captures the structure of
  625. # the code including all documentation.
  626. GENERATE_XML = NO
  627. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  628. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  629. # put in front of it. If left blank `xml' will be used as the default path.
  630. XML_OUTPUT = xml
  631. # The XML_SCHEMA tag can be used to specify an XML schema,
  632. # which can be used by a validating XML parser to check the
  633. # syntax of the XML files.
  634. XML_SCHEMA =
  635. # The XML_DTD tag can be used to specify an XML DTD,
  636. # which can be used by a validating XML parser to check the
  637. # syntax of the XML files.
  638. XML_DTD =
  639. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  640. # dump the program listings (including syntax highlighting
  641. # and cross-referencing information) to the XML output. Note that
  642. # enabling this will significantly increase the size of the XML output.
  643. XML_PROGRAMLISTING = YES
  644. #---------------------------------------------------------------------------
  645. # configuration options for the AutoGen Definitions output
  646. #---------------------------------------------------------------------------
  647. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  648. # generate an AutoGen Definitions (see autogen.sf.net) file
  649. # that captures the structure of the code including all
  650. # documentation. Note that this feature is still experimental
  651. # and incomplete at the moment.
  652. GENERATE_AUTOGEN_DEF = NO
  653. #---------------------------------------------------------------------------
  654. # configuration options related to the Perl module output
  655. #---------------------------------------------------------------------------
  656. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  657. # generate a Perl module file that captures the structure of
  658. # the code including all documentation. Note that this
  659. # feature is still experimental and incomplete at the
  660. # moment.
  661. GENERATE_PERLMOD = NO
  662. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  663. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  664. # to generate PDF and DVI output from the Perl module output.
  665. PERLMOD_LATEX = NO
  666. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  667. # nicely formatted so it can be parsed by a human reader. This is useful
  668. # if you want to understand what is going on. On the other hand, if this
  669. # tag is set to NO the size of the Perl module output will be much smaller
  670. # and Perl will parse it just the same.
  671. PERLMOD_PRETTY = YES
  672. # The names of the make variables in the generated doxyrules.make file
  673. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  674. # This is useful so different doxyrules.make files included by the same
  675. # Makefile don't overwrite each other's variables.
  676. PERLMOD_MAKEVAR_PREFIX =
  677. #---------------------------------------------------------------------------
  678. # Configuration options related to the preprocessor
  679. #---------------------------------------------------------------------------
  680. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  681. # evaluate all C-preprocessor directives found in the sources and include
  682. # files.
  683. ENABLE_PREPROCESSING = YES
  684. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  685. # names in the source code. If set to NO (the default) only conditional
  686. # compilation will be performed. Macro expansion can be done in a controlled
  687. # way by setting EXPAND_ONLY_PREDEF to YES.
  688. MACRO_EXPANSION = NO
  689. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  690. # then the macro expansion is limited to the macros specified with the
  691. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  692. EXPAND_ONLY_PREDEF = NO
  693. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  694. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  695. SEARCH_INCLUDES = YES
  696. # The INCLUDE_PATH tag can be used to specify one or more directories that
  697. # contain include files that are not input files but should be processed by
  698. # the preprocessor.
  699. INCLUDE_PATH =
  700. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  701. # patterns (like *.h and *.hpp) to filter out the header-files in the
  702. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  703. # be used.
  704. INCLUDE_FILE_PATTERNS =
  705. # The PREDEFINED tag can be used to specify one or more macro names that
  706. # are defined before the preprocessor is started (similar to the -D option of
  707. # gcc). The argument of the tag is a list of macros of the form: name
  708. # or name=definition (no spaces). If the definition and the = are
  709. # omitted =1 is assumed. To prevent a macro definition from being
  710. # undefined via #undef or recursively expanded use the := operator
  711. # instead of the = operator.
  712. PREDEFINED = HAVE_ALSA HAVE_LIBJACK HAVE_DSSI HAVE_LADSPA HAVE_LIBLO HAVE_LIBLRDF HAVE_XFT HAVE_LIRC
  713. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  714. # this tag can be used to specify a list of macro names that should be expanded.
  715. # The macro definition that is found in the sources will be used.
  716. # Use the PREDEFINED tag if you want to use a different macro definition.
  717. EXPAND_AS_DEFINED =
  718. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  719. # doxygen's preprocessor will remove all function-like macros that are alone
  720. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  721. # function macros are typically used for boiler-plate code, and will confuse
  722. # the parser if not removed.
  723. SKIP_FUNCTION_MACROS = YES
  724. #---------------------------------------------------------------------------
  725. # Configuration::additions related to external references
  726. #---------------------------------------------------------------------------
  727. # The TAGFILES option can be used to specify one or more tagfiles.
  728. # Optionally an initial location of the external documentation
  729. # can be added for each tagfile. The format of a tag file without
  730. # this location is as follows:
  731. # TAGFILES = file1 file2 ...
  732. # Adding location for the tag files is done as follows:
  733. # TAGFILES = file1=loc1 "file2 = loc2" ...
  734. # where "loc1" and "loc2" can be relative or absolute paths or
  735. # URLs. If a location is present for each tag, the installdox tool
  736. # does not have to be run to correct the links.
  737. # Note that each tag file must have a unique name
  738. # (where the name does NOT include the path)
  739. # If a tag file is not located in the directory in which doxygen
  740. # is run, you must also specify the path to the tagfile here.
  741. TAGFILES =
  742. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  743. # a tag file that is based on the input files it reads.
  744. GENERATE_TAGFILE =
  745. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  746. # in the class index. If set to NO only the inherited external classes
  747. # will be listed.
  748. ALLEXTERNALS = NO
  749. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  750. # in the modules index. If set to NO, only the current project's groups will
  751. # be listed.
  752. EXTERNAL_GROUPS = YES
  753. # The PERL_PATH should be the absolute path and name of the perl script
  754. # interpreter (i.e. the result of `which perl').
  755. PERL_PATH = /usr/bin/perl
  756. #---------------------------------------------------------------------------
  757. # Configuration options related to the dot tool
  758. #---------------------------------------------------------------------------
  759. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  760. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  761. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  762. # this option is superseded by the HAVE_DOT option below. This is only a
  763. # fallback. It is recommended to install and use dot, since it yields more
  764. # powerful graphs.
  765. CLASS_DIAGRAMS = YES
  766. # If set to YES, the inheritance and collaboration graphs will hide
  767. # inheritance and usage relations if the target is undocumented
  768. # or is not a class.
  769. HIDE_UNDOC_RELATIONS = YES
  770. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  771. # available from the path. This tool is part of Graphviz, a graph visualization
  772. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  773. # have no effect if this option is set to NO (the default)
  774. HAVE_DOT = NO
  775. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  776. # will generate a graph for each documented class showing the direct and
  777. # indirect inheritance relations. Setting this tag to YES will force the
  778. # the CLASS_DIAGRAMS tag to NO.
  779. CLASS_GRAPH = YES
  780. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  781. # will generate a graph for each documented class showing the direct and
  782. # indirect implementation dependencies (inheritance, containment, and
  783. # class references variables) of the class with other documented classes.
  784. COLLABORATION_GRAPH = YES
  785. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  786. # will generate a graph for groups, showing the direct groups dependencies
  787. GROUP_GRAPHS = YES
  788. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  789. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  790. # Language.
  791. UML_LOOK = NO
  792. # If set to YES, the inheritance and collaboration graphs will show the
  793. # relations between templates and their instances.
  794. TEMPLATE_RELATIONS = NO
  795. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  796. # tags are set to YES then doxygen will generate a graph for each documented
  797. # file showing the direct and indirect include dependencies of the file with
  798. # other documented files.
  799. INCLUDE_GRAPH = YES
  800. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  801. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  802. # documented header file showing the documented files that directly or
  803. # indirectly include this file.
  804. INCLUDED_BY_GRAPH = YES
  805. # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
  806. # generate a call dependency graph for every global function or class method.
  807. # Note that enabling this option will significantly increase the time of a run.
  808. # So in most cases it will be better to enable call graphs for selected
  809. # functions only using the \callgraph command.
  810. CALL_GRAPH = NO
  811. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  812. # will graphical hierarchy of all classes instead of a textual one.
  813. GRAPHICAL_HIERARCHY = YES
  814. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  815. # then doxygen will show the dependencies a directory has on other directories
  816. # in a graphical way. The dependency relations are determined by the #include
  817. # relations between the files in the directories.
  818. DIRECTORY_GRAPH = YES
  819. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  820. # generated by dot. Possible values are png, jpg, or gif
  821. # If left blank png will be used.
  822. DOT_IMAGE_FORMAT = png
  823. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  824. # found. If left blank, it is assumed the dot tool can be found in the path.
  825. DOT_PATH =
  826. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  827. # contain dot files that are included in the documentation (see the
  828. # \dotfile command).
  829. DOTFILE_DIRS =
  830. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  831. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  832. # this value, doxygen will try to truncate the graph, so that it fits within
  833. # the specified constraint. Beware that most browsers cannot cope with very
  834. # large images.
  835. MAX_DOT_GRAPH_WIDTH = 1024
  836. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  837. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  838. # this value, doxygen will try to truncate the graph, so that it fits within
  839. # the specified constraint. Beware that most browsers cannot cope with very
  840. # large images.
  841. MAX_DOT_GRAPH_HEIGHT = 1024
  842. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  843. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  844. # from the root by following a path via at most 3 edges will be shown. Nodes
  845. # that lay further from the root node will be omitted. Note that setting this
  846. # option to 1 or 2 may greatly reduce the computation time needed for large
  847. # code bases. Also note that a graph may be further truncated if the graph's
  848. # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
  849. # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
  850. # the graph is not depth-constrained.
  851. MAX_DOT_GRAPH_DEPTH = 0
  852. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  853. # background. This is disabled by default, which results in a white background.
  854. # Warning: Depending on the platform used, enabling this option may lead to
  855. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  856. # read).
  857. DOT_TRANSPARENT = NO
  858. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  859. # files in one run (i.e. multiple -o and -T options on the command line). This
  860. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  861. # support this, this feature is disabled by default.
  862. DOT_MULTI_TARGETS = NO
  863. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  864. # generate a legend page explaining the meaning of the various boxes and
  865. # arrows in the dot generated graphs.
  866. GENERATE_LEGEND = YES
  867. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  868. # remove the intermediate dot files that are used to generate
  869. # the various graphs.
  870. DOT_CLEANUP = YES
  871. #---------------------------------------------------------------------------
  872. # Configuration::additions related to the search engine
  873. #---------------------------------------------------------------------------
  874. # The SEARCHENGINE tag specifies whether or not a search engine should be
  875. # used. If set to NO the values of all tags below this one will be ignored.
  876. SEARCHENGINE = NO