Shared admin folder
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doxyfile.global 63KB

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