You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doxyfile 50KB

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