Doxyfile 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753
  1. # Doxyfile 1.2.5
  2. # This file describes the settings to be used by doxygen for a project
  3. #
  4. # All text after a hash (#) is considered a comment and will be ignored
  5. # The format is:
  6. # TAG = value [value, ...]
  7. # For lists items can also be appended using:
  8. # TAG += value [value, ...]
  9. # Values that contain spaces should be placed between quotes (" ")
  10. #---------------------------------------------------------------------------
  11. # General configuration options
  12. #---------------------------------------------------------------------------
  13. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  14. # by quotes) that should identify the project.
  15. PROJECT_NAME = "NASM - the Netwide Assembler"
  16. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  17. # This could be handy for archiving the generated documentation or
  18. # if some version control system is used.
  19. PROJECT_NUMBER = 0.98
  20. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  21. # base path where the generated documentation will be put.
  22. # If a relative path is entered, it will be relative to the location
  23. # where doxygen was started. If left blank the current directory will be used.
  24. OUTPUT_DIRECTORY = doxy
  25. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  26. # documentation generated by doxygen is written. Doxygen will use this
  27. # information to generate all constant output in the proper language.
  28. # The default language is English, other supported languages are:
  29. # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
  30. # Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian,
  31. # Polish, Portuguese and Slovene.
  32. OUTPUT_LANGUAGE = English
  33. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  34. # documentation are documented, even if no documentation was available.
  35. # Private class members and static file members will be hidden unless
  36. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  37. EXTRACT_ALL = YES
  38. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  39. # will be included in the documentation.
  40. EXTRACT_PRIVATE = NO
  41. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  42. # will be included in the documentation.
  43. EXTRACT_STATIC = YES
  44. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  45. # undocumented members of documented classes, files or namespaces.
  46. # If set to NO (the default) these members will be included in the
  47. # various overviews, but no documentation section is generated.
  48. # This option has no effect if EXTRACT_ALL is enabled.
  49. HIDE_UNDOC_MEMBERS = NO
  50. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  51. # undocumented classes that are normally visible in the class hierarchy.
  52. # If set to NO (the default) these class will be included in the various
  53. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  54. HIDE_UNDOC_CLASSES = NO
  55. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  56. # include brief member descriptions after the members that are listed in
  57. # the file and class documentation (similar to JavaDoc).
  58. # Set to NO to disable this.
  59. BRIEF_MEMBER_DESC = YES
  60. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  61. # the brief description of a member or function before the detailed description.
  62. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  63. # brief descriptions will be completely suppressed.
  64. REPEAT_BRIEF = YES
  65. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  66. # Doxygen will generate a detailed section even if there is only a brief
  67. # description.
  68. ALWAYS_DETAILED_SEC = NO
  69. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  70. # path before files name in the file list and in the header files. If set
  71. # to NO the shortest path that makes the file name unique will be used.
  72. FULL_PATH_NAMES = NO
  73. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  74. # can be used to strip a user defined part of the path. Stripping is
  75. # only done if one of the specified strings matches the left-hand part of
  76. # the path. It is allowed to use relative paths in the argument list.
  77. STRIP_FROM_PATH =
  78. # The INTERNAL_DOCS tag determines if documentation
  79. # that is typed after a \internal command is included. If the tag is set
  80. # to NO (the default) then the documentation will be excluded.
  81. # Set it to YES to include the internal documentation.
  82. INTERNAL_DOCS = NO
  83. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  84. # generate a class diagram (in Html and LaTeX) for classes with base or
  85. # super classes. Setting the tag to NO turns the diagrams off.
  86. CLASS_DIAGRAMS = YES
  87. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  88. # be generated. Documented entities will be cross-referenced with these sources.
  89. SOURCE_BROWSER = YES
  90. # Setting the INLINE_SOURCES tag to YES will include the body
  91. # of functions and classes directly in the documentation.
  92. INLINE_SOURCES = NO
  93. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  94. # doxygen to hide any special comment blocks from generated source code
  95. # fragments. Normal C and C++ comments will always remain visible.
  96. STRIP_CODE_COMMENTS = YES
  97. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  98. # file names in lower case letters. If set to YES upper case letters are also
  99. # allowed. This is useful if you have classes or files whose names only differ
  100. # in case and if your file system supports case sensitive file names. Windows
  101. # users are adviced to set this option to NO.
  102. CASE_SENSE_NAMES = YES
  103. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  104. # will show members with their full class and namespace scopes in the
  105. # documentation. If set to YES the scope will be hidden.
  106. HIDE_SCOPE_NAMES = NO
  107. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  108. # will generate a verbatim copy of the header file for each class for
  109. # which an include is specified. Set to NO to disable this.
  110. VERBATIM_HEADERS = YES
  111. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  112. # will put list of the files that are included by a file in the documentation
  113. # of that file.
  114. SHOW_INCLUDE_FILES = YES
  115. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  116. # will interpret the first line (until the first dot) of a JavaDoc-style
  117. # comment as the brief description. If set to NO, the JavaDoc
  118. # comments will behave just like the Qt-style comments (thus requiring an
  119. # explict @brief command for a brief description.
  120. JAVADOC_AUTOBRIEF = NO
  121. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  122. # member inherits the documentation from any documented member that it
  123. # reimplements.
  124. INHERIT_DOCS = YES
  125. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  126. # is inserted in the documentation for inline members.
  127. INLINE_INFO = YES
  128. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  129. # will sort the (detailed) documentation of file and class members
  130. # alphabetically by member name. If set to NO the members will appear in
  131. # declaration order.
  132. SORT_MEMBER_DOCS = YES
  133. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  134. # tag is set to YES, then doxygen will reuse the documentation of the first
  135. # member in the group (if any) for the other members of the group. By default
  136. # all members of a group must be documented explicitly.
  137. DISTRIBUTE_GROUP_DOC = NO
  138. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  139. # Doxygen uses this value to replace tabs by spaces in code fragments.
  140. TAB_SIZE = 4
  141. # The ENABLE_SECTIONS tag can be used to enable conditional
  142. # documentation sections, marked by \if sectionname ... \endif.
  143. ENABLED_SECTIONS =
  144. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  145. # disable (NO) the todo list. This list is created by putting \todo
  146. # commands in the documentation.
  147. GENERATE_TODOLIST = YES
  148. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  149. # disable (NO) the test list. This list is created by putting \test
  150. # commands in the documentation.
  151. GENERATE_TESTLIST = YES
  152. # This tag can be used to specify a number of aliases that acts
  153. # as commands in the documentation. An alias has the form "name=value".
  154. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  155. # put the command \sideeffect (or @sideeffect) in the documentation, which
  156. # will result in a user defined paragraph with heading "Side Effects:".
  157. # You can put \n's in the value part of an alias to insert newlines.
  158. ALIASES =
  159. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  160. # the initial value of a variable or define consist of for it to appear in
  161. # the documentation. If the initializer consists of more lines than specified
  162. # here it will be hidden. Use a value of 0 to hide initializers completely.
  163. # The appearance of the initializer of individual variables and defines in the
  164. # documentation can be controlled using \showinitializer or \hideinitializer
  165. # command in the documentation regardless of this setting.
  166. MAX_INITIALIZER_LINES = 30
  167. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  168. # only. Doxygen will then generate output that is more tailored for C.
  169. # For instance some of the names that are used will be different. The list
  170. # of all members will be omitted, etc.
  171. OPTIMIZE_OUTPUT_FOR_C = NO
  172. #---------------------------------------------------------------------------
  173. # configuration options related to warning and progress messages
  174. #---------------------------------------------------------------------------
  175. # The QUIET tag can be used to turn on/off the messages that are generated
  176. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  177. QUIET = NO
  178. # The WARNINGS tag can be used to turn on/off the warning messages that are
  179. # generated by doxygen. Possible values are YES and NO. If left blank
  180. # NO is used.
  181. WARNINGS = YES
  182. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  183. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  184. # automatically be disabled.
  185. WARN_IF_UNDOCUMENTED = YES
  186. # The WARN_FORMAT tag determines the format of the warning messages that
  187. # doxygen can produce. The string should contain the $file, $line, and $text
  188. # tags, which will be replaced by the file and line number from which the
  189. # warning originated and the warning text.
  190. WARN_FORMAT = "$file:$line: $text"
  191. # The WARN_LOGFILE tag can be used to specify a file to which warning
  192. # and error messages should be written. If left blank the output is written
  193. # to stderr.
  194. WARN_LOGFILE =
  195. #---------------------------------------------------------------------------
  196. # configuration options related to the input files
  197. #---------------------------------------------------------------------------
  198. # The INPUT tag can be used to specify the files and/or directories that contain
  199. # documented source files. You may enter file names like "myfile.cpp" or
  200. # directories like "/usr/src/myproject". Separate the files or directories
  201. # with spaces.
  202. INPUT = .
  203. # If the value of the INPUT tag contains directories, you can use the
  204. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  205. # and *.h) to filter out the source-files in the directories. If left
  206. # blank all files are included.
  207. FILE_PATTERNS = *.c *.h
  208. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  209. # should be searched for input files as well. Possible values are YES and NO.
  210. # If left blank NO is used.
  211. RECURSIVE = NO
  212. # The EXCLUDE tag can be used to specify files and/or directories that should
  213. # excluded from the INPUT source files. This way you can easily exclude a
  214. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  215. EXCLUDE =
  216. # If the value of the INPUT tag contains directories, you can use the
  217. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  218. # certain files from those directories.
  219. EXCLUDE_PATTERNS =
  220. # The EXAMPLE_PATH tag can be used to specify one or more files or
  221. # directories that contain example code fragments that are included (see
  222. # the \include command).
  223. EXAMPLE_PATH =
  224. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  225. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  226. # and *.h) to filter out the source-files in the directories. If left
  227. # blank all files are included.
  228. EXAMPLE_PATTERNS =
  229. # The IMAGE_PATH tag can be used to specify one or more files or
  230. # directories that contain image that are included in the documentation (see
  231. # the \image command).
  232. IMAGE_PATH =
  233. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  234. # invoke to filter for each input file. Doxygen will invoke the filter program
  235. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  236. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  237. # input file. Doxygen will then use the output that the filter program writes
  238. # to standard output.
  239. INPUT_FILTER =
  240. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  241. # INPUT_FILTER) will be used to filter the input files when producing source
  242. # files to browse.
  243. FILTER_SOURCE_FILES = NO
  244. #---------------------------------------------------------------------------
  245. # configuration options related to the alphabetical class index
  246. #---------------------------------------------------------------------------
  247. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  248. # of all compounds will be generated. Enable this if the project
  249. # contains a lot of classes, structs, unions or interfaces.
  250. ALPHABETICAL_INDEX = NO
  251. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  252. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  253. # in which this list will be split (can be a number in the range [1..20])
  254. COLS_IN_ALPHA_INDEX = 5
  255. # In case all classes in a project start with a common prefix, all
  256. # classes will be put under the same header in the alphabetical index.
  257. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  258. # should be ignored while generating the index headers.
  259. IGNORE_PREFIX =
  260. #---------------------------------------------------------------------------
  261. # configuration options related to the HTML output
  262. #---------------------------------------------------------------------------
  263. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  264. # generate HTML output.
  265. GENERATE_HTML = YES
  266. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  267. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  268. # put in front of it. If left blank `html' will be used as the default path.
  269. HTML_OUTPUT = html
  270. # The HTML_HEADER tag can be used to specify a personal HTML header for
  271. # each generated HTML page. If it is left blank doxygen will generate a
  272. # standard header.
  273. HTML_HEADER =
  274. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  275. # each generated HTML page. If it is left blank doxygen will generate a
  276. # standard footer.
  277. HTML_FOOTER =
  278. # The HTML_STYLESHEET tag can be used to specify a user defined cascading
  279. # style sheet that is used by each HTML page. It can be used to
  280. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  281. # will generate a default style sheet
  282. HTML_STYLESHEET =
  283. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  284. # files or namespaces will be aligned in HTML using tables. If set to
  285. # NO a bullet list will be used.
  286. HTML_ALIGN_MEMBERS = YES
  287. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  288. # will be generated that can be used as input for tools like the
  289. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  290. # of the generated HTML documentation.
  291. GENERATE_HTMLHELP = NO
  292. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  293. # top of each HTML page. The value NO (the default) enables the index and
  294. # the value YES disables it.
  295. DISABLE_INDEX = NO
  296. # This tag can be used to set the number of enum values (range [1..20])
  297. # that doxygen will group on one line in the generated HTML documentation.
  298. ENUM_VALUES_PER_LINE = 4
  299. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  300. # generated containing a tree-like index structure (just like the one that
  301. # is generated for HTML Help). For this to work a browser that supports
  302. # JavaScript and frames is required (for instance Netscape 4.0+
  303. # or Internet explorer 4.0+).
  304. GENERATE_TREEVIEW = YES
  305. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  306. # used to set the initial width (in pixels) of the frame in which the tree
  307. # is shown.
  308. TREEVIEW_WIDTH = 250
  309. #---------------------------------------------------------------------------
  310. # configuration options related to the LaTeX output
  311. #---------------------------------------------------------------------------
  312. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  313. # generate Latex output.
  314. GENERATE_LATEX = YES
  315. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  316. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  317. # put in front of it. If left blank `latex' will be used as the default path.
  318. LATEX_OUTPUT = latex
  319. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  320. # LaTeX documents. This may be useful for small projects and may help to
  321. # save some trees in general.
  322. COMPACT_LATEX = NO
  323. # The PAPER_TYPE tag can be used to set the paper type that is used
  324. # by the printer. Possible values are: a4, a4wide, letter, legal and
  325. # executive. If left blank a4wide will be used.
  326. PAPER_TYPE = a4wide
  327. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  328. # packages that should be included in the LaTeX output.
  329. EXTRA_PACKAGES =
  330. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  331. # the generated latex document. The header should contain everything until
  332. # the first chapter. If it is left blank doxygen will generate a
  333. # standard header. Notice: only use this tag if you know what you are doing!
  334. LATEX_HEADER =
  335. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  336. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  337. # contain links (just like the HTML output) instead of page references
  338. # This makes the output suitable for online browsing using a pdf viewer.
  339. PDF_HYPERLINKS = NO
  340. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  341. # plain latex in the generated Makefile. Set this option to YES to get a
  342. # higher quality PDF documentation.
  343. USE_PDFLATEX = NO
  344. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  345. # command to the generated LaTeX files. This will instruct LaTeX to keep
  346. # running if errors occur, instead of asking the user for help.
  347. # This option is also used when generating formulas in HTML.
  348. LATEX_BATCHMODE = NO
  349. #---------------------------------------------------------------------------
  350. # configuration options related to the RTF output
  351. #---------------------------------------------------------------------------
  352. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  353. # The RTF output is optimised for Word 97 and may not look very pretty with
  354. # other RTF readers or editors.
  355. GENERATE_RTF = YES
  356. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  357. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  358. # put in front of it. If left blank `rtf' will be used as the default path.
  359. RTF_OUTPUT = rtf
  360. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  361. # RTF documents. This may be useful for small projects and may help to
  362. # save some trees in general.
  363. COMPACT_RTF = NO
  364. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  365. # will contain hyperlink fields. The RTF file will
  366. # contain links (just like the HTML output) instead of page references.
  367. # This makes the output suitable for online browsing using a WORD or other.
  368. # programs which support those fields.
  369. # Note: wordpad (write) and others do not support links.
  370. RTF_HYPERLINKS = NO
  371. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  372. # config file, i.e. a series of assigments. You only have to provide
  373. # replacements, missing definitions are set to their default value.
  374. RTF_STYLESHEET_FILE =
  375. #---------------------------------------------------------------------------
  376. # configuration options related to the man page output
  377. #---------------------------------------------------------------------------
  378. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  379. # generate man pages
  380. GENERATE_MAN = YES
  381. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  382. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  383. # put in front of it. If left blank `man' will be used as the default path.
  384. MAN_OUTPUT = man
  385. # The MAN_EXTENSION tag determines the extension that is added to
  386. # the generated man pages (default is the subroutine's section .3)
  387. MAN_EXTENSION = .3
  388. #---------------------------------------------------------------------------
  389. # Configuration options related to the preprocessor
  390. #---------------------------------------------------------------------------
  391. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  392. # evaluate all C-preprocessor directives found in the sources and include
  393. # files.
  394. ENABLE_PREPROCESSING = YES
  395. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  396. # names in the source code. If set to NO (the default) only conditional
  397. # compilation will be performed. Macro expansion can be done in a controlled
  398. # way by setting EXPAND_ONLY_PREDEF to YES.
  399. MACRO_EXPANSION = NO
  400. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  401. # then the macro expansion is limited to the macros specified with the
  402. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  403. EXPAND_ONLY_PREDEF = NO
  404. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  405. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  406. SEARCH_INCLUDES = YES
  407. # The INCLUDE_PATH tag can be used to specify one or more directories that
  408. # contain include files that are not input files but should be processed by
  409. # the preprocessor.
  410. INCLUDE_PATH =
  411. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  412. # patterns (like *.h and *.hpp) to filter out the header-files in the
  413. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  414. # be used.
  415. INCLUDE_FILE_PATTERNS =
  416. # The PREDEFINED tag can be used to specify one or more macro names that
  417. # are defined before the preprocessor is started (similar to the -D option of
  418. # gcc). The argument of the tag is a list of macros of the form: name
  419. # or name=definition (no spaces). If the definition and the = are
  420. # omitted =1 is assumed.
  421. PREDEFINED =
  422. # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
  423. # this tag can be used to specify a list of macro names that should be expanded.
  424. # The macro definition that is found in the sources will be used.
  425. # Use the PREDEFINED tag if you want to use a different macro definition.
  426. EXPAND_AS_DEFINED =
  427. #---------------------------------------------------------------------------
  428. # Configuration::addtions related to external references
  429. #---------------------------------------------------------------------------
  430. # The TAGFILES tag can be used to specify one or more tagfiles.
  431. TAGFILES =
  432. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  433. # a tag file that is based on the input files it reads.
  434. GENERATE_TAGFILE =
  435. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  436. # in the class index. If set to NO only the inherited external classes
  437. # will be listed.
  438. ALLEXTERNALS = NO
  439. # The PERL_PATH should be the absolute path and name of the perl script
  440. # interpreter (i.e. the result of `which perl').
  441. PERL_PATH = /usr/bin/perl
  442. #---------------------------------------------------------------------------
  443. # Configuration options related to the dot tool
  444. #---------------------------------------------------------------------------
  445. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  446. # available from the path. This tool is part of Graphviz, a graph visualization
  447. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  448. # have no effect if this option is set to NO (the default)
  449. HAVE_DOT = NO
  450. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  451. # will generate a graph for each documented class showing the direct and
  452. # indirect inheritance relations. Setting this tag to YES will force the
  453. # the CLASS_DIAGRAMS tag to NO.
  454. CLASS_GRAPH = YES
  455. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  456. # will generate a graph for each documented class showing the direct and
  457. # indirect implementation dependencies (inheritance, containment, and
  458. # class references variables) of the class with other documented classes.
  459. COLLABORATION_GRAPH = YES
  460. # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
  461. # YES then doxygen will generate a graph for each documented file showing
  462. # the direct and indirect include dependencies of the file with other
  463. # documented files.
  464. INCLUDE_GRAPH = YES
  465. # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
  466. # YES then doxygen will generate a graph for each documented header file showing
  467. # the documented files that directly or indirectly include this file
  468. INCLUDED_BY_GRAPH = YES
  469. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  470. # will graphical hierarchy of all classes instead of a textual one.
  471. GRAPHICAL_HIERARCHY = YES
  472. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  473. # found. If left blank, it is assumed the dot tool can be found on the path.
  474. DOT_PATH =
  475. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  476. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  477. # this value, doxygen will try to truncate the graph, so that it fits within
  478. # the specified constraint. Beware that most browsers cannot cope with very
  479. # large images.
  480. MAX_DOT_GRAPH_WIDTH = 1024
  481. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  482. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  483. # this value, doxygen will try to truncate the graph, so that it fits within
  484. # the specified constraint. Beware that most browsers cannot cope with very
  485. # large images.
  486. MAX_DOT_GRAPH_HEIGHT = 1024
  487. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  488. # generate a legend page explaining the meaning of the various boxes and
  489. # arrows in the dot generated graphs.
  490. GENERATE_LEGEND = YES
  491. #---------------------------------------------------------------------------
  492. # Configuration::addtions related to the search engine
  493. #---------------------------------------------------------------------------
  494. # The SEARCHENGINE tag specifies whether or not a search engine should be
  495. # used. If set to NO the values of all tags below this one will be ignored.
  496. SEARCHENGINE = NO
  497. # The CGI_NAME tag should be the name of the CGI script that
  498. # starts the search engine (doxysearch) with the correct parameters.
  499. # A script with this name will be generated by doxygen.
  500. CGI_NAME = search.cgi
  501. # The CGI_URL tag should be the absolute URL to the directory where the
  502. # cgi binaries are located. See the documentation of your http daemon for
  503. # details.
  504. CGI_URL =
  505. # The DOC_URL tag should be the absolute URL to the directory where the
  506. # documentation is located. If left blank the absolute path to the
  507. # documentation, with file:// prepended to it, will be used.
  508. DOC_URL =
  509. # The DOC_ABSPATH tag should be the absolute path to the directory where the
  510. # documentation is located. If left blank the directory on the local machine
  511. # will be used.
  512. DOC_ABSPATH =
  513. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
  514. # is installed.
  515. BIN_ABSPATH = /usr/local/bin/
  516. # The EXT_DOC_PATHS tag can be used to specify one or more paths to
  517. # documentation generated for other projects. This allows doxysearch to search
  518. # the documentation for these projects as well.
  519. EXT_DOC_PATHS =