Doxyfile 75 KB

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