doxygen.cfg.in 49 KB

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