Doxyfile 51 KB

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