Doxyfile 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  1. # Doxyfile 1.2.4
  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 = "Bullet Collision Detection & Physics Library"
  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 =
  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 =
  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 = YES
  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 = YES
  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 = 8
  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 = NO
  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. #---------------------------------------------------------------------------
  160. # configuration options related to warning and progress messages
  161. #---------------------------------------------------------------------------
  162. # The QUIET tag can be used to turn on/off the messages that are generated
  163. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  164. QUIET = NO
  165. # The WARNINGS tag can be used to turn on/off the warning messages that are
  166. # generated by doxygen. Possible values are YES and NO. If left blank
  167. # NO is used.
  168. WARNINGS = YES
  169. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  170. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  171. # automatically be disabled.
  172. WARN_IF_UNDOCUMENTED = YES
  173. # The WARN_FORMAT tag determines the format of the warning messages that
  174. # doxygen can produce. The string should contain the $file, $line, and $text
  175. # tags, which will be replaced by the file and line number from which the
  176. # warning originated and the warning text.
  177. WARN_FORMAT = "$file:$line: $text"
  178. # The WARN_LOGFILE tag can be used to specify a file to which warning
  179. # and error messages should be written. If left blank the output is written
  180. # to stderr.
  181. WARN_LOGFILE =
  182. #---------------------------------------------------------------------------
  183. # configuration options related to the input files
  184. #---------------------------------------------------------------------------
  185. # The INPUT tag can be used to specify the files and/or directories that contain
  186. # documented source files. You may enter file names like "myfile.cpp" or
  187. # directories like "/usr/src/myproject". Separate the files or directories
  188. # with spaces.
  189. INPUT = src/LinearMath src/BulletCollision src/BulletDynamics src/BulletSoftBody src/btBulletCollisionCommon.h src/btBulletDynamicsCommon.h Extras/Serialize/BulletWorldImporter Extras/Serialize/BulletFileLoader
  190. # If the value of the INPUT tag contains directories, you can use the
  191. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  192. # and *.h) to filter out the source-files in the directories. If left
  193. # blank all files are included.
  194. FILE_PATTERNS = *.h *.cpp *.c
  195. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  196. # should be searched for input files as well. Possible values are YES and NO.
  197. # If left blank NO is used.
  198. RECURSIVE = YES
  199. # The EXCLUDE tag can be used to specify files and/or directories that should
  200. # excluded from the INPUT source files. This way you can easily exclude a
  201. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  202. EXCLUDE =
  203. # If the value of the INPUT tag contains directories, you can use the
  204. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  205. # certain files from those directories.
  206. EXCLUDE_PATTERNS =
  207. # The EXAMPLE_PATH tag can be used to specify one or more files or
  208. # directories that contain example code fragments that are included (see
  209. # the \include command).
  210. EXAMPLE_PATH =
  211. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  212. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  213. # and *.h) to filter out the source-files in the directories. If left
  214. # blank all files are included.
  215. EXAMPLE_PATTERNS =
  216. # The IMAGE_PATH tag can be used to specify one or more files or
  217. # directories that contain image that are included in the documentation (see
  218. # the \image command).
  219. IMAGE_PATH =
  220. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  221. # invoke to filter for each input file. Doxygen will invoke the filter program
  222. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  223. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  224. # input file. Doxygen will then use the output that the filter program writes
  225. # to standard output.
  226. INPUT_FILTER =
  227. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  228. # INPUT_FILTER) will be used to filter the input files when producing source
  229. # files to browse.
  230. FILTER_SOURCE_FILES = NO
  231. #---------------------------------------------------------------------------
  232. # configuration options related to the alphabetical class index
  233. #---------------------------------------------------------------------------
  234. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  235. # of all compounds will be generated. Enable this if the project
  236. # contains a lot of classes, structs, unions or interfaces.
  237. ALPHABETICAL_INDEX = NO
  238. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  239. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  240. # in which this list will be split (can be a number in the range [1..20])
  241. COLS_IN_ALPHA_INDEX = 5
  242. # In case all classes in a project start with a common prefix, all
  243. # classes will be put under the same header in the alphabetical index.
  244. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  245. # should be ignored while generating the index headers.
  246. IGNORE_PREFIX =
  247. #---------------------------------------------------------------------------
  248. # configuration options related to the HTML output
  249. #---------------------------------------------------------------------------
  250. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  251. # generate HTML output.
  252. GENERATE_HTML = YES
  253. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  254. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  255. # put in front of it. If left blank `html' will be used as the default path.
  256. HTML_OUTPUT = html
  257. # The HTML_HEADER tag can be used to specify a personal HTML header for
  258. # each generated HTML page. If it is left blank doxygen will generate a
  259. # standard header.
  260. HTML_HEADER =
  261. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  262. # each generated HTML page. If it is left blank doxygen will generate a
  263. # standard footer.
  264. HTML_FOOTER =
  265. # The HTML_STYLESHEET tag can be used to specify a user defined cascading
  266. # style sheet that is used by each HTML page. It can be used to
  267. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  268. # will generate a default style sheet
  269. HTML_STYLESHEET =
  270. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  271. # files or namespaces will be aligned in HTML using tables. If set to
  272. # NO a bullet list will be used.
  273. HTML_ALIGN_MEMBERS = YES
  274. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  275. # will be generated that can be used as input for tools like the
  276. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  277. # of the generated HTML documentation.
  278. GENERATE_HTMLHELP = YES
  279. # HHC_LOCATION = "C:\Program Files\HTML Help Workshop\hhc.exe"
  280. HHC_LOCATION = "C:\Program Files (x86)\HTML Help Workshop\hhc.exe"
  281. HTML_FILE_EXTENSION = .html
  282. HTML_HEADER =
  283. HTML_FOOTER =
  284. #HTML_STYLESHEET = "\\server\exchange\Software Development\Documentation\DoxyGen\doxygen.css"
  285. CHM_FILE = BulletDocs.chm
  286. HHC_LOCATION = "c:\program files\HTML Help Workshop\hhc.exe"
  287. GENERATE_CHI = YES
  288. BINARY_TOC = YES
  289. TOC_EXPAND = YES
  290. SHOW_DIRECTORIES = YES
  291. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  292. # top of each HTML page. The value NO (the default) enables the index and
  293. # the value YES disables it.
  294. DISABLE_INDEX = NO
  295. # This tag can be used to set the number of enum values (range [1..20])
  296. # that doxygen will group on one line in the generated HTML documentation.
  297. ENUM_VALUES_PER_LINE = 1
  298. # If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be
  299. # generated containing a tree-like index structure (just like the one that
  300. # is generated for HTML Help). For this to work a browser that supports
  301. # JavaScript and frames is required (for instance Netscape 4.0+
  302. # or Internet explorer 4.0+).
  303. GENERATE_TREEVIEW = YES
  304. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  305. # used to set the initial width (in pixels) of the frame in which the tree
  306. # is shown.
  307. TREEVIEW_WIDTH = 250
  308. #---------------------------------------------------------------------------
  309. # configuration options related to the LaTeX output
  310. #---------------------------------------------------------------------------
  311. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  312. # generate Latex output.
  313. GENERATE_LATEX = NO
  314. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  315. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  316. # put in front of it. If left blank `latex' will be used as the default path.
  317. LATEX_OUTPUT = latex
  318. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  319. # LaTeX documents. This may be useful for small projects and may help to
  320. # save some trees in general.
  321. COMPACT_LATEX = NO
  322. # The PAPER_TYPE tag can be used to set the paper type that is used
  323. # by the printer. Possible values are: a4, a4wide, letter, legal and
  324. # executive. If left blank a4wide will be used.
  325. PAPER_TYPE = a4wide
  326. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  327. # packages that should be included in the LaTeX output.
  328. EXTRA_PACKAGES =
  329. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  330. # the generated latex document. The header should contain everything until
  331. # the first chapter. If it is left blank doxygen will generate a
  332. # standard header. Notice: only use this tag if you know what you are doing!
  333. LATEX_HEADER =
  334. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  335. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  336. # contain links (just like the HTML output) instead of page references
  337. # This makes the output suitable for online browsing using a pdf viewer.
  338. PDF_HYPERLINKS = NO
  339. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  340. # plain latex in the generated Makefile. Set this option to YES to get a
  341. # higher quality PDF documentation.
  342. USE_PDFLATEX = NO
  343. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  344. # command to the generated LaTeX files. This will instruct LaTeX to keep
  345. # running if errors occur, instead of asking the user for help.
  346. # This option is also used when generating formulas in HTML.
  347. LATEX_BATCHMODE = NO
  348. #---------------------------------------------------------------------------
  349. # configuration options related to the RTF output
  350. #---------------------------------------------------------------------------
  351. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  352. # The RTF output is optimised for Word 97 and may not look very pretty with
  353. # other RTF readers or editors.
  354. GENERATE_RTF = NO
  355. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  356. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  357. # put in front of it. If left blank `rtf' will be used as the default path.
  358. RTF_OUTPUT = rtf
  359. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  360. # RTF documents. This may be useful for small projects and may help to
  361. # save some trees in general.
  362. COMPACT_RTF = NO
  363. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  364. # will contain hyperlink fields. The RTF file will
  365. # contain links (just like the HTML output) instead of page references.
  366. # This makes the output suitable for online browsing using a WORD or other.
  367. # programs which support those fields.
  368. # Note: wordpad (write) and others do not support links.
  369. RTF_HYPERLINKS = NO
  370. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  371. # config file, i.e. a series of assigments. You only have to provide
  372. # replacements, missing definitions are set to their default value.
  373. RTF_STYLESHEET_FILE =
  374. #---------------------------------------------------------------------------
  375. # configuration options related to the man page output
  376. #---------------------------------------------------------------------------
  377. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  378. # generate man pages
  379. GENERATE_MAN = NO
  380. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  381. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  382. # put in front of it. If left blank `man' will be used as the default path.
  383. MAN_OUTPUT = man
  384. # The MAN_EXTENSION tag determines the extension that is added to
  385. # the generated man pages (default is the subroutine's section .3)
  386. MAN_EXTENSION = .3
  387. #---------------------------------------------------------------------------
  388. # configuration options related to the XML output
  389. #---------------------------------------------------------------------------
  390. # If the GENERATE_XML tag is set to YES Doxygen will
  391. # generate an XML file that captures the structure of
  392. # the code including all documentation. Warning: This feature
  393. # is still experimental and very incomplete.
  394. GENERATE_XML = NO
  395. #---------------------------------------------------------------------------
  396. # Configuration options related to the preprocessor
  397. #---------------------------------------------------------------------------
  398. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  399. # evaluate all C-preprocessor directives found in the sources and include
  400. # files.
  401. ENABLE_PREPROCESSING = YES
  402. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  403. # names in the source code. If set to NO (the default) only conditional
  404. # compilation will be performed. Macro expansion can be done in a controlled
  405. # way by setting EXPAND_ONLY_PREDEF to YES.
  406. MACRO_EXPANSION = YES
  407. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  408. # then the macro expansion is limited to the macros specified with the
  409. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  410. EXPAND_ONLY_PREDEF = YES
  411. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  412. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  413. SEARCH_INCLUDES = YES
  414. # The INCLUDE_PATH tag can be used to specify one or more directories that
  415. # contain include files that are not input files but should be processed by
  416. # the preprocessor.
  417. INCLUDE_PATH =
  418. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  419. # patterns (like *.h and *.hpp) to filter out the header-files in the
  420. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  421. # be used.
  422. INCLUDE_FILE_PATTERNS =
  423. # The PREDEFINED tag can be used to specify one or more macro names that
  424. # are defined before the preprocessor is started (similar to the -D option of
  425. # gcc). The argument of the tag is a list of macros of the form: name
  426. # or name=definition (no spaces). If the definition and the = are
  427. # omitted =1 is assumed.
  428. PREDEFINED = "ATTRIBUTE_ALIGNED128(x)=x" \
  429. "ATTRIBUTE_ALIGNED16(x)=x" \
  430. "SIMD_FORCE_INLINE=inline" \
  431. "VECTORMATH_FORCE_INLINE=inline" \
  432. "USE_WIN32_THREADING=1"\
  433. "USE_PTHREADS=1"\
  434. "_WIN32=1"
  435. # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
  436. # this tag can be used to specify a list of macro names that should be expanded.
  437. # The macro definition that is found in the sources will be used.
  438. # Use the PREDEFINED tag if you want to use a different macro definition.
  439. EXPAND_AS_DEFINED =
  440. #---------------------------------------------------------------------------
  441. # Configuration::addtions related to external references
  442. #---------------------------------------------------------------------------
  443. # The TAGFILES tag can be used to specify one or more tagfiles.
  444. TAGFILES =
  445. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  446. # a tag file that is based on the input files it reads.
  447. GENERATE_TAGFILE =
  448. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  449. # in the class index. If set to NO only the inherited external classes
  450. # will be listed.
  451. ALLEXTERNALS = NO
  452. # The PERL_PATH should be the absolute path and name of the perl script
  453. # interpreter (i.e. the result of `which perl').
  454. PERL_PATH = /usr/bin/perl
  455. #---------------------------------------------------------------------------
  456. # Configuration options related to the dot tool
  457. #---------------------------------------------------------------------------
  458. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  459. # available from the path. This tool is part of Graphviz, a graph visualization
  460. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  461. # have no effect if this option is set to NO (the default)
  462. HAVE_DOT = YES
  463. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  464. # will generate a graph for each documented class showing the direct and
  465. # indirect inheritance relations. Setting this tag to YES will force the
  466. # the CLASS_DIAGRAMS tag to NO.
  467. CLASS_GRAPH = YES
  468. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  469. # will generate a graph for each documented class showing the direct and
  470. # indirect implementation dependencies (inheritance, containment, and
  471. # class references variables) of the class with other documented classes.
  472. COLLABORATION_GRAPH = YES
  473. # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
  474. # YES then doxygen will generate a graph for each documented file showing
  475. # the direct and indirect include dependencies of the file with other
  476. # documented files.
  477. INCLUDE_GRAPH = YES
  478. # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
  479. # YES then doxygen will generate a graph for each documented header file showing
  480. # the documented files that directly or indirectly include this file
  481. INCLUDED_BY_GRAPH = YES
  482. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  483. # will graphical hierarchy of all classes instead of a textual one.
  484. GRAPHICAL_HIERARCHY = YES
  485. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  486. # found. If left blank, it is assumed the dot tool can be found on the path.
  487. DOT_PATH =
  488. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  489. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  490. # this value, doxygen will try to truncate the graph, so that it fits within
  491. # the specified constraint. Beware that most browsers cannot cope with very
  492. # large images.
  493. MAX_DOT_GRAPH_WIDTH = 1024
  494. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  495. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  496. # this value, doxygen will try to truncate the graph, so that it fits within
  497. # the specified constraint. Beware that most browsers cannot cope with very
  498. # large images.
  499. MAX_DOT_GRAPH_HEIGHT = 1024
  500. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  501. # generate a legend page explaining the meaning of the various boxes and
  502. # arrows in the dot generated graphs.
  503. GENERATE_LEGEND = YES
  504. # delete intermediate dot files?
  505. DOT_CLEANUP = YES
  506. #---------------------------------------------------------------------------
  507. # Configuration::addtions related to the search engine
  508. #---------------------------------------------------------------------------
  509. # The SEARCHENGINE tag specifies whether or not a search engine should be
  510. # used. If set to NO the values of all tags below this one will be ignored.
  511. SEARCHENGINE = NO
  512. # The CGI_NAME tag should be the name of the CGI script that
  513. # starts the search engine (doxysearch) with the correct parameters.
  514. # A script with this name will be generated by doxygen.
  515. CGI_NAME = search.cgi
  516. # The CGI_URL tag should be the absolute URL to the directory where the
  517. # cgi binaries are located. See the documentation of your http daemon for
  518. # details.
  519. CGI_URL =
  520. # The DOC_URL tag should be the absolute URL to the directory where the
  521. # documentation is located. If left blank the absolute path to the
  522. # documentation, with file:// prepended to it, will be used.
  523. DOC_URL =
  524. # The DOC_ABSPATH tag should be the absolute path to the directory where the
  525. # documentation is located. If left blank the directory on the local machine
  526. # will be used.
  527. DOC_ABSPATH =
  528. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
  529. # is installed.
  530. BIN_ABSPATH = c:\program files\doxygen\bin
  531. # The EXT_DOC_PATHS tag can be used to specify one or more paths to
  532. # documentation generated for other projects. This allows doxysearch to search
  533. # the documentation for these projects as well.
  534. EXT_DOC_PATHS =