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.

doxygen.cfg 50KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245
  1. # Doxyfile 1.4.4
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for a project
  4. #
  5. # All text after a hash (#) is considered a comment and will be ignored
  6. # The format is:
  7. # TAG = value [value, ...]
  8. # For lists items can also be appended using:
  9. # TAG += value [value, ...]
  10. # Values that contain spaces should be placed between quotes (" ")
  11. #---------------------------------------------------------------------------
  12. # Project related configuration options
  13. #---------------------------------------------------------------------------
  14. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  15. # by quotes) that should identify the project.
  16. PROJECT_NAME = Etherboot
  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 =
  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 = @BIN@/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. # 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 = YES
  119. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  120. # member inherits the documentation from any documented member that it
  121. # re-implements.
  122. INHERIT_DOCS = YES
  123. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  124. # tag is set to YES, then doxygen will reuse the documentation of the first
  125. # member in the group (if any) for the other members of the group. By default
  126. # all members of a group must be documented explicitly.
  127. DISTRIBUTE_GROUP_DOC = NO
  128. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  129. # a new page for each member. If set to NO, the documentation of a member will
  130. # be part of the file/class/namespace that contains it.
  131. SEPARATE_MEMBER_PAGES = NO
  132. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  133. # Doxygen uses this value to replace tabs by spaces in code fragments.
  134. TAB_SIZE = 8
  135. # This tag can be used to specify a number of aliases that acts
  136. # as commands in the documentation. An alias has the form "name=value".
  137. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  138. # put the command \sideeffect (or @sideeffect) in the documentation, which
  139. # will result in a user-defined paragraph with heading "Side Effects:".
  140. # You can put \n's in the value part of an alias to insert newlines.
  141. ALIASES = v=@param \
  142. ret=@retval \
  143. err=@exception
  144. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  145. # sources only. Doxygen will then generate output that is more tailored for C.
  146. # For instance, some of the names that are used will be different. The list
  147. # of all members will be omitted, etc.
  148. OPTIMIZE_OUTPUT_FOR_C = YES
  149. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
  150. # only. Doxygen will then generate output that is more tailored for Java.
  151. # For instance, namespaces will be presented as packages, qualified scopes
  152. # will look different, etc.
  153. OPTIMIZE_OUTPUT_JAVA = 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 = NO
  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 = YES
  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 = NO
  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 YES.
  278. SHOW_DIRECTORIES = YES
  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 progam 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 = NO
  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 =
  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 = @SRCDIRS@ \
  331. include \
  332. include/gpxe \
  333. arch/@ARCH@/include \
  334. doc
  335. # If the value of the INPUT tag contains directories, you can use the
  336. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  337. # and *.h) to filter out the source-files in the directories. If left
  338. # blank the following patterns are tested:
  339. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  340. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
  341. FILE_PATTERNS = *.c \
  342. *.h \
  343. *.S \
  344. *.dox
  345. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  346. # should be searched for input files as well. Possible values are YES and NO.
  347. # If left blank NO is used.
  348. RECURSIVE = NO
  349. # The EXCLUDE tag can be used to specify files and/or directories that should
  350. # excluded from the INPUT source files. This way you can easily exclude a
  351. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  352. EXCLUDE =
  353. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  354. # directories that are symbolic links (a Unix filesystem feature) are excluded
  355. # from the input.
  356. EXCLUDE_SYMLINKS = NO
  357. # If the value of the INPUT tag contains directories, you can use the
  358. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  359. # certain files from those directories. Note that the wildcards are matched
  360. # against the file with absolute path, so to exclude all test directories
  361. # for example use the pattern */test/*
  362. EXCLUDE_PATTERNS =
  363. # The EXAMPLE_PATH tag can be used to specify one or more files or
  364. # directories that contain example code fragments that are included (see
  365. # the \include command).
  366. EXAMPLE_PATH =
  367. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  368. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  369. # and *.h) to filter out the source-files in the directories. If left
  370. # blank all files are included.
  371. EXAMPLE_PATTERNS =
  372. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  373. # searched for input files to be used with the \include or \dontinclude
  374. # commands irrespective of the value of the RECURSIVE tag.
  375. # Possible values are YES and NO. If left blank NO is used.
  376. EXAMPLE_RECURSIVE = NO
  377. # The IMAGE_PATH tag can be used to specify one or more files or
  378. # directories that contain image that are included in the documentation (see
  379. # the \image command).
  380. IMAGE_PATH =
  381. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  382. # invoke to filter for each input file. Doxygen will invoke the filter program
  383. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  384. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  385. # input file. Doxygen will then use the output that the filter program writes
  386. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  387. # ignored.
  388. INPUT_FILTER =
  389. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  390. # basis. Doxygen will compare the file name with each pattern and apply the
  391. # filter if there is a match. The filters are a list of the form:
  392. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  393. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  394. # is applied to all files.
  395. FILTER_PATTERNS =
  396. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  397. # INPUT_FILTER) will be used to filter the input files when producing source
  398. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  399. FILTER_SOURCE_FILES = YES
  400. #---------------------------------------------------------------------------
  401. # configuration options related to source browsing
  402. #---------------------------------------------------------------------------
  403. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  404. # be generated. Documented entities will be cross-referenced with these sources.
  405. # Note: To get rid of all source code in the generated output, make sure also
  406. # VERBATIM_HEADERS is set to NO.
  407. SOURCE_BROWSER = YES
  408. # Setting the INLINE_SOURCES tag to YES will include the body
  409. # of functions and classes directly in the documentation.
  410. INLINE_SOURCES = NO
  411. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  412. # doxygen to hide any special comment blocks from generated source code
  413. # fragments. Normal C and C++ comments will always remain visible.
  414. STRIP_CODE_COMMENTS = NO
  415. # If the REFERENCED_BY_RELATION tag is set to YES (the default)
  416. # then for each documented function all documented
  417. # functions referencing it will be listed.
  418. REFERENCED_BY_RELATION = YES
  419. # If the REFERENCES_RELATION tag is set to YES (the default)
  420. # then for each documented function all documented entities
  421. # called/used by that function will be listed.
  422. REFERENCES_RELATION = NO
  423. # If the USE_HTAGS tag is set to YES then the references to source code
  424. # will point to the HTML generated by the htags(1) tool instead of doxygen
  425. # built-in source browser. The htags tool is part of GNU's global source
  426. # tagging system (see http://www.gnu.org/software/global/global.html). You
  427. # will need version 4.8.6 or higher.
  428. USE_HTAGS = NO
  429. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  430. # will generate a verbatim copy of the header file for each class for
  431. # which an include is specified. Set to NO to disable this.
  432. VERBATIM_HEADERS = YES
  433. #---------------------------------------------------------------------------
  434. # configuration options related to the alphabetical class index
  435. #---------------------------------------------------------------------------
  436. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  437. # of all compounds will be generated. Enable this if the project
  438. # contains a lot of classes, structs, unions or interfaces.
  439. ALPHABETICAL_INDEX = YES
  440. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  441. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  442. # in which this list will be split (can be a number in the range [1..20])
  443. COLS_IN_ALPHA_INDEX = 5
  444. # In case all classes in a project start with a common prefix, all
  445. # classes will be put under the same header in the alphabetical index.
  446. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  447. # should be ignored while generating the index headers.
  448. IGNORE_PREFIX =
  449. #---------------------------------------------------------------------------
  450. # configuration options related to the HTML output
  451. #---------------------------------------------------------------------------
  452. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  453. # generate HTML output.
  454. GENERATE_HTML = YES
  455. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  456. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  457. # put in front of it. If left blank `html' will be used as the default path.
  458. HTML_OUTPUT =
  459. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  460. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  461. # doxygen will generate files with .html extension.
  462. HTML_FILE_EXTENSION =
  463. # The HTML_HEADER tag can be used to specify a personal HTML header for
  464. # each generated HTML page. If it is left blank doxygen will generate a
  465. # standard header.
  466. HTML_HEADER =
  467. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  468. # each generated HTML page. If it is left blank doxygen will generate a
  469. # standard footer.
  470. HTML_FOOTER =
  471. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  472. # style sheet that is used by each HTML page. It can be used to
  473. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  474. # will generate a default style sheet. Note that doxygen will try to copy
  475. # the style sheet file to the HTML output directory, so don't put your own
  476. # stylesheet in the HTML output directory as well, or it will be erased!
  477. HTML_STYLESHEET =
  478. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  479. # files or namespaces will be aligned in HTML using tables. If set to
  480. # NO a bullet list will be used.
  481. HTML_ALIGN_MEMBERS = YES
  482. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  483. # will be generated that can be used as input for tools like the
  484. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  485. # of the generated HTML documentation.
  486. GENERATE_HTMLHELP = NO
  487. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  488. # be used to specify the file name of the resulting .chm file. You
  489. # can add a path in front of the file if the result should not be
  490. # written to the html output directory.
  491. CHM_FILE =
  492. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  493. # be used to specify the location (absolute path including file name) of
  494. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  495. # the HTML help compiler on the generated index.hhp.
  496. HHC_LOCATION =
  497. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  498. # controls if a separate .chi index file is generated (YES) or that
  499. # it should be included in the master .chm file (NO).
  500. GENERATE_CHI = NO
  501. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  502. # controls whether a binary table of contents is generated (YES) or a
  503. # normal table of contents (NO) in the .chm file.
  504. BINARY_TOC = NO
  505. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  506. # to the contents of the HTML help documentation and to the tree view.
  507. TOC_EXPAND = NO
  508. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  509. # top of each HTML page. The value NO (the default) enables the index and
  510. # the value YES disables it.
  511. DISABLE_INDEX = NO
  512. # This tag can be used to set the number of enum values (range [1..20])
  513. # that doxygen will group on one line in the generated HTML documentation.
  514. ENUM_VALUES_PER_LINE = 4
  515. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  516. # generated containing a tree-like index structure (just like the one that
  517. # is generated for HTML Help). For this to work a browser that supports
  518. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
  519. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  520. # probably better off using the HTML help feature.
  521. GENERATE_TREEVIEW = NO
  522. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  523. # used to set the initial width (in pixels) of the frame in which the tree
  524. # is shown.
  525. TREEVIEW_WIDTH = 250
  526. #---------------------------------------------------------------------------
  527. # configuration options related to the LaTeX output
  528. #---------------------------------------------------------------------------
  529. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  530. # generate Latex output.
  531. GENERATE_LATEX = YES
  532. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  533. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  534. # put in front of it. If left blank `latex' will be used as the default path.
  535. LATEX_OUTPUT =
  536. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  537. # invoked. If left blank `latex' will be used as the default command name.
  538. LATEX_CMD_NAME = latex
  539. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  540. # generate index for LaTeX. If left blank `makeindex' will be used as the
  541. # default command name.
  542. MAKEINDEX_CMD_NAME = makeindex
  543. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  544. # LaTeX documents. This may be useful for small projects and may help to
  545. # save some trees in general.
  546. COMPACT_LATEX = YES
  547. # The PAPER_TYPE tag can be used to set the paper type that is used
  548. # by the printer. Possible values are: a4, a4wide, letter, legal and
  549. # executive. If left blank a4wide will be used.
  550. PAPER_TYPE = a4wide
  551. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  552. # packages that should be included in the LaTeX output.
  553. EXTRA_PACKAGES =
  554. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  555. # the generated latex document. The header should contain everything until
  556. # the first chapter. If it is left blank doxygen will generate a
  557. # standard header. Notice: only use this tag if you know what you are doing!
  558. LATEX_HEADER =
  559. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  560. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  561. # contain links (just like the HTML output) instead of page references
  562. # This makes the output suitable for online browsing using a pdf viewer.
  563. PDF_HYPERLINKS = NO
  564. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  565. # plain latex in the generated Makefile. Set this option to YES to get a
  566. # higher quality PDF documentation.
  567. USE_PDFLATEX = NO
  568. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  569. # command to the generated LaTeX files. This will instruct LaTeX to keep
  570. # running if errors occur, instead of asking the user for help.
  571. # This option is also used when generating formulas in HTML.
  572. LATEX_BATCHMODE = YES
  573. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  574. # include the index chapters (such as File Index, Compound Index, etc.)
  575. # in the output.
  576. LATEX_HIDE_INDICES = NO
  577. #---------------------------------------------------------------------------
  578. # configuration options related to the RTF output
  579. #---------------------------------------------------------------------------
  580. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  581. # The RTF output is optimized for Word 97 and may not look very pretty with
  582. # other RTF readers or editors.
  583. GENERATE_RTF = NO
  584. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  585. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  586. # put in front of it. If left blank `rtf' will be used as the default path.
  587. RTF_OUTPUT =
  588. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  589. # RTF documents. This may be useful for small projects and may help to
  590. # save some trees in general.
  591. COMPACT_RTF = NO
  592. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  593. # will contain hyperlink fields. The RTF file will
  594. # contain links (just like the HTML output) instead of page references.
  595. # This makes the output suitable for online browsing using WORD or other
  596. # programs which support those fields.
  597. # Note: wordpad (write) and others do not support links.
  598. RTF_HYPERLINKS = NO
  599. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  600. # config file, i.e. a series of assignments. You only have to provide
  601. # replacements, missing definitions are set to their default value.
  602. RTF_STYLESHEET_FILE =
  603. # Set optional variables used in the generation of an rtf document.
  604. # Syntax is similar to doxygen's config file.
  605. RTF_EXTENSIONS_FILE =
  606. #---------------------------------------------------------------------------
  607. # configuration options related to the man page output
  608. #---------------------------------------------------------------------------
  609. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  610. # generate man pages
  611. GENERATE_MAN = YES
  612. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  613. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  614. # put in front of it. If left blank `man' will be used as the default path.
  615. MAN_OUTPUT =
  616. # The MAN_EXTENSION tag determines the extension that is added to
  617. # the generated man pages (default is the subroutine's section .3)
  618. MAN_EXTENSION =
  619. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  620. # then it will generate one additional man file for each entity
  621. # documented in the real man page(s). These additional files
  622. # only source the real man page, but without them the man command
  623. # would be unable to find the correct page. The default is NO.
  624. MAN_LINKS = YES
  625. #---------------------------------------------------------------------------
  626. # configuration options related to the XML output
  627. #---------------------------------------------------------------------------
  628. # If the GENERATE_XML tag is set to YES Doxygen will
  629. # generate an XML file that captures the structure of
  630. # the code including all documentation.
  631. GENERATE_XML = NO
  632. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  633. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  634. # put in front of it. If left blank `xml' will be used as the default path.
  635. XML_OUTPUT = xml
  636. # The XML_SCHEMA tag can be used to specify an XML schema,
  637. # which can be used by a validating XML parser to check the
  638. # syntax of the XML files.
  639. XML_SCHEMA =
  640. # The XML_DTD tag can be used to specify an XML DTD,
  641. # which can be used by a validating XML parser to check the
  642. # syntax of the XML files.
  643. XML_DTD =
  644. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  645. # dump the program listings (including syntax highlighting
  646. # and cross-referencing information) to the XML output. Note that
  647. # enabling this will significantly increase the size of the XML output.
  648. XML_PROGRAMLISTING = YES
  649. #---------------------------------------------------------------------------
  650. # configuration options for the AutoGen Definitions output
  651. #---------------------------------------------------------------------------
  652. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  653. # generate an AutoGen Definitions (see autogen.sf.net) file
  654. # that captures the structure of the code including all
  655. # documentation. Note that this feature is still experimental
  656. # and incomplete at the moment.
  657. GENERATE_AUTOGEN_DEF = NO
  658. #---------------------------------------------------------------------------
  659. # configuration options related to the Perl module output
  660. #---------------------------------------------------------------------------
  661. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  662. # generate a Perl module file that captures the structure of
  663. # the code including all documentation. Note that this
  664. # feature is still experimental and incomplete at the
  665. # moment.
  666. GENERATE_PERLMOD = NO
  667. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  668. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  669. # to generate PDF and DVI output from the Perl module output.
  670. PERLMOD_LATEX = NO
  671. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  672. # nicely formatted so it can be parsed by a human reader. This is useful
  673. # if you want to understand what is going on. On the other hand, if this
  674. # tag is set to NO the size of the Perl module output will be much smaller
  675. # and Perl will parse it just the same.
  676. PERLMOD_PRETTY = YES
  677. # The names of the make variables in the generated doxyrules.make file
  678. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  679. # This is useful so different doxyrules.make files included by the same
  680. # Makefile don't overwrite each other's variables.
  681. PERLMOD_MAKEVAR_PREFIX =
  682. #---------------------------------------------------------------------------
  683. # Configuration options related to the preprocessor
  684. #---------------------------------------------------------------------------
  685. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  686. # evaluate all C-preprocessor directives found in the sources and include
  687. # files.
  688. ENABLE_PREPROCESSING = YES
  689. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  690. # names in the source code. If set to NO (the default) only conditional
  691. # compilation will be performed. Macro expansion can be done in a controlled
  692. # way by setting EXPAND_ONLY_PREDEF to YES.
  693. MACRO_EXPANSION = YES
  694. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  695. # then the macro expansion is limited to the macros specified with the
  696. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  697. EXPAND_ONLY_PREDEF = YES
  698. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  699. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  700. SEARCH_INCLUDES = YES
  701. # The INCLUDE_PATH tag can be used to specify one or more directories that
  702. # contain include files that are not input files but should be processed by
  703. # the preprocessor.
  704. INCLUDE_PATH = include \
  705. arch/@ARCH@/include
  706. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  707. # patterns (like *.h and *.hpp) to filter out the header-files in the
  708. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  709. # be used.
  710. INCLUDE_FILE_PATTERNS =
  711. # The PREDEFINED tag can be used to specify one or more macro names that
  712. # are defined before the preprocessor is started (similar to the -D option of
  713. # gcc). The argument of the tag is a list of macros of the form: name
  714. # or name=definition (no spaces). If the definition and the = are
  715. # omitted =1 is assumed. To prevent a macro definition from being
  716. # undefined via #undef or recursively expanded use the := operator
  717. # instead of the = operator.
  718. PREDEFINED = DOXYGEN=1
  719. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  720. # this tag can be used to specify a list of macro names that should be expanded.
  721. # The macro definition that is found in the sources will be used.
  722. # Use the PREDEFINED tag if you want to use a different macro definition.
  723. EXPAND_AS_DEFINED = __attribute__ \
  724. PACKED \
  725. __unused \
  726. __used \
  727. __aligned \
  728. __table \
  729. __table_start \
  730. __table_end
  731. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  732. # doxygen's preprocessor will remove all function-like macros that are alone
  733. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  734. # function macros are typically used for boiler-plate code, and will confuse
  735. # the parser if not removed.
  736. SKIP_FUNCTION_MACROS = YES
  737. #---------------------------------------------------------------------------
  738. # Configuration::additions related to external references
  739. #---------------------------------------------------------------------------
  740. # The TAGFILES option can be used to specify one or more tagfiles.
  741. # Optionally an initial location of the external documentation
  742. # can be added for each tagfile. The format of a tag file without
  743. # this location is as follows:
  744. # TAGFILES = file1 file2 ...
  745. # Adding location for the tag files is done as follows:
  746. # TAGFILES = file1=loc1 "file2 = loc2" ...
  747. # where "loc1" and "loc2" can be relative or absolute paths or
  748. # URLs. If a location is present for each tag, the installdox tool
  749. # does not have to be run to correct the links.
  750. # Note that each tag file must have a unique name
  751. # (where the name does NOT include the path)
  752. # If a tag file is not located in the directory in which doxygen
  753. # is run, you must also specify the path to the tagfile here.
  754. TAGFILES =
  755. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  756. # a tag file that is based on the input files it reads.
  757. GENERATE_TAGFILE =
  758. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  759. # in the class index. If set to NO only the inherited external classes
  760. # will be listed.
  761. ALLEXTERNALS = NO
  762. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  763. # in the modules index. If set to NO, only the current project's groups will
  764. # be listed.
  765. EXTERNAL_GROUPS = YES
  766. # The PERL_PATH should be the absolute path and name of the perl script
  767. # interpreter (i.e. the result of `which perl').
  768. PERL_PATH =
  769. #---------------------------------------------------------------------------
  770. # Configuration options related to the dot tool
  771. #---------------------------------------------------------------------------
  772. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  773. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  774. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  775. # this option is superseded by the HAVE_DOT option below. This is only a
  776. # fallback. It is recommended to install and use dot, since it yields more
  777. # powerful graphs.
  778. CLASS_DIAGRAMS = YES
  779. # If set to YES, the inheritance and collaboration graphs will hide
  780. # inheritance and usage relations if the target is undocumented
  781. # or is not a class.
  782. HIDE_UNDOC_RELATIONS = YES
  783. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  784. # available from the path. This tool is part of Graphviz, a graph visualization
  785. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  786. # have no effect if this option is set to NO (the default)
  787. HAVE_DOT = NO
  788. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  789. # will generate a graph for each documented class showing the direct and
  790. # indirect inheritance relations. Setting this tag to YES will force the
  791. # the CLASS_DIAGRAMS tag to NO.
  792. CLASS_GRAPH = YES
  793. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  794. # will generate a graph for each documented class showing the direct and
  795. # indirect implementation dependencies (inheritance, containment, and
  796. # class references variables) of the class with other documented classes.
  797. COLLABORATION_GRAPH = YES
  798. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  799. # will generate a graph for groups, showing the direct groups dependencies
  800. GROUP_GRAPHS = YES
  801. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  802. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  803. # Language.
  804. UML_LOOK = NO
  805. # If set to YES, the inheritance and collaboration graphs will show the
  806. # relations between templates and their instances.
  807. TEMPLATE_RELATIONS = YES
  808. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  809. # tags are set to YES then doxygen will generate a graph for each documented
  810. # file showing the direct and indirect include dependencies of the file with
  811. # other documented files.
  812. INCLUDE_GRAPH = YES
  813. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  814. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  815. # documented header file showing the documented files that directly or
  816. # indirectly include this file.
  817. INCLUDED_BY_GRAPH = YES
  818. # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
  819. # generate a call dependency graph for every global function or class method.
  820. # Note that enabling this option will significantly increase the time of a run.
  821. # So in most cases it will be better to enable call graphs for selected
  822. # functions only using the \callgraph command.
  823. CALL_GRAPH = NO
  824. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  825. # will graphical hierarchy of all classes instead of a textual one.
  826. GRAPHICAL_HIERARCHY = YES
  827. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  828. # then doxygen will show the dependencies a directory has on other directories
  829. # in a graphical way. The dependency relations are determined by the #include
  830. # relations between the files in the directories.
  831. DIRECTORY_GRAPH = YES
  832. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  833. # generated by dot. Possible values are png, jpg, or gif
  834. # If left blank png will be used.
  835. DOT_IMAGE_FORMAT = png
  836. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  837. # found. If left blank, it is assumed the dot tool can be found in the path.
  838. DOT_PATH =
  839. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  840. # contain dot files that are included in the documentation (see the
  841. # \dotfile command).
  842. DOTFILE_DIRS =
  843. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  844. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  845. # this value, doxygen will try to truncate the graph, so that it fits within
  846. # the specified constraint. Beware that most browsers cannot cope with very
  847. # large images.
  848. MAX_DOT_GRAPH_WIDTH = 1024
  849. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  850. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  851. # this value, doxygen will try to truncate the graph, so that it fits within
  852. # the specified constraint. Beware that most browsers cannot cope with very
  853. # large images.
  854. MAX_DOT_GRAPH_HEIGHT = 1024
  855. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  856. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  857. # from the root by following a path via at most 3 edges will be shown. Nodes
  858. # that lay further from the root node will be omitted. Note that setting this
  859. # option to 1 or 2 may greatly reduce the computation time needed for large
  860. # code bases. Also note that a graph may be further truncated if the graph's
  861. # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
  862. # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
  863. # the graph is not depth-constrained.
  864. MAX_DOT_GRAPH_DEPTH = 0
  865. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  866. # background. This is disabled by default, which results in a white background.
  867. # Warning: Depending on the platform used, enabling this option may lead to
  868. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  869. # read).
  870. DOT_TRANSPARENT = NO
  871. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  872. # files in one run (i.e. multiple -o and -T options on the command line). This
  873. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  874. # support this, this feature is disabled by default.
  875. DOT_MULTI_TARGETS = NO
  876. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  877. # generate a legend page explaining the meaning of the various boxes and
  878. # arrows in the dot generated graphs.
  879. GENERATE_LEGEND = YES
  880. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  881. # remove the intermediate dot files that are used to generate
  882. # the various graphs.
  883. DOT_CLEANUP = YES
  884. #---------------------------------------------------------------------------
  885. # Configuration::additions related to the search engine
  886. #---------------------------------------------------------------------------
  887. # The SEARCHENGINE tag specifies whether or not a search engine should be
  888. # used. If set to NO the values of all tags below this one will be ignored.
  889. SEARCHENGINE = NO