A C++ DAL / ORM code generation framework

Doxyfile 71KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720
  1. # Doxyfile 1.7.3
  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. # This tag specifies the encoding used for all characters in the config file
  15. # that follow. The default is UTF-8 which is also the encoding used for all
  16. # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  17. # iconv built into libc) for the transcoding. See
  18. # http://www.gnu.org/software/libiconv for the list of possible encodings.
  19. DOXYFILE_ENCODING = UTF-8
  20. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  21. # by quotes) that should identify the project.
  22. PROJECT_NAME = WORM
  23. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  24. # This could be handy for archiving the generated documentation or
  25. # if some version control system is used.
  26. PROJECT_NUMBER = 0.2
  27. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  28. # for a project that appears at the top of each page and should give viewer
  29. # a quick idea about the purpose of the project. Keep the description short.
  30. PROJECT_BRIEF = "A C++ DAL/ORM code generation framework"
  31. # With the PROJECT_LOGO tag one can specify an logo or icon that is
  32. # included in the documentation. The maximum height of the logo should not
  33. # exceed 55 pixels and the maximum width should not exceed 200 pixels.
  34. # Doxygen will copy the logo to the output directory.
  35. PROJECT_LOGO = /home/erik/src/kdevelop/worm/doc/worm_sm.png
  36. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  37. # base path where the generated documentation will be put.
  38. # If a relative path is entered, it will be relative to the location
  39. # where doxygen was started. If left blank the current directory will be used.
  40. OUTPUT_DIRECTORY = /home/erik/src/kdevelop/worm/doc
  41. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  42. # 4096 sub-directories (in 2 levels) under the output directory of each output
  43. # format and will distribute the generated files over these directories.
  44. # Enabling this option can be useful when feeding doxygen a huge amount of
  45. # source files, where putting all generated files in the same directory would
  46. # otherwise cause performance problems for the file system.
  47. CREATE_SUBDIRS = NO
  48. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  49. # documentation generated by doxygen is written. Doxygen will use this
  50. # information to generate all constant output in the proper language.
  51. # The default language is English, other supported languages are:
  52. # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  53. # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  54. # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  55. # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  56. # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
  57. # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  58. OUTPUT_LANGUAGE = English
  59. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  60. # include brief member descriptions after the members that are listed in
  61. # the file and class documentation (similar to JavaDoc).
  62. # Set to NO to disable this.
  63. BRIEF_MEMBER_DESC = YES
  64. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  65. # the brief description of a member or function before the detailed description.
  66. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  67. # brief descriptions will be completely suppressed.
  68. REPEAT_BRIEF = YES
  69. # This tag implements a quasi-intelligent brief description abbreviator
  70. # that is used to form the text in various listings. Each string
  71. # in this list, if found as the leading text of the brief description, will be
  72. # stripped from the text and the result after processing the whole list, is
  73. # used as the annotated text. Otherwise, the brief description is used as-is.
  74. # If left blank, the following values are used ("$name" is automatically
  75. # replaced with the name of the entity): "The $name class" "The $name widget"
  76. # "The $name file" "is" "provides" "specifies" "contains"
  77. # "represents" "a" "an" "the"
  78. ABBREVIATE_BRIEF = "The $name class" \
  79. "The $name widget" \
  80. "The $name file" \
  81. is \
  82. provides \
  83. specifies \
  84. contains \
  85. represents \
  86. a \
  87. an \
  88. the
  89. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  90. # Doxygen will generate a detailed section even if there is only a brief
  91. # description.
  92. ALWAYS_DETAILED_SEC = YES
  93. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  94. # inherited members of a class in the documentation of that class as if those
  95. # members were ordinary class members. Constructors, destructors and assignment
  96. # operators of the base classes will not be shown.
  97. INLINE_INHERITED_MEMB = NO
  98. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  99. # path before files name in the file list and in the header files. If set
  100. # to NO the shortest path that makes the file name unique will be used.
  101. FULL_PATH_NAMES = YES
  102. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  103. # can be used to strip a user-defined part of the path. Stripping is
  104. # only done if one of the specified strings matches the left-hand part of
  105. # the path. The tag can be used to show relative paths in the file list.
  106. # If left blank the directory from which doxygen is run is used as the
  107. # path to strip.
  108. STRIP_FROM_PATH =
  109. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  110. # the path mentioned in the documentation of a class, which tells
  111. # the reader which header file to include in order to use a class.
  112. # If left blank only the name of the header file containing the class
  113. # definition is used. Otherwise one should specify the include paths that
  114. # are normally passed to the compiler using the -I flag.
  115. STRIP_FROM_INC_PATH =
  116. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  117. # (but less readable) file names. This can be useful if your file system
  118. # doesn't support long names like on DOS, Mac, or CD-ROM.
  119. SHORT_NAMES = NO
  120. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  121. # will interpret the first line (until the first dot) of a JavaDoc-style
  122. # comment as the brief description. If set to NO, the JavaDoc
  123. # comments will behave just like regular Qt-style comments
  124. # (thus requiring an explicit @brief command for a brief description.)
  125. JAVADOC_AUTOBRIEF = NO
  126. # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  127. # interpret the first line (until the first dot) of a Qt-style
  128. # comment as the brief description. If set to NO, the comments
  129. # will behave just like regular Qt-style comments (thus requiring
  130. # an explicit \brief command for a brief description.)
  131. QT_AUTOBRIEF = NO
  132. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  133. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  134. # comments) as a brief description. This used to be the default behaviour.
  135. # The new default is to treat a multi-line C++ comment block as a detailed
  136. # description. Set this tag to YES if you prefer the old behaviour instead.
  137. MULTILINE_CPP_IS_BRIEF = NO
  138. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  139. # member inherits the documentation from any documented member that it
  140. # re-implements.
  141. INHERIT_DOCS = YES
  142. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  143. # a new page for each member. If set to NO, the documentation of a member will
  144. # be part of the file/class/namespace that contains it.
  145. SEPARATE_MEMBER_PAGES = NO
  146. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  147. # Doxygen uses this value to replace tabs by spaces in code fragments.
  148. TAB_SIZE = 4
  149. # This tag can be used to specify a number of aliases that acts
  150. # as commands in the documentation. An alias has the form "name=value".
  151. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  152. # put the command \sideeffect (or @sideeffect) in the documentation, which
  153. # will result in a user-defined paragraph with heading "Side Effects:".
  154. # You can put \n's in the value part of an alias to insert newlines.
  155. ALIASES =
  156. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  157. # sources only. Doxygen will then generate output that is more tailored for C.
  158. # For instance, some of the names that are used will be different. The list
  159. # of all members will be omitted, etc.
  160. OPTIMIZE_OUTPUT_FOR_C = NO
  161. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  162. # sources only. Doxygen will then generate output that is more tailored for
  163. # Java. For instance, namespaces will be presented as packages, qualified
  164. # scopes will look different, etc.
  165. OPTIMIZE_OUTPUT_JAVA = NO
  166. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  167. # sources only. Doxygen will then generate output that is more tailored for
  168. # Fortran.
  169. OPTIMIZE_FOR_FORTRAN = NO
  170. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  171. # sources. Doxygen will then generate output that is tailored for
  172. # VHDL.
  173. OPTIMIZE_OUTPUT_VHDL = NO
  174. # Doxygen selects the parser to use depending on the extension of the files it
  175. # parses. With this tag you can assign which parser to use for a given extension.
  176. # Doxygen has a built-in mapping, but you can override or extend it using this
  177. # tag. The format is ext=language, where ext is a file extension, and language
  178. # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
  179. # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
  180. # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
  181. # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
  182. # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
  183. EXTENSION_MAPPING =
  184. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  185. # to include (a tag file for) the STL sources as input, then you should
  186. # set this tag to YES in order to let doxygen match functions declarations and
  187. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  188. # func(std::string) {}). This also makes the inheritance and collaboration
  189. # diagrams that involve STL classes more complete and accurate.
  190. BUILTIN_STL_SUPPORT = YES
  191. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  192. # enable parsing support.
  193. CPP_CLI_SUPPORT = NO
  194. # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  195. # Doxygen will parse them like normal C++ but will assume all classes use public
  196. # instead of private inheritance when no explicit protection keyword is present.
  197. SIP_SUPPORT = NO
  198. # For Microsoft's IDL there are propget and propput attributes to indicate getter
  199. # and setter methods for a property. Setting this option to YES (the default)
  200. # will make doxygen replace the get and set methods by a property in the
  201. # documentation. This will only work if the methods are indeed getting or
  202. # setting a simple type. If this is not the case, or you want to show the
  203. # methods anyway, you should set this option to NO.
  204. IDL_PROPERTY_SUPPORT = YES
  205. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  206. # tag is set to YES, then doxygen will reuse the documentation of the first
  207. # member in the group (if any) for the other members of the group. By default
  208. # all members of a group must be documented explicitly.
  209. DISTRIBUTE_GROUP_DOC = NO
  210. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  211. # the same type (for instance a group of public functions) to be put as a
  212. # subgroup of that type (e.g. under the Public Functions section). Set it to
  213. # NO to prevent subgrouping. Alternatively, this can be done per class using
  214. # the \nosubgrouping command.
  215. SUBGROUPING = NO
  216. # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  217. # is documented as struct, union, or enum with the name of the typedef. So
  218. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  219. # with name TypeT. When disabled the typedef will appear as a member of a file,
  220. # namespace, or class. And the struct will be named TypeS. This can typically
  221. # be useful for C code in case the coding convention dictates that all compound
  222. # types are typedef'ed and only the typedef is referenced, never the tag name.
  223. TYPEDEF_HIDES_STRUCT = NO
  224. # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
  225. # determine which symbols to keep in memory and which to flush to disk.
  226. # When the cache is full, less often used symbols will be written to disk.
  227. # For small to medium size projects (<1000 input files) the default value is
  228. # probably good enough. For larger projects a too small cache size can cause
  229. # doxygen to be busy swapping symbols to and from disk most of the time
  230. # causing a significant performance penalty.
  231. # If the system has enough physical memory increasing the cache will improve the
  232. # performance by keeping more symbols in memory. Note that the value works on
  233. # a logarithmic scale so increasing the size by one will roughly double the
  234. # memory usage. The cache size is given by this formula:
  235. # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
  236. # corresponding to a cache size of 2^16 = 65536 symbols
  237. SYMBOL_CACHE_SIZE = 0
  238. #---------------------------------------------------------------------------
  239. # Build related configuration options
  240. #---------------------------------------------------------------------------
  241. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  242. # documentation are documented, even if no documentation was available.
  243. # Private class members and static file members will be hidden unless
  244. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  245. EXTRACT_ALL = YES
  246. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  247. # will be included in the documentation.
  248. EXTRACT_PRIVATE = NO
  249. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  250. # will be included in the documentation.
  251. EXTRACT_STATIC = YES
  252. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  253. # defined locally in source files will be included in the documentation.
  254. # If set to NO only classes defined in header files are included.
  255. EXTRACT_LOCAL_CLASSES = YES
  256. # This flag is only useful for Objective-C code. When set to YES local
  257. # methods, which are defined in the implementation section but not in
  258. # the interface are included in the documentation.
  259. # If set to NO (the default) only methods in the interface are included.
  260. EXTRACT_LOCAL_METHODS = YES
  261. # If this flag is set to YES, the members of anonymous namespaces will be
  262. # extracted and appear in the documentation as a namespace called
  263. # 'anonymous_namespace{file}', where file will be replaced with the base
  264. # name of the file that contains the anonymous namespace. By default
  265. # anonymous namespaces are hidden.
  266. EXTRACT_ANON_NSPACES = NO
  267. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  268. # undocumented members of documented classes, files or namespaces.
  269. # If set to NO (the default) these members will be included in the
  270. # various overviews, but no documentation section is generated.
  271. # This option has no effect if EXTRACT_ALL is enabled.
  272. HIDE_UNDOC_MEMBERS = NO
  273. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  274. # undocumented classes that are normally visible in the class hierarchy.
  275. # If set to NO (the default) these classes will be included in the various
  276. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  277. HIDE_UNDOC_CLASSES = NO
  278. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  279. # friend (class|struct|union) declarations.
  280. # If set to NO (the default) these declarations will be included in the
  281. # documentation.
  282. HIDE_FRIEND_COMPOUNDS = NO
  283. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  284. # documentation blocks found inside the body of a function.
  285. # If set to NO (the default) these blocks will be appended to the
  286. # function's detailed documentation block.
  287. HIDE_IN_BODY_DOCS = NO
  288. # The INTERNAL_DOCS tag determines if documentation
  289. # that is typed after a \internal command is included. If the tag is set
  290. # to NO (the default) then the documentation will be excluded.
  291. # Set it to YES to include the internal documentation.
  292. INTERNAL_DOCS = NO
  293. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  294. # file names in lower-case letters. If set to YES upper-case letters are also
  295. # allowed. This is useful if you have classes or files whose names only differ
  296. # in case and if your file system supports case sensitive file names. Windows
  297. # and Mac users are advised to set this option to NO.
  298. CASE_SENSE_NAMES = NO
  299. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  300. # will show members with their full class and namespace scopes in the
  301. # documentation. If set to YES the scope will be hidden.
  302. HIDE_SCOPE_NAMES = NO
  303. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  304. # will put a list of the files that are included by a file in the documentation
  305. # of that file.
  306. SHOW_INCLUDE_FILES = YES
  307. # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
  308. # will list include files with double quotes in the documentation
  309. # rather than with sharp brackets.
  310. FORCE_LOCAL_INCLUDES = NO
  311. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  312. # is inserted in the documentation for inline members.
  313. INLINE_INFO = YES
  314. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  315. # will sort the (detailed) documentation of file and class members
  316. # alphabetically by member name. If set to NO the members will appear in
  317. # declaration order.
  318. SORT_MEMBER_DOCS = YES
  319. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  320. # brief documentation of file, namespace and class members alphabetically
  321. # by member name. If set to NO (the default) the members will appear in
  322. # declaration order.
  323. SORT_BRIEF_DOCS = NO
  324. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
  325. # will sort the (brief and detailed) documentation of class members so that
  326. # constructors and destructors are listed first. If set to NO (the default)
  327. # the constructors will appear in the respective orders defined by
  328. # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
  329. # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
  330. # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  331. SORT_MEMBERS_CTORS_1ST = NO
  332. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  333. # hierarchy of group names into alphabetical order. If set to NO (the default)
  334. # the group names will appear in their defined order.
  335. SORT_GROUP_NAMES = NO
  336. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  337. # sorted by fully-qualified names, including namespaces. If set to
  338. # NO (the default), the class list will be sorted only by class name,
  339. # not including the namespace part.
  340. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  341. # Note: This option applies only to the class list, not to the
  342. # alphabetical list.
  343. SORT_BY_SCOPE_NAME = NO
  344. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
  345. # do proper type resolution of all parameters of a function it will reject a
  346. # match between the prototype and the implementation of a member function even
  347. # if there is only one candidate or it is obvious which candidate to choose
  348. # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
  349. # will still accept a match between prototype and implementation in such cases.
  350. STRICT_PROTO_MATCHING = NO
  351. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  352. # disable (NO) the todo list. This list is created by putting \todo
  353. # commands in the documentation.
  354. GENERATE_TODOLIST = YES
  355. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  356. # disable (NO) the test list. This list is created by putting \test
  357. # commands in the documentation.
  358. GENERATE_TESTLIST = YES
  359. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  360. # disable (NO) the bug list. This list is created by putting \bug
  361. # commands in the documentation.
  362. GENERATE_BUGLIST = YES
  363. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  364. # disable (NO) the deprecated list. This list is created by putting
  365. # \deprecated commands in the documentation.
  366. GENERATE_DEPRECATEDLIST= YES
  367. # The ENABLED_SECTIONS tag can be used to enable conditional
  368. # documentation sections, marked by \if sectionname ... \endif.
  369. ENABLED_SECTIONS =
  370. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  371. # the initial value of a variable or macro consists of for it to appear in
  372. # the documentation. If the initializer consists of more lines than specified
  373. # here it will be hidden. Use a value of 0 to hide initializers completely.
  374. # The appearance of the initializer of individual variables and macros in the
  375. # documentation can be controlled using \showinitializer or \hideinitializer
  376. # command in the documentation regardless of this setting.
  377. MAX_INITIALIZER_LINES = 30
  378. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  379. # at the bottom of the documentation of classes and structs. If set to YES the
  380. # list will mention the files that were used to generate the documentation.
  381. SHOW_USED_FILES = YES
  382. # If the sources in your project are distributed over multiple directories
  383. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  384. # in the documentation. The default is NO.
  385. SHOW_DIRECTORIES = NO
  386. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  387. # This will remove the Files entry from the Quick Index and from the
  388. # Folder Tree View (if specified). The default is YES.
  389. SHOW_FILES = YES
  390. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  391. # Namespaces page. This will remove the Namespaces entry from the Quick Index
  392. # and from the Folder Tree View (if specified). The default is YES.
  393. SHOW_NAMESPACES = YES
  394. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  395. # doxygen should invoke to get the current version for each file (typically from
  396. # the version control system). Doxygen will invoke the program by executing (via
  397. # popen()) the command <command> <input-file>, where <command> is the value of
  398. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  399. # provided by doxygen. Whatever the program writes to standard output
  400. # is used as the file version. See the manual for examples.
  401. FILE_VERSION_FILTER =
  402. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  403. # by doxygen. The layout file controls the global structure of the generated
  404. # output files in an output format independent way. The create the layout file
  405. # that represents doxygen's defaults, run doxygen with the -l option.
  406. # You can optionally specify a file name after the option, if omitted
  407. # DoxygenLayout.xml will be used as the name of the layout file.
  408. LAYOUT_FILE =
  409. #---------------------------------------------------------------------------
  410. # configuration options related to warning and progress messages
  411. #---------------------------------------------------------------------------
  412. # The QUIET tag can be used to turn on/off the messages that are generated
  413. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  414. QUIET = NO
  415. # The WARNINGS tag can be used to turn on/off the warning messages that are
  416. # generated by doxygen. Possible values are YES and NO. If left blank
  417. # NO is used.
  418. WARNINGS = YES
  419. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  420. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  421. # automatically be disabled.
  422. WARN_IF_UNDOCUMENTED = YES
  423. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  424. # potential errors in the documentation, such as not documenting some
  425. # parameters in a documented function, or documenting parameters that
  426. # don't exist or using markup commands wrongly.
  427. WARN_IF_DOC_ERROR = YES
  428. # The WARN_NO_PARAMDOC option can be enabled to get warnings for
  429. # functions that are documented, but have no documentation for their parameters
  430. # or return value. If set to NO (the default) doxygen will only warn about
  431. # wrong or incomplete parameter documentation, but not about the absence of
  432. # documentation.
  433. WARN_NO_PARAMDOC = NO
  434. # The WARN_FORMAT tag determines the format of the warning messages that
  435. # doxygen can produce. The string should contain the $file, $line, and $text
  436. # tags, which will be replaced by the file and line number from which the
  437. # warning originated and the warning text. Optionally the format may contain
  438. # $version, which will be replaced by the version of the file (if it could
  439. # be obtained via FILE_VERSION_FILTER)
  440. WARN_FORMAT = "$file:$line: $text"
  441. # The WARN_LOGFILE tag can be used to specify a file to which warning
  442. # and error messages should be written. If left blank the output is written
  443. # to stderr.
  444. WARN_LOGFILE =
  445. #---------------------------------------------------------------------------
  446. # configuration options related to the input files
  447. #---------------------------------------------------------------------------
  448. # The INPUT tag can be used to specify the files and/or directories that contain
  449. # documented source files. You may enter file names like "myfile.cpp" or
  450. # directories like "/usr/src/myproject". Separate the files or directories
  451. # with spaces.
  452. INPUT = /home/erik/src/kdevelop/worm/src
  453. # This tag can be used to specify the character encoding of the source files
  454. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  455. # also the default input encoding. Doxygen uses libiconv (or the iconv built
  456. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  457. # the list of possible encodings.
  458. INPUT_ENCODING = UTF-8
  459. # If the value of the INPUT tag contains directories, you can use the
  460. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  461. # and *.h) to filter out the source-files in the directories. If left
  462. # blank the following patterns are tested:
  463. # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
  464. # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
  465. # *.f90 *.f *.for *.vhd *.vhdl
  466. FILE_PATTERNS = *.c \
  467. *.cc \
  468. *.cxx \
  469. *.cpp \
  470. *.c++ \
  471. *.d \
  472. *.java \
  473. *.ii \
  474. *.ixx \
  475. *.ipp \
  476. *.i++ \
  477. *.inl \
  478. *.h \
  479. *.hh \
  480. *.hxx \
  481. *.hpp \
  482. *.h++ \
  483. *.idl \
  484. *.odl \
  485. *.cs \
  486. *.php \
  487. *.php3 \
  488. *.inc \
  489. *.m \
  490. *.mm \
  491. *.dox \
  492. *.py \
  493. *.f90 \
  494. *.f \
  495. *.for \
  496. *.vhd \
  497. *.vhdl
  498. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  499. # should be searched for input files as well. Possible values are YES and NO.
  500. # If left blank NO is used.
  501. RECURSIVE = YES
  502. # The EXCLUDE tag can be used to specify files and/or directories that should
  503. # excluded from the INPUT source files. This way you can easily exclude a
  504. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  505. EXCLUDE =
  506. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  507. # directories that are symbolic links (a Unix file system feature) are excluded
  508. # from the input.
  509. EXCLUDE_SYMLINKS = NO
  510. # If the value of the INPUT tag contains directories, you can use the
  511. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  512. # certain files from those directories. Note that the wildcards are matched
  513. # against the file with absolute path, so to exclude all test directories
  514. # for example use the pattern */test/*
  515. EXCLUDE_PATTERNS =
  516. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  517. # (namespaces, classes, functions, etc.) that should be excluded from the
  518. # output. The symbol name can be a fully qualified name, a word, or if the
  519. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  520. # AClass::ANamespace, ANamespace::*Test
  521. EXCLUDE_SYMBOLS =
  522. # The EXAMPLE_PATH tag can be used to specify one or more files or
  523. # directories that contain example code fragments that are included (see
  524. # the \include command).
  525. EXAMPLE_PATH = doc/ \
  526. examples/
  527. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  528. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  529. # and *.h) to filter out the source-files in the directories. If left
  530. # blank all files are included.
  531. EXAMPLE_PATTERNS = *
  532. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  533. # searched for input files to be used with the \include or \dontinclude
  534. # commands irrespective of the value of the RECURSIVE tag.
  535. # Possible values are YES and NO. If left blank NO is used.
  536. EXAMPLE_RECURSIVE = NO
  537. # The IMAGE_PATH tag can be used to specify one or more files or
  538. # directories that contain image that are included in the documentation (see
  539. # the \image command).
  540. IMAGE_PATH =
  541. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  542. # invoke to filter for each input file. Doxygen will invoke the filter program
  543. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  544. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  545. # input file. Doxygen will then use the output that the filter program writes
  546. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  547. # ignored.
  548. INPUT_FILTER =
  549. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  550. # basis. Doxygen will compare the file name with each pattern and apply the
  551. # filter if there is a match. The filters are a list of the form:
  552. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  553. # info on how filters are used. If FILTER_PATTERNS is empty or if
  554. # non of the patterns match the file name, INPUT_FILTER is applied.
  555. FILTER_PATTERNS =
  556. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  557. # INPUT_FILTER) will be used to filter the input files when producing source
  558. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  559. FILTER_SOURCE_FILES = NO
  560. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  561. # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
  562. # and it is also possible to disable source filtering for a specific pattern
  563. # using *.ext= (so without naming a filter). This option only has effect when
  564. # FILTER_SOURCE_FILES is enabled.
  565. FILTER_SOURCE_PATTERNS =
  566. #---------------------------------------------------------------------------
  567. # configuration options related to source browsing
  568. #---------------------------------------------------------------------------
  569. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  570. # be generated. Documented entities will be cross-referenced with these sources.
  571. # Note: To get rid of all source code in the generated output, make sure also
  572. # VERBATIM_HEADERS is set to NO.
  573. SOURCE_BROWSER = YES
  574. # Setting the INLINE_SOURCES tag to YES will include the body
  575. # of functions and classes directly in the documentation.
  576. INLINE_SOURCES = NO
  577. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  578. # doxygen to hide any special comment blocks from generated source code
  579. # fragments. Normal C and C++ comments will always remain visible.
  580. STRIP_CODE_COMMENTS = YES
  581. # If the REFERENCED_BY_RELATION tag is set to YES
  582. # then for each documented function all documented
  583. # functions referencing it will be listed.
  584. REFERENCED_BY_RELATION = NO
  585. # If the REFERENCES_RELATION tag is set to YES
  586. # then for each documented function all documented entities
  587. # called/used by that function will be listed.
  588. REFERENCES_RELATION = NO
  589. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  590. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  591. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  592. # link to the source code. Otherwise they will link to the documentation.
  593. REFERENCES_LINK_SOURCE = YES
  594. # If the USE_HTAGS tag is set to YES then the references to source code
  595. # will point to the HTML generated by the htags(1) tool instead of doxygen
  596. # built-in source browser. The htags tool is part of GNU's global source
  597. # tagging system (see http://www.gnu.org/software/global/global.html). You
  598. # will need version 4.8.6 or higher.
  599. USE_HTAGS = NO
  600. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  601. # will generate a verbatim copy of the header file for each class for
  602. # which an include is specified. Set to NO to disable this.
  603. VERBATIM_HEADERS = YES
  604. #---------------------------------------------------------------------------
  605. # configuration options related to the alphabetical class index
  606. #---------------------------------------------------------------------------
  607. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  608. # of all compounds will be generated. Enable this if the project
  609. # contains a lot of classes, structs, unions or interfaces.
  610. ALPHABETICAL_INDEX = YES
  611. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  612. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  613. # in which this list will be split (can be a number in the range [1..20])
  614. COLS_IN_ALPHA_INDEX = 5
  615. # In case all classes in a project start with a common prefix, all
  616. # classes will be put under the same header in the alphabetical index.
  617. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  618. # should be ignored while generating the index headers.
  619. IGNORE_PREFIX =
  620. #---------------------------------------------------------------------------
  621. # configuration options related to the HTML output
  622. #---------------------------------------------------------------------------
  623. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  624. # generate HTML output.
  625. GENERATE_HTML = YES
  626. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  627. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  628. # put in front of it. If left blank `html' will be used as the default path.
  629. HTML_OUTPUT = html
  630. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  631. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  632. # doxygen will generate files with .html extension.
  633. HTML_FILE_EXTENSION = .html
  634. # The HTML_HEADER tag can be used to specify a personal HTML header for
  635. # each generated HTML page. If it is left blank doxygen will generate a
  636. # standard header.
  637. HTML_HEADER =
  638. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  639. # each generated HTML page. If it is left blank doxygen will generate a
  640. # standard footer.
  641. HTML_FOOTER =
  642. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  643. # style sheet that is used by each HTML page. It can be used to
  644. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  645. # will generate a default style sheet. Note that doxygen will try to copy
  646. # the style sheet file to the HTML output directory, so don't put your own
  647. # stylesheet in the HTML output directory as well, or it will be erased!
  648. HTML_STYLESHEET =
  649. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
  650. # Doxygen will adjust the colors in the stylesheet and background images
  651. # according to this color. Hue is specified as an angle on a colorwheel,
  652. # see http://en.wikipedia.org/wiki/Hue for more information.
  653. # For instance the value 0 represents red, 60 is yellow, 120 is green,
  654. # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
  655. # The allowed range is 0 to 359.
  656. HTML_COLORSTYLE_HUE = 201
  657. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
  658. # the colors in the HTML output. For a value of 0 the output will use
  659. # grayscales only. A value of 255 will produce the most vivid colors.
  660. HTML_COLORSTYLE_SAT = 98
  661. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
  662. # the luminance component of the colors in the HTML output. Values below
  663. # 100 gradually make the output lighter, whereas values above 100 make
  664. # the output darker. The value divided by 100 is the actual gamma applied,
  665. # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
  666. # and 100 does not change the gamma.
  667. HTML_COLORSTYLE_GAMMA = 196
  668. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  669. # page will contain the date and time when the page was generated. Setting
  670. # this to NO can help when comparing the output of multiple runs.
  671. HTML_TIMESTAMP = YES
  672. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  673. # files or namespaces will be aligned in HTML using tables. If set to
  674. # NO a bullet list will be used.
  675. HTML_ALIGN_MEMBERS = YES
  676. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  677. # documentation will contain sections that can be hidden and shown after the
  678. # page has loaded. For this to work a browser that supports
  679. # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
  680. # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  681. HTML_DYNAMIC_SECTIONS = YES
  682. # If the GENERATE_DOCSET tag is set to YES, additional index files
  683. # will be generated that can be used as input for Apple's Xcode 3
  684. # integrated development environment, introduced with OSX 10.5 (Leopard).
  685. # To create a documentation set, doxygen will generate a Makefile in the
  686. # HTML output directory. Running make will produce the docset in that
  687. # directory and running "make install" will install the docset in
  688. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  689. # it at startup.
  690. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  691. # for more information.
  692. GENERATE_DOCSET = NO
  693. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  694. # feed. A documentation feed provides an umbrella under which multiple
  695. # documentation sets from a single provider (such as a company or product suite)
  696. # can be grouped.
  697. DOCSET_FEEDNAME = "Doxygen generated docs"
  698. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  699. # should uniquely identify the documentation set bundle. This should be a
  700. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  701. # will append .docset to the name.
  702. DOCSET_BUNDLE_ID = org.doxygen.Project
  703. # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
  704. # the documentation publisher. This should be a reverse domain-name style
  705. # string, e.g. com.mycompany.MyDocSet.documentation.
  706. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  707. # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
  708. DOCSET_PUBLISHER_NAME = Publisher
  709. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  710. # will be generated that can be used as input for tools like the
  711. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  712. # of the generated HTML documentation.
  713. GENERATE_HTMLHELP = NO
  714. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  715. # be used to specify the file name of the resulting .chm file. You
  716. # can add a path in front of the file if the result should not be
  717. # written to the html output directory.
  718. CHM_FILE =
  719. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  720. # be used to specify the location (absolute path including file name) of
  721. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  722. # the HTML help compiler on the generated index.hhp.
  723. HHC_LOCATION =
  724. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  725. # controls if a separate .chi index file is generated (YES) or that
  726. # it should be included in the master .chm file (NO).
  727. GENERATE_CHI = NO
  728. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  729. # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  730. # content.
  731. CHM_INDEX_ENCODING =
  732. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  733. # controls whether a binary table of contents is generated (YES) or a
  734. # normal table of contents (NO) in the .chm file.
  735. BINARY_TOC = NO
  736. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  737. # to the contents of the HTML help documentation and to the tree view.
  738. TOC_EXPAND = NO
  739. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  740. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
  741. # that can be used as input for Qt's qhelpgenerator to generate a
  742. # Qt Compressed Help (.qch) of the generated HTML documentation.
  743. GENERATE_QHP = NO
  744. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  745. # be used to specify the file name of the resulting .qch file.
  746. # The path specified is relative to the HTML output folder.
  747. QCH_FILE =
  748. # The QHP_NAMESPACE tag specifies the namespace to use when generating
  749. # Qt Help Project output. For more information please see
  750. # http://doc.trolltech.com/qthelpproject.html#namespace
  751. QHP_NAMESPACE = org.doxygen.Project
  752. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  753. # Qt Help Project output. For more information please see
  754. # http://doc.trolltech.com/qthelpproject.html#virtual-folders
  755. QHP_VIRTUAL_FOLDER = doc
  756. # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
  757. # add. For more information please see
  758. # http://doc.trolltech.com/qthelpproject.html#custom-filters
  759. QHP_CUST_FILTER_NAME =
  760. # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
  761. # custom filter to add. For more information please see
  762. # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
  763. # Qt Help Project / Custom Filters</a>.
  764. QHP_CUST_FILTER_ATTRS =
  765. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  766. # project's
  767. # filter section matches.
  768. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
  769. # Qt Help Project / Filter Attributes</a>.
  770. QHP_SECT_FILTER_ATTRS =
  771. # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  772. # be used to specify the location of Qt's qhelpgenerator.
  773. # If non-empty doxygen will try to run qhelpgenerator on the generated
  774. # .qhp file.
  775. QHG_LOCATION =
  776. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
  777. # will be generated, which together with the HTML files, form an Eclipse help
  778. # plugin. To install this plugin and make it available under the help contents
  779. # menu in Eclipse, the contents of the directory containing the HTML and XML
  780. # files needs to be copied into the plugins directory of eclipse. The name of
  781. # the directory within the plugins directory should be the same as
  782. # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
  783. # the help appears.
  784. GENERATE_ECLIPSEHELP = NO
  785. # A unique identifier for the eclipse help plugin. When installing the plugin
  786. # the directory name containing the HTML and XML files should also have
  787. # this name.
  788. ECLIPSE_DOC_ID = org.doxygen.Project
  789. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  790. # top of each HTML page. The value NO (the default) enables the index and
  791. # the value YES disables it.
  792. DISABLE_INDEX = NO
  793. # This tag can be used to set the number of enum values (range [0,1..20])
  794. # that doxygen will group on one line in the generated HTML documentation.
  795. # Note that a value of 0 will completely suppress the enum values from
  796. # appearing in the overview section.
  797. ENUM_VALUES_PER_LINE = 4
  798. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  799. # structure should be generated to display hierarchical information.
  800. # If the tag value is set to YES, a side panel will be generated
  801. # containing a tree-like index structure (just like the one that
  802. # is generated for HTML Help). For this to work a browser that supports
  803. # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  804. # Windows users are probably better off using the HTML help feature.
  805. GENERATE_TREEVIEW = NO
  806. # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
  807. # and Class Hierarchy pages using a tree view instead of an ordered list.
  808. USE_INLINE_TREES = YES
  809. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  810. # used to set the initial width (in pixels) of the frame in which the tree
  811. # is shown.
  812. TREEVIEW_WIDTH = 250
  813. # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
  814. # links to external symbols imported via tag files in a separate window.
  815. EXT_LINKS_IN_WINDOW = NO
  816. # Use this tag to change the font size of Latex formulas included
  817. # as images in the HTML documentation. The default is 10. Note that
  818. # when you change the font size after a successful doxygen run you need
  819. # to manually remove any form_*.png images from the HTML output directory
  820. # to force them to be regenerated.
  821. FORMULA_FONTSIZE = 10
  822. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  823. # generated for formulas are transparent PNGs. Transparent PNGs are
  824. # not supported properly for IE 6.0, but are supported on all modern browsers.
  825. # Note that when changing this option you need to delete any form_*.png files
  826. # in the HTML output before the changes have effect.
  827. FORMULA_TRANSPARENT = YES
  828. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
  829. # (see http://www.mathjax.org) which uses client side Javascript for the
  830. # rendering instead of using prerendered bitmaps. Use this if you do not
  831. # have LaTeX installed or if you want to formulas look prettier in the HTML
  832. # output. When enabled you also need to install MathJax separately and
  833. # configure the path to it using the MATHJAX_RELPATH option.
  834. USE_MATHJAX = NO
  835. # When MathJax is enabled you need to specify the location relative to the
  836. # HTML output directory using the MATHJAX_RELPATH option. The destination
  837. # directory should contain the MathJax.js script. For instance, if the mathjax
  838. # directory is located at the same level as the HTML output directory, then
  839. # MATHJAX_RELPATH should be ../mathjax. The default value points to the
  840. # mathjax.org site, so you can quickly see the result without installing
  841. # MathJax, but it is strongly recommended to install a local copy of MathJax
  842. # before deployment.
  843. MATHJAX_RELPATH = http://www.mathjax.org/mathjax
  844. # When the SEARCHENGINE tag is enabled doxygen will generate a search box
  845. # for the HTML output. The underlying search engine uses javascript
  846. # and DHTML and should work on any modern browser. Note that when using
  847. # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
  848. # (GENERATE_DOCSET) there is already a search function so this one should
  849. # typically be disabled. For large projects the javascript based search engine
  850. # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
  851. SEARCHENGINE = YES
  852. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  853. # implemented using a PHP enabled web server instead of at the web client
  854. # using Javascript. Doxygen will generate the search PHP script and index
  855. # file to put on the web server. The advantage of the server
  856. # based approach is that it scales better to large projects and allows
  857. # full text search. The disadvantages are that it is more difficult to setup
  858. # and does not have live searching capabilities.
  859. SERVER_BASED_SEARCH = NO
  860. #---------------------------------------------------------------------------
  861. # configuration options related to the LaTeX output
  862. #---------------------------------------------------------------------------
  863. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  864. # generate Latex output.
  865. GENERATE_LATEX = NO
  866. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  867. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  868. # put in front of it. If left blank `latex' will be used as the default path.
  869. LATEX_OUTPUT = latex
  870. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  871. # invoked. If left blank `latex' will be used as the default command name.
  872. # Note that when enabling USE_PDFLATEX this option is only used for
  873. # generating bitmaps for formulas in the HTML output, but not in the
  874. # Makefile that is written to the output directory.
  875. LATEX_CMD_NAME = latex
  876. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  877. # generate index for LaTeX. If left blank `makeindex' will be used as the
  878. # default command name.
  879. MAKEINDEX_CMD_NAME = makeindex
  880. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  881. # LaTeX documents. This may be useful for small projects and may help to
  882. # save some trees in general.
  883. COMPACT_LATEX = NO
  884. # The PAPER_TYPE tag can be used to set the paper type that is used
  885. # by the printer. Possible values are: a4, letter, legal and
  886. # executive. If left blank a4wide will be used.
  887. PAPER_TYPE = a4
  888. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  889. # packages that should be included in the LaTeX output.
  890. EXTRA_PACKAGES =
  891. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  892. # the generated latex document. The header should contain everything until
  893. # the first chapter. If it is left blank doxygen will generate a
  894. # standard header. Notice: only use this tag if you know what you are doing!
  895. LATEX_HEADER =
  896. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  897. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  898. # contain links (just like the HTML output) instead of page references
  899. # This makes the output suitable for online browsing using a pdf viewer.
  900. PDF_HYPERLINKS = YES
  901. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  902. # plain latex in the generated Makefile. Set this option to YES to get a
  903. # higher quality PDF documentation.
  904. USE_PDFLATEX = YES
  905. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  906. # command to the generated LaTeX files. This will instruct LaTeX to keep
  907. # running if errors occur, instead of asking the user for help.
  908. # This option is also used when generating formulas in HTML.
  909. LATEX_BATCHMODE = NO
  910. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  911. # include the index chapters (such as File Index, Compound Index, etc.)
  912. # in the output.
  913. LATEX_HIDE_INDICES = NO
  914. # If LATEX_SOURCE_CODE is set to YES then doxygen will include
  915. # source code with syntax highlighting in the LaTeX output.
  916. # Note that which sources are shown also depends on other settings
  917. # such as SOURCE_BROWSER.
  918. LATEX_SOURCE_CODE = NO
  919. #---------------------------------------------------------------------------
  920. # configuration options related to the RTF output
  921. #---------------------------------------------------------------------------
  922. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  923. # The RTF output is optimized for Word 97 and may not look very pretty with
  924. # other RTF readers or editors.
  925. GENERATE_RTF = NO
  926. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  927. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  928. # put in front of it. If left blank `rtf' will be used as the default path.
  929. RTF_OUTPUT = rtf
  930. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  931. # RTF documents. This may be useful for small projects and may help to
  932. # save some trees in general.
  933. COMPACT_RTF = NO
  934. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  935. # will contain hyperlink fields. The RTF file will
  936. # contain links (just like the HTML output) instead of page references.
  937. # This makes the output suitable for online browsing using WORD or other
  938. # programs which support those fields.
  939. # Note: wordpad (write) and others do not support links.
  940. RTF_HYPERLINKS = NO
  941. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  942. # config file, i.e. a series of assignments. You only have to provide
  943. # replacements, missing definitions are set to their default value.
  944. RTF_STYLESHEET_FILE =
  945. # Set optional variables used in the generation of an rtf document.
  946. # Syntax is similar to doxygen's config file.
  947. RTF_EXTENSIONS_FILE =
  948. #---------------------------------------------------------------------------
  949. # configuration options related to the man page output
  950. #---------------------------------------------------------------------------
  951. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  952. # generate man pages
  953. GENERATE_MAN = NO
  954. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  955. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  956. # put in front of it. If left blank `man' will be used as the default path.
  957. MAN_OUTPUT = man
  958. # The MAN_EXTENSION tag determines the extension that is added to
  959. # the generated man pages (default is the subroutine's section .3)
  960. MAN_EXTENSION = .3
  961. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  962. # then it will generate one additional man file for each entity
  963. # documented in the real man page(s). These additional files
  964. # only source the real man page, but without them the man command
  965. # would be unable to find the correct page. The default is NO.
  966. MAN_LINKS = YES
  967. #---------------------------------------------------------------------------
  968. # configuration options related to the XML output
  969. #---------------------------------------------------------------------------
  970. # If the GENERATE_XML tag is set to YES Doxygen will
  971. # generate an XML file that captures the structure of
  972. # the code including all documentation.
  973. GENERATE_XML = NO
  974. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  975. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  976. # put in front of it. If left blank `xml' will be used as the default path.
  977. XML_OUTPUT = xml
  978. # The XML_SCHEMA tag can be used to specify an XML schema,
  979. # which can be used by a validating XML parser to check the
  980. # syntax of the XML files.
  981. XML_SCHEMA =
  982. # The XML_DTD tag can be used to specify an XML DTD,
  983. # which can be used by a validating XML parser to check the
  984. # syntax of the XML files.
  985. XML_DTD =
  986. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  987. # dump the program listings (including syntax highlighting
  988. # and cross-referencing information) to the XML output. Note that
  989. # enabling this will significantly increase the size of the XML output.
  990. XML_PROGRAMLISTING = YES
  991. #---------------------------------------------------------------------------
  992. # configuration options for the AutoGen Definitions output
  993. #---------------------------------------------------------------------------
  994. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  995. # generate an AutoGen Definitions (see autogen.sf.net) file
  996. # that captures the structure of the code including all
  997. # documentation. Note that this feature is still experimental
  998. # and incomplete at the moment.
  999. GENERATE_AUTOGEN_DEF = NO
  1000. #---------------------------------------------------------------------------
  1001. # configuration options related to the Perl module output
  1002. #---------------------------------------------------------------------------
  1003. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  1004. # generate a Perl module file that captures the structure of
  1005. # the code including all documentation. Note that this
  1006. # feature is still experimental and incomplete at the
  1007. # moment.
  1008. GENERATE_PERLMOD = NO
  1009. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  1010. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  1011. # to generate PDF and DVI output from the Perl module output.
  1012. PERLMOD_LATEX = NO
  1013. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  1014. # nicely formatted so it can be parsed by a human reader. This is useful
  1015. # if you want to understand what is going on. On the other hand, if this
  1016. # tag is set to NO the size of the Perl module output will be much smaller
  1017. # and Perl will parse it just the same.
  1018. PERLMOD_PRETTY = YES
  1019. # The names of the make variables in the generated doxyrules.make file
  1020. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  1021. # This is useful so different doxyrules.make files included by the same
  1022. # Makefile don't overwrite each other's variables.
  1023. PERLMOD_MAKEVAR_PREFIX =
  1024. #---------------------------------------------------------------------------
  1025. # Configuration options related to the preprocessor
  1026. #---------------------------------------------------------------------------
  1027. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  1028. # evaluate all C-preprocessor directives found in the sources and include
  1029. # files.
  1030. ENABLE_PREPROCESSING = YES
  1031. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  1032. # names in the source code. If set to NO (the default) only conditional
  1033. # compilation will be performed. Macro expansion can be done in a controlled
  1034. # way by setting EXPAND_ONLY_PREDEF to YES.
  1035. MACRO_EXPANSION = NO
  1036. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  1037. # then the macro expansion is limited to the macros specified with the
  1038. # PREDEFINED and EXPAND_AS_DEFINED tags.
  1039. EXPAND_ONLY_PREDEF = NO
  1040. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  1041. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  1042. SEARCH_INCLUDES = YES
  1043. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1044. # contain include files that are not input files but should be processed by
  1045. # the preprocessor.
  1046. INCLUDE_PATH =
  1047. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1048. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1049. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  1050. # be used.
  1051. INCLUDE_FILE_PATTERNS =
  1052. # The PREDEFINED tag can be used to specify one or more macro names that
  1053. # are defined before the preprocessor is started (similar to the -D option of
  1054. # gcc). The argument of the tag is a list of macros of the form: name
  1055. # or name=definition (no spaces). If the definition and the = are
  1056. # omitted =1 is assumed. To prevent a macro definition from being
  1057. # undefined via #undef or recursively expanded use the := operator
  1058. # instead of the = operator.
  1059. PREDEFINED =
  1060. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1061. # this tag can be used to specify a list of macro names that should be expanded.
  1062. # The macro definition that is found in the sources will be used.
  1063. # Use the PREDEFINED tag if you want to use a different macro definition that
  1064. # overrules the definition found in the source code.
  1065. EXPAND_AS_DEFINED =
  1066. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1067. # doxygen's preprocessor will remove all references to function-like macros
  1068. # that are alone on a line, have an all uppercase name, and do not end with a
  1069. # semicolon, because these will confuse the parser if not removed.
  1070. SKIP_FUNCTION_MACROS = YES
  1071. #---------------------------------------------------------------------------
  1072. # Configuration::additions related to external references
  1073. #---------------------------------------------------------------------------
  1074. # The TAGFILES option can be used to specify one or more tagfiles.
  1075. # Optionally an initial location of the external documentation
  1076. # can be added for each tagfile. The format of a tag file without
  1077. # this location is as follows:
  1078. # TAGFILES = file1 file2 ...
  1079. # Adding location for the tag files is done as follows:
  1080. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1081. # where "loc1" and "loc2" can be relative or absolute paths or
  1082. # URLs. If a location is present for each tag, the installdox tool
  1083. # does not have to be run to correct the links.
  1084. # Note that each tag file must have a unique name
  1085. # (where the name does NOT include the path)
  1086. # If a tag file is not located in the directory in which doxygen
  1087. # is run, you must also specify the path to the tagfile here.
  1088. TAGFILES =
  1089. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1090. # a tag file that is based on the input files it reads.
  1091. GENERATE_TAGFILE =
  1092. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1093. # in the class index. If set to NO only the inherited external classes
  1094. # will be listed.
  1095. ALLEXTERNALS = NO
  1096. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1097. # in the modules index. If set to NO, only the current project's groups will
  1098. # be listed.
  1099. EXTERNAL_GROUPS = YES
  1100. # The PERL_PATH should be the absolute path and name of the perl script
  1101. # interpreter (i.e. the result of `which perl').
  1102. PERL_PATH = /usr/bin/perl
  1103. #---------------------------------------------------------------------------
  1104. # Configuration options related to the dot tool
  1105. #---------------------------------------------------------------------------
  1106. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1107. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1108. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  1109. # this option also works with HAVE_DOT disabled, but it is recommended to
  1110. # install and use dot, since it yields more powerful graphs.
  1111. CLASS_DIAGRAMS = YES
  1112. # You can define message sequence charts within doxygen comments using the \msc
  1113. # command. Doxygen will then run the mscgen tool (see
  1114. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1115. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1116. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1117. # default search path.
  1118. MSCGEN_PATH =
  1119. # If set to YES, the inheritance and collaboration graphs will hide
  1120. # inheritance and usage relations if the target is undocumented
  1121. # or is not a class.
  1122. HIDE_UNDOC_RELATIONS = YES
  1123. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1124. # available from the path. This tool is part of Graphviz, a graph visualization
  1125. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1126. # have no effect if this option is set to NO (the default)
  1127. HAVE_DOT = NO
  1128. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
  1129. # allowed to run in parallel. When set to 0 (the default) doxygen will
  1130. # base this on the number of processors available in the system. You can set it
  1131. # explicitly to a value larger than 0 to get control over the balance
  1132. # between CPU load and processing speed.
  1133. DOT_NUM_THREADS = 0
  1134. # By default doxygen will write a font called Helvetica to the output
  1135. # directory and reference it in all dot files that doxygen generates.
  1136. # When you want a differently looking font you can specify the font name
  1137. # using DOT_FONTNAME. You need to make sure dot is able to find the font,
  1138. # which can be done by putting it in a standard location or by setting the
  1139. # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
  1140. # containing the font.
  1141. DOT_FONTNAME = Helvetica
  1142. # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1143. # The default size is 10pt.
  1144. DOT_FONTSIZE = 10
  1145. # By default doxygen will tell dot to use the output directory to look for the
  1146. # FreeSans.ttf font (which doxygen will put there itself). If you specify a
  1147. # different font using DOT_FONTNAME you can set the path where dot
  1148. # can find it using this tag.
  1149. DOT_FONTPATH =
  1150. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1151. # will generate a graph for each documented class showing the direct and
  1152. # indirect inheritance relations. Setting this tag to YES will force the
  1153. # the CLASS_DIAGRAMS tag to NO.
  1154. CLASS_GRAPH = YES
  1155. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1156. # will generate a graph for each documented class showing the direct and
  1157. # indirect implementation dependencies (inheritance, containment, and
  1158. # class references variables) of the class with other documented classes.
  1159. COLLABORATION_GRAPH = YES
  1160. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1161. # will generate a graph for groups, showing the direct groups dependencies
  1162. GROUP_GRAPHS = YES
  1163. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1164. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1165. # Language.
  1166. UML_LOOK = NO
  1167. # If set to YES, the inheritance and collaboration graphs will show the
  1168. # relations between templates and their instances.
  1169. TEMPLATE_RELATIONS = NO
  1170. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1171. # tags are set to YES then doxygen will generate a graph for each documented
  1172. # file showing the direct and indirect include dependencies of the file with
  1173. # other documented files.
  1174. INCLUDE_GRAPH = YES
  1175. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1176. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1177. # documented header file showing the documented files that directly or
  1178. # indirectly include this file.
  1179. INCLUDED_BY_GRAPH = YES
  1180. # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1181. # doxygen will generate a call dependency graph for every global function
  1182. # or class method. Note that enabling this option will significantly increase
  1183. # the time of a run. So in most cases it will be better to enable call graphs
  1184. # for selected functions only using the \callgraph command.
  1185. CALL_GRAPH = NO
  1186. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1187. # doxygen will generate a caller dependency graph for every global function
  1188. # or class method. Note that enabling this option will significantly increase
  1189. # the time of a run. So in most cases it will be better to enable caller
  1190. # graphs for selected functions only using the \callergraph command.
  1191. CALLER_GRAPH = NO
  1192. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1193. # will generate a graphical hierarchy of all classes instead of a textual one.
  1194. GRAPHICAL_HIERARCHY = YES
  1195. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  1196. # then doxygen will show the dependencies a directory has on other directories
  1197. # in a graphical way. The dependency relations are determined by the #include
  1198. # relations between the files in the directories.
  1199. DIRECTORY_GRAPH = YES
  1200. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1201. # generated by dot. Possible values are png, svg, gif or svg.
  1202. # If left blank png will be used.
  1203. DOT_IMAGE_FORMAT = png
  1204. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  1205. # found. If left blank, it is assumed the dot tool can be found in the path.
  1206. DOT_PATH =
  1207. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1208. # contain dot files that are included in the documentation (see the
  1209. # \dotfile command).
  1210. DOTFILE_DIRS =
  1211. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1212. # contain msc files that are included in the documentation (see the
  1213. # \mscfile command).
  1214. MSCFILE_DIRS =
  1215. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1216. # nodes that will be shown in the graph. If the number of nodes in a graph
  1217. # becomes larger than this value, doxygen will truncate the graph, which is
  1218. # visualized by representing a node as a red box. Note that doxygen if the
  1219. # number of direct children of the root node in a graph is already larger than
  1220. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1221. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1222. DOT_GRAPH_MAX_NODES = 50
  1223. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1224. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  1225. # from the root by following a path via at most 3 edges will be shown. Nodes
  1226. # that lay further from the root node will be omitted. Note that setting this
  1227. # option to 1 or 2 may greatly reduce the computation time needed for large
  1228. # code bases. Also note that the size of a graph can be further restricted by
  1229. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1230. MAX_DOT_GRAPH_DEPTH = 0
  1231. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1232. # background. This is disabled by default, because dot on Windows does not
  1233. # seem to support this out of the box. Warning: Depending on the platform used,
  1234. # enabling this option may lead to badly anti-aliased labels on the edges of
  1235. # a graph (i.e. they become hard to read).
  1236. DOT_TRANSPARENT = NO
  1237. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1238. # files in one run (i.e. multiple -o and -T options on the command line). This
  1239. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  1240. # support this, this feature is disabled by default.
  1241. DOT_MULTI_TARGETS = NO
  1242. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1243. # generate a legend page explaining the meaning of the various boxes and
  1244. # arrows in the dot generated graphs.
  1245. GENERATE_LEGEND = YES
  1246. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1247. # remove the intermediate dot files that are used to generate
  1248. # the various graphs.
  1249. DOT_CLEANUP = YES