Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

doxygen.cfg.in 54 KiB

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