The Sol Programming Language!
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 103KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436
  1. # Doxyfile 1.8.9.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 double hash (##) is considered a comment and is placed in
  6. # front of the TAG it is preceding.
  7. #
  8. # All text after a single hash (#) is considered a comment and will be ignored.
  9. # The format is:
  10. # TAG = value [value, ...]
  11. # For lists, items can also be appended using:
  12. # TAG += value [value, ...]
  13. # Values that contain spaces should be placed between quotes (\" \").
  14. #---------------------------------------------------------------------------
  15. # Project related configuration options
  16. #---------------------------------------------------------------------------
  17. # This tag specifies the encoding used for all characters in the config file
  18. # that follow. The default is UTF-8 which is also the encoding used for all text
  19. # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  20. # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  21. # for the list of possible encodings.
  22. # The default value is: UTF-8.
  23. DOXYFILE_ENCODING = UTF-8
  24. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  25. # double-quotes, unless you are using Doxywizard) that should identify the
  26. # project for which the documentation is generated. This name is used in the
  27. # title of most generated pages and in a few other places.
  28. # The default value is: My Project.
  29. PROJECT_NAME = Sol
  30. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  31. # could be handy for archiving the generated documentation or if some version
  32. # control system is used.
  33. PROJECT_NUMBER = 0.2a0
  34. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  35. # for a project that appears at the top of each page and should give viewer a
  36. # quick idea about the purpose of the project. Keep the description short.
  37. PROJECT_BRIEF = "the Sol Programming Language"
  38. # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  39. # in the documentation. The maximum height of the logo should not exceed 55
  40. # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  41. # the logo to the output directory.
  42. PROJECT_LOGO =
  43. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  44. # into which the generated documentation will be written. If a relative path is
  45. # entered, it will be relative to the location where doxygen was started. If
  46. # left blank the current directory will be used.
  47. OUTPUT_DIRECTORY = doxyxml
  48. # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  49. # directories (in 2 levels) under the output directory of each output format and
  50. # will distribute the generated files over these directories. Enabling this
  51. # option can be useful when feeding doxygen a huge amount of source files, where
  52. # putting all generated files in the same directory would otherwise causes
  53. # performance problems for the file system.
  54. # The default value is: NO.
  55. CREATE_SUBDIRS = NO
  56. # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  57. # characters to appear in the names of generated files. If set to NO, non-ASCII
  58. # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  59. # U+3044.
  60. # The default value is: NO.
  61. ALLOW_UNICODE_NAMES = NO
  62. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  63. # documentation generated by doxygen is written. Doxygen will use this
  64. # information to generate all constant output in the proper language.
  65. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  66. # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  67. # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  68. # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  69. # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  70. # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  71. # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  72. # Ukrainian and Vietnamese.
  73. # The default value is: English.
  74. OUTPUT_LANGUAGE = English
  75. # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  76. # descriptions after the members that are listed in the file and class
  77. # documentation (similar to Javadoc). Set to NO to disable this.
  78. # The default value is: YES.
  79. BRIEF_MEMBER_DESC = YES
  80. # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  81. # description of a member or function before the detailed description
  82. #
  83. # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  84. # brief descriptions will be completely suppressed.
  85. # The default value is: YES.
  86. REPEAT_BRIEF = YES
  87. # This tag implements a quasi-intelligent brief description abbreviator that is
  88. # used to form the text in various listings. Each string in this list, if found
  89. # as the leading text of the brief description, will be stripped from the text
  90. # and the result, after processing the whole list, is used as the annotated
  91. # text. Otherwise, the brief description is used as-is. If left blank, the
  92. # following values are used ($name is automatically replaced with the name of
  93. # the entity):The $name class, The $name widget, The $name file, is, provides,
  94. # specifies, contains, represents, a, an and the.
  95. ABBREVIATE_BRIEF = "The $name class" \
  96. "The $name widget" \
  97. "The $name file" \
  98. is \
  99. provides \
  100. specifies \
  101. contains \
  102. represents \
  103. a \
  104. an \
  105. the
  106. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  107. # doxygen will generate a detailed section even if there is only a brief
  108. # description.
  109. # The default value is: NO.
  110. ALWAYS_DETAILED_SEC = NO
  111. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  112. # inherited members of a class in the documentation of that class as if those
  113. # members were ordinary class members. Constructors, destructors and assignment
  114. # operators of the base classes will not be shown.
  115. # The default value is: NO.
  116. INLINE_INHERITED_MEMB = NO
  117. # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  118. # before files name in the file list and in the header files. If set to NO the
  119. # shortest path that makes the file name unique will be used
  120. # The default value is: YES.
  121. FULL_PATH_NAMES = YES
  122. # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  123. # Stripping is only done if one of the specified strings matches the left-hand
  124. # part of the path. The tag can be used to show relative paths in the file list.
  125. # If left blank the directory from which doxygen is run is used as the path to
  126. # strip.
  127. #
  128. # Note that you can specify absolute paths here, but also relative paths, which
  129. # will be relative from the directory where doxygen is started.
  130. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  131. STRIP_FROM_PATH =
  132. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  133. # path mentioned in the documentation of a class, which tells the reader which
  134. # header file to include in order to use a class. If left blank only the name of
  135. # the header file containing the class definition is used. Otherwise one should
  136. # specify the list of include paths that are normally passed to the compiler
  137. # using the -I flag.
  138. STRIP_FROM_INC_PATH =
  139. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  140. # less readable) file names. This can be useful is your file systems doesn't
  141. # support long names like on DOS, Mac, or CD-ROM.
  142. # The default value is: NO.
  143. SHORT_NAMES = NO
  144. # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  145. # first line (until the first dot) of a Javadoc-style comment as the brief
  146. # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  147. # style comments (thus requiring an explicit @brief command for a brief
  148. # description.)
  149. # The default value is: NO.
  150. JAVADOC_AUTOBRIEF = NO
  151. # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  152. # line (until the first dot) of a Qt-style comment as the brief description. If
  153. # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  154. # requiring an explicit \brief command for a brief description.)
  155. # The default value is: NO.
  156. QT_AUTOBRIEF = NO
  157. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  158. # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  159. # a brief description. This used to be the default behavior. The new default is
  160. # to treat a multi-line C++ comment block as a detailed description. Set this
  161. # tag to YES if you prefer the old behavior instead.
  162. #
  163. # Note that setting this tag to YES also means that rational rose comments are
  164. # not recognized any more.
  165. # The default value is: NO.
  166. MULTILINE_CPP_IS_BRIEF = NO
  167. # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  168. # documentation from any documented member that it re-implements.
  169. # The default value is: YES.
  170. INHERIT_DOCS = YES
  171. # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  172. # page for each member. If set to NO, the documentation of a member will be part
  173. # of the file/class/namespace that contains it.
  174. # The default value is: NO.
  175. SEPARATE_MEMBER_PAGES = NO
  176. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  177. # uses this value to replace tabs by spaces in code fragments.
  178. # Minimum value: 1, maximum value: 16, default value: 4.
  179. TAB_SIZE = 4
  180. # This tag can be used to specify a number of aliases that act as commands in
  181. # the documentation. An alias has the form:
  182. # name=value
  183. # For example adding
  184. # "sideeffect=@par Side Effects:\n"
  185. # will allow you to put the command \sideeffect (or @sideeffect) in the
  186. # documentation, which will result in a user-defined paragraph with heading
  187. # "Side Effects:". You can put \n's in the value part of an alias to insert
  188. # newlines.
  189. ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
  190. endrst=\endverbatim
  191. # This tag can be used to specify a number of word-keyword mappings (TCL only).
  192. # A mapping has the form "name=value". For example adding "class=itcl::class"
  193. # will allow you to use the command class in the itcl::class meaning.
  194. TCL_SUBST =
  195. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  196. # only. Doxygen will then generate output that is more tailored for C. For
  197. # instance, some of the names that are used will be different. The list of all
  198. # members will be omitted, etc.
  199. # The default value is: NO.
  200. OPTIMIZE_OUTPUT_FOR_C = YES
  201. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  202. # Python sources only. Doxygen will then generate output that is more tailored
  203. # for that language. For instance, namespaces will be presented as packages,
  204. # qualified scopes will look different, etc.
  205. # The default value is: NO.
  206. OPTIMIZE_OUTPUT_JAVA = NO
  207. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  208. # sources. Doxygen will then generate output that is tailored for Fortran.
  209. # The default value is: NO.
  210. OPTIMIZE_FOR_FORTRAN = NO
  211. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  212. # sources. Doxygen will then generate output that is tailored for VHDL.
  213. # The default value is: NO.
  214. OPTIMIZE_OUTPUT_VHDL = NO
  215. # Doxygen selects the parser to use depending on the extension of the files it
  216. # parses. With this tag you can assign which parser to use for a given
  217. # extension. Doxygen has a built-in mapping, but you can override or extend it
  218. # using this tag. The format is ext=language, where ext is a file extension, and
  219. # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  220. # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  221. # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  222. # Fortran. In the later case the parser tries to guess whether the code is fixed
  223. # or free formatted code, this is the default for Fortran type files), VHDL. For
  224. # instance to make doxygen treat .inc files as Fortran files (default is PHP),
  225. # and .f files as C (default is Fortran), use: inc=Fortran f=C.
  226. #
  227. # Note: For files without extension you can use no_extension as a placeholder.
  228. #
  229. # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  230. # the files are not read by doxygen.
  231. EXTENSION_MAPPING =
  232. # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  233. # according to the Markdown format, which allows for more readable
  234. # documentation. See http://daringfireball.net/projects/markdown/ for details.
  235. # The output of markdown processing is further processed by doxygen, so you can
  236. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  237. # case of backward compatibilities issues.
  238. # The default value is: YES.
  239. MARKDOWN_SUPPORT = YES
  240. # When enabled doxygen tries to link words that correspond to documented
  241. # classes, or namespaces to their corresponding documentation. Such a link can
  242. # be prevented in individual cases by putting a % sign in front of the word or
  243. # globally by setting AUTOLINK_SUPPORT to NO.
  244. # The default value is: YES.
  245. AUTOLINK_SUPPORT = YES
  246. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  247. # to include (a tag file for) the STL sources as input, then you should set this
  248. # tag to YES in order to let doxygen match functions declarations and
  249. # definitions whose arguments contain STL classes (e.g. func(std::string);
  250. # versus func(std::string) {}). This also make the inheritance and collaboration
  251. # diagrams that involve STL classes more complete and accurate.
  252. # The default value is: NO.
  253. BUILTIN_STL_SUPPORT = NO
  254. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  255. # enable parsing support.
  256. # The default value is: NO.
  257. CPP_CLI_SUPPORT = NO
  258. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  259. # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  260. # will parse them like normal C++ but will assume all classes use public instead
  261. # of private inheritance when no explicit protection keyword is present.
  262. # The default value is: NO.
  263. SIP_SUPPORT = NO
  264. # For Microsoft's IDL there are propget and propput attributes to indicate
  265. # getter and setter methods for a property. Setting this option to YES will make
  266. # doxygen to replace the get and set methods by a property in the documentation.
  267. # This will only work if the methods are indeed getting or setting a simple
  268. # type. If this is not the case, or you want to show the methods anyway, you
  269. # should set this option to NO.
  270. # The default value is: YES.
  271. IDL_PROPERTY_SUPPORT = YES
  272. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  273. # tag is set to YES then doxygen will reuse the documentation of the first
  274. # member in the group (if any) for the other members of the group. By default
  275. # all members of a group must be documented explicitly.
  276. # The default value is: NO.
  277. DISTRIBUTE_GROUP_DOC = NO
  278. # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  279. # (for instance a group of public functions) to be put as a subgroup of that
  280. # type (e.g. under the Public Functions section). Set it to NO to prevent
  281. # subgrouping. Alternatively, this can be done per class using the
  282. # \nosubgrouping command.
  283. # The default value is: YES.
  284. SUBGROUPING = YES
  285. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  286. # are shown inside the group in which they are included (e.g. using \ingroup)
  287. # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  288. # and RTF).
  289. #
  290. # Note that this feature does not work in combination with
  291. # SEPARATE_MEMBER_PAGES.
  292. # The default value is: NO.
  293. INLINE_GROUPED_CLASSES = NO
  294. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  295. # with only public data fields or simple typedef fields will be shown inline in
  296. # the documentation of the scope in which they are defined (i.e. file,
  297. # namespace, or group documentation), provided this scope is documented. If set
  298. # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  299. # Man pages) or section (for LaTeX and RTF).
  300. # The default value is: NO.
  301. INLINE_SIMPLE_STRUCTS = NO
  302. # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  303. # enum is documented as struct, union, or enum with the name of the typedef. So
  304. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  305. # with name TypeT. When disabled the typedef will appear as a member of a file,
  306. # namespace, or class. And the struct will be named TypeS. This can typically be
  307. # useful for C code in case the coding convention dictates that all compound
  308. # types are typedef'ed and only the typedef is referenced, never the tag name.
  309. # The default value is: NO.
  310. TYPEDEF_HIDES_STRUCT = NO
  311. # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  312. # cache is used to resolve symbols given their name and scope. Since this can be
  313. # an expensive process and often the same symbol appears multiple times in the
  314. # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  315. # doxygen will become slower. If the cache is too large, memory is wasted. The
  316. # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  317. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  318. # symbols. At the end of a run doxygen will report the cache usage and suggest
  319. # the optimal cache size from a speed point of view.
  320. # Minimum value: 0, maximum value: 9, default value: 0.
  321. LOOKUP_CACHE_SIZE = 0
  322. #---------------------------------------------------------------------------
  323. # Build related configuration options
  324. #---------------------------------------------------------------------------
  325. # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  326. # documentation are documented, even if no documentation was available. Private
  327. # class members and static file members will be hidden unless the
  328. # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  329. # Note: This will also disable the warnings about undocumented members that are
  330. # normally produced when WARNINGS is set to YES.
  331. # The default value is: NO.
  332. EXTRACT_ALL = YES
  333. # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  334. # be included in the documentation.
  335. # The default value is: NO.
  336. EXTRACT_PRIVATE = NO
  337. # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  338. # scope will be included in the documentation.
  339. # The default value is: NO.
  340. EXTRACT_PACKAGE = NO
  341. # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  342. # included in the documentation.
  343. # The default value is: NO.
  344. EXTRACT_STATIC = NO
  345. # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  346. # locally in source files will be included in the documentation. If set to NO,
  347. # only classes defined in header files are included. Does not have any effect
  348. # for Java sources.
  349. # The default value is: YES.
  350. EXTRACT_LOCAL_CLASSES = YES
  351. # This flag is only useful for Objective-C code. If set to YES, local methods,
  352. # which are defined in the implementation section but not in the interface are
  353. # included in the documentation. If set to NO, only methods in the interface are
  354. # included.
  355. # The default value is: NO.
  356. EXTRACT_LOCAL_METHODS = NO
  357. # If this flag is set to YES, the members of anonymous namespaces will be
  358. # extracted and appear in the documentation as a namespace called
  359. # 'anonymous_namespace{file}', where file will be replaced with the base name of
  360. # the file that contains the anonymous namespace. By default anonymous namespace
  361. # are hidden.
  362. # The default value is: NO.
  363. EXTRACT_ANON_NSPACES = NO
  364. # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  365. # undocumented members inside documented classes or files. If set to NO these
  366. # members will be included in the various overviews, but no documentation
  367. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  368. # The default value is: NO.
  369. HIDE_UNDOC_MEMBERS = NO
  370. # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  371. # undocumented classes that are normally visible in the class hierarchy. If set
  372. # to NO, these classes will be included in the various overviews. This option
  373. # has no effect if EXTRACT_ALL is enabled.
  374. # The default value is: NO.
  375. HIDE_UNDOC_CLASSES = NO
  376. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  377. # (class|struct|union) declarations. If set to NO, these declarations will be
  378. # included in the documentation.
  379. # The default value is: NO.
  380. HIDE_FRIEND_COMPOUNDS = NO
  381. # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  382. # documentation blocks found inside the body of a function. If set to NO, these
  383. # blocks will be appended to the function's detailed documentation block.
  384. # The default value is: NO.
  385. HIDE_IN_BODY_DOCS = NO
  386. # The INTERNAL_DOCS tag determines if documentation that is typed after a
  387. # \internal command is included. If the tag is set to NO then the documentation
  388. # will be excluded. Set it to YES to include the internal documentation.
  389. # The default value is: NO.
  390. INTERNAL_DOCS = NO
  391. # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  392. # names in lower-case letters. If set to YES, upper-case letters are also
  393. # allowed. This is useful if you have classes or files whose names only differ
  394. # in case and if your file system supports case sensitive file names. Windows
  395. # and Mac users are advised to set this option to NO.
  396. # The default value is: system dependent.
  397. CASE_SENSE_NAMES = NO
  398. # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  399. # their full class and namespace scopes in the documentation. If set to YES, the
  400. # scope will be hidden.
  401. # The default value is: NO.
  402. HIDE_SCOPE_NAMES = YES
  403. # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  404. # append additional text to a page's title, such as Class Reference. If set to
  405. # YES the compound reference will be hidden.
  406. # The default value is: NO.
  407. HIDE_COMPOUND_REFERENCE= NO
  408. # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  409. # the files that are included by a file in the documentation of that file.
  410. # The default value is: YES.
  411. SHOW_INCLUDE_FILES = YES
  412. # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  413. # grouped member an include statement to the documentation, telling the reader
  414. # which file to include in order to use the member.
  415. # The default value is: NO.
  416. SHOW_GROUPED_MEMB_INC = NO
  417. # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  418. # files with double quotes in the documentation rather than with sharp brackets.
  419. # The default value is: NO.
  420. FORCE_LOCAL_INCLUDES = NO
  421. # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  422. # documentation for inline members.
  423. # The default value is: YES.
  424. INLINE_INFO = YES
  425. # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  426. # (detailed) documentation of file and class members alphabetically by member
  427. # name. If set to NO, the members will appear in declaration order.
  428. # The default value is: YES.
  429. SORT_MEMBER_DOCS = YES
  430. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  431. # descriptions of file, namespace and class members alphabetically by member
  432. # name. If set to NO, the members will appear in declaration order. Note that
  433. # this will also influence the order of the classes in the class list.
  434. # The default value is: NO.
  435. SORT_BRIEF_DOCS = NO
  436. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  437. # (brief and detailed) documentation of class members so that constructors and
  438. # destructors are listed first. If set to NO the constructors will appear in the
  439. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  440. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  441. # member documentation.
  442. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  443. # detailed member documentation.
  444. # The default value is: NO.
  445. SORT_MEMBERS_CTORS_1ST = NO
  446. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  447. # of group names into alphabetical order. If set to NO the group names will
  448. # appear in their defined order.
  449. # The default value is: NO.
  450. SORT_GROUP_NAMES = NO
  451. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  452. # fully-qualified names, including namespaces. If set to NO, the class list will
  453. # be sorted only by class name, not including the namespace part.
  454. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  455. # Note: This option applies only to the class list, not to the alphabetical
  456. # list.
  457. # The default value is: NO.
  458. SORT_BY_SCOPE_NAME = NO
  459. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  460. # type resolution of all parameters of a function it will reject a match between
  461. # the prototype and the implementation of a member function even if there is
  462. # only one candidate or it is obvious which candidate to choose by doing a
  463. # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  464. # accept a match between prototype and implementation in such cases.
  465. # The default value is: NO.
  466. STRICT_PROTO_MATCHING = NO
  467. # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  468. # list. This list is created by putting \todo commands in the documentation.
  469. # The default value is: YES.
  470. GENERATE_TODOLIST = YES
  471. # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  472. # list. This list is created by putting \test commands in the documentation.
  473. # The default value is: YES.
  474. GENERATE_TESTLIST = YES
  475. # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  476. # list. This list is created by putting \bug commands in the documentation.
  477. # The default value is: YES.
  478. GENERATE_BUGLIST = YES
  479. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  480. # the deprecated list. This list is created by putting \deprecated commands in
  481. # the documentation.
  482. # The default value is: YES.
  483. GENERATE_DEPRECATEDLIST= YES
  484. # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  485. # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  486. # ... \endcond blocks.
  487. ENABLED_SECTIONS =
  488. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  489. # initial value of a variable or macro / define can have for it to appear in the
  490. # documentation. If the initializer consists of more lines than specified here
  491. # it will be hidden. Use a value of 0 to hide initializers completely. The
  492. # appearance of the value of individual variables and macros / defines can be
  493. # controlled using \showinitializer or \hideinitializer command in the
  494. # documentation regardless of this setting.
  495. # Minimum value: 0, maximum value: 10000, default value: 30.
  496. MAX_INITIALIZER_LINES = 30
  497. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  498. # the bottom of the documentation of classes and structs. If set to YES, the
  499. # list will mention the files that were used to generate the documentation.
  500. # The default value is: YES.
  501. SHOW_USED_FILES = YES
  502. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  503. # will remove the Files entry from the Quick Index and from the Folder Tree View
  504. # (if specified).
  505. # The default value is: YES.
  506. SHOW_FILES = YES
  507. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  508. # page. This will remove the Namespaces entry from the Quick Index and from the
  509. # Folder Tree View (if specified).
  510. # The default value is: YES.
  511. SHOW_NAMESPACES = YES
  512. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  513. # doxygen should invoke to get the current version for each file (typically from
  514. # the version control system). Doxygen will invoke the program by executing (via
  515. # popen()) the command command input-file, where command is the value of the
  516. # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  517. # by doxygen. Whatever the program writes to standard output is used as the file
  518. # version. For an example see the documentation.
  519. FILE_VERSION_FILTER =
  520. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  521. # by doxygen. The layout file controls the global structure of the generated
  522. # output files in an output format independent way. To create the layout file
  523. # that represents doxygen's defaults, run doxygen with the -l option. You can
  524. # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  525. # will be used as the name of the layout file.
  526. #
  527. # Note that if you run doxygen from a directory containing a file called
  528. # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  529. # tag is left empty.
  530. LAYOUT_FILE =
  531. # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  532. # the reference definitions. This must be a list of .bib files. The .bib
  533. # extension is automatically appended if omitted. This requires the bibtex tool
  534. # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  535. # For LaTeX the style of the bibliography can be controlled using
  536. # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  537. # search path. See also \cite for info how to create references.
  538. CITE_BIB_FILES =
  539. #---------------------------------------------------------------------------
  540. # Configuration options related to warning and progress messages
  541. #---------------------------------------------------------------------------
  542. # The QUIET tag can be used to turn on/off the messages that are generated to
  543. # standard output by doxygen. If QUIET is set to YES this implies that the
  544. # messages are off.
  545. # The default value is: NO.
  546. QUIET = NO
  547. # The WARNINGS tag can be used to turn on/off the warning messages that are
  548. # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  549. # this implies that the warnings are on.
  550. #
  551. # Tip: Turn warnings on while writing the documentation.
  552. # The default value is: YES.
  553. WARNINGS = YES
  554. # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  555. # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  556. # will automatically be disabled.
  557. # The default value is: YES.
  558. WARN_IF_UNDOCUMENTED = YES
  559. # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  560. # potential errors in the documentation, such as not documenting some parameters
  561. # in a documented function, or documenting parameters that don't exist or using
  562. # markup commands wrongly.
  563. # The default value is: YES.
  564. WARN_IF_DOC_ERROR = YES
  565. # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  566. # are documented, but have no documentation for their parameters or return
  567. # value. If set to NO, doxygen will only warn about wrong or incomplete
  568. # parameter documentation, but not about the absence of documentation.
  569. # The default value is: NO.
  570. WARN_NO_PARAMDOC = NO
  571. # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  572. # can produce. The string should contain the $file, $line, and $text tags, which
  573. # will be replaced by the file and line number from which the warning originated
  574. # and the warning text. Optionally the format may contain $version, which will
  575. # be replaced by the version of the file (if it could be obtained via
  576. # FILE_VERSION_FILTER)
  577. # The default value is: $file:$line: $text.
  578. WARN_FORMAT = "$file:$line: $text"
  579. # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  580. # messages should be written. If left blank the output is written to standard
  581. # error (stderr).
  582. WARN_LOGFILE =
  583. #---------------------------------------------------------------------------
  584. # Configuration options related to the input files
  585. #---------------------------------------------------------------------------
  586. # The INPUT tag is used to specify the files and/or directories that contain
  587. # documented source files. You may enter file names like myfile.cpp or
  588. # directories like /usr/src/myproject. Separate the files or directories with
  589. # spaces.
  590. # Note: If this tag is empty the current directory is searched.
  591. INPUT =
  592. # This tag can be used to specify the character encoding of the source files
  593. # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  594. # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  595. # documentation (see: http://www.gnu.org/software/libiconv) for the list of
  596. # possible encodings.
  597. # The default value is: UTF-8.
  598. INPUT_ENCODING = UTF-8
  599. # If the value of the INPUT tag contains directories, you can use the
  600. # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  601. # *.h) to filter out the source-files in the directories. If left blank the
  602. # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
  603. # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
  604. # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
  605. # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
  606. # *.qsf, *.as and *.js.
  607. FILE_PATTERNS = *.c \
  608. *.cc \
  609. *.cxx \
  610. *.cpp \
  611. *.c++ \
  612. *.java \
  613. *.ii \
  614. *.ixx \
  615. *.ipp \
  616. *.i++ \
  617. *.inl \
  618. *.idl \
  619. *.ddl \
  620. *.odl \
  621. *.h \
  622. *.hh \
  623. *.hxx \
  624. *.hpp \
  625. *.h++ \
  626. *.cs \
  627. *.d \
  628. *.php \
  629. *.php4 \
  630. *.php5 \
  631. *.phtml \
  632. *.inc \
  633. *.m \
  634. *.markdown \
  635. *.md \
  636. *.mm \
  637. *.dox \
  638. *.py \
  639. *.f90 \
  640. *.f \
  641. *.for \
  642. *.tcl \
  643. *.vhd \
  644. *.vhdl \
  645. *.ucf \
  646. *.qsf \
  647. *.as \
  648. *.js
  649. # The RECURSIVE tag can be used to specify whether or not subdirectories should
  650. # be searched for input files as well.
  651. # The default value is: NO.
  652. RECURSIVE = NO
  653. # The EXCLUDE tag can be used to specify files and/or directories that should be
  654. # excluded from the INPUT source files. This way you can easily exclude a
  655. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  656. #
  657. # Note that relative paths are relative to the directory from which doxygen is
  658. # run.
  659. EXCLUDE =
  660. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  661. # directories that are symbolic links (a Unix file system feature) are excluded
  662. # from the input.
  663. # The default value is: NO.
  664. EXCLUDE_SYMLINKS = NO
  665. # If the value of the INPUT tag contains directories, you can use the
  666. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  667. # certain files from those directories.
  668. #
  669. # Note that the wildcards are matched against the file with absolute path, so to
  670. # exclude all test directories for example use the pattern */test/*
  671. EXCLUDE_PATTERNS =
  672. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  673. # (namespaces, classes, functions, etc.) that should be excluded from the
  674. # output. The symbol name can be a fully qualified name, a word, or if the
  675. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  676. # AClass::ANamespace, ANamespace::*Test
  677. #
  678. # Note that the wildcards are matched against the file with absolute path, so to
  679. # exclude all test directories use the pattern */test/*
  680. EXCLUDE_SYMBOLS =
  681. # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  682. # that contain example code fragments that are included (see the \include
  683. # command).
  684. EXAMPLE_PATH =
  685. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  686. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  687. # *.h) to filter out the source-files in the directories. If left blank all
  688. # files are included.
  689. EXAMPLE_PATTERNS = *
  690. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  691. # searched for input files to be used with the \include or \dontinclude commands
  692. # irrespective of the value of the RECURSIVE tag.
  693. # The default value is: NO.
  694. EXAMPLE_RECURSIVE = NO
  695. # The IMAGE_PATH tag can be used to specify one or more files or directories
  696. # that contain images that are to be included in the documentation (see the
  697. # \image command).
  698. IMAGE_PATH =
  699. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  700. # invoke to filter for each input file. Doxygen will invoke the filter program
  701. # by executing (via popen()) the command:
  702. #
  703. # <filter> <input-file>
  704. #
  705. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  706. # name of an input file. Doxygen will then use the output that the filter
  707. # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  708. # will be ignored.
  709. #
  710. # Note that the filter must not add or remove lines; it is applied before the
  711. # code is scanned, but not when the output code is generated. If lines are added
  712. # or removed, the anchors will not be placed correctly.
  713. INPUT_FILTER =
  714. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  715. # basis. Doxygen will compare the file name with each pattern and apply the
  716. # filter if there is a match. The filters are a list of the form: pattern=filter
  717. # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  718. # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  719. # patterns match the file name, INPUT_FILTER is applied.
  720. FILTER_PATTERNS =
  721. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  722. # INPUT_FILTER) will also be used to filter the input files that are used for
  723. # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  724. # The default value is: NO.
  725. FILTER_SOURCE_FILES = NO
  726. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  727. # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  728. # it is also possible to disable source filtering for a specific pattern using
  729. # *.ext= (so without naming a filter).
  730. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  731. FILTER_SOURCE_PATTERNS =
  732. # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  733. # is part of the input, its contents will be placed on the main page
  734. # (index.html). This can be useful if you have a project on for instance GitHub
  735. # and want to reuse the introduction page also for the doxygen output.
  736. USE_MDFILE_AS_MAINPAGE =
  737. #---------------------------------------------------------------------------
  738. # Configuration options related to source browsing
  739. #---------------------------------------------------------------------------
  740. # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  741. # generated. Documented entities will be cross-referenced with these sources.
  742. #
  743. # Note: To get rid of all source code in the generated output, make sure that
  744. # also VERBATIM_HEADERS is set to NO.
  745. # The default value is: NO.
  746. SOURCE_BROWSER = NO
  747. # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  748. # classes and enums directly into the documentation.
  749. # The default value is: NO.
  750. INLINE_SOURCES = NO
  751. # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  752. # special comment blocks from generated source code fragments. Normal C, C++ and
  753. # Fortran comments will always remain visible.
  754. # The default value is: YES.
  755. STRIP_CODE_COMMENTS = YES
  756. # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  757. # function all documented functions referencing it will be listed.
  758. # The default value is: NO.
  759. REFERENCED_BY_RELATION = NO
  760. # If the REFERENCES_RELATION tag is set to YES then for each documented function
  761. # all documented entities called/used by that function will be listed.
  762. # The default value is: NO.
  763. REFERENCES_RELATION = NO
  764. # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  765. # to YES then the hyperlinks from functions in REFERENCES_RELATION and
  766. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  767. # link to the documentation.
  768. # The default value is: YES.
  769. REFERENCES_LINK_SOURCE = YES
  770. # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  771. # source code will show a tooltip with additional information such as prototype,
  772. # brief description and links to the definition and documentation. Since this
  773. # will make the HTML file larger and loading of large files a bit slower, you
  774. # can opt to disable this feature.
  775. # The default value is: YES.
  776. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  777. SOURCE_TOOLTIPS = YES
  778. # If the USE_HTAGS tag is set to YES then the references to source code will
  779. # point to the HTML generated by the htags(1) tool instead of doxygen built-in
  780. # source browser. The htags tool is part of GNU's global source tagging system
  781. # (see http://www.gnu.org/software/global/global.html). You will need version
  782. # 4.8.6 or higher.
  783. #
  784. # To use it do the following:
  785. # - Install the latest version of global
  786. # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  787. # - Make sure the INPUT points to the root of the source tree
  788. # - Run doxygen as normal
  789. #
  790. # Doxygen will invoke htags (and that will in turn invoke gtags), so these
  791. # tools must be available from the command line (i.e. in the search path).
  792. #
  793. # The result: instead of the source browser generated by doxygen, the links to
  794. # source code will now point to the output of htags.
  795. # The default value is: NO.
  796. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  797. USE_HTAGS = NO
  798. # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  799. # verbatim copy of the header file for each class for which an include is
  800. # specified. Set to NO to disable this.
  801. # See also: Section \class.
  802. # The default value is: YES.
  803. VERBATIM_HEADERS = YES
  804. # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  805. # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
  806. # cost of reduced performance. This can be particularly helpful with template
  807. # rich C++ code for which doxygen's built-in parser lacks the necessary type
  808. # information.
  809. # Note: The availability of this option depends on whether or not doxygen was
  810. # compiled with the --with-libclang option.
  811. # The default value is: NO.
  812. CLANG_ASSISTED_PARSING = NO
  813. # If clang assisted parsing is enabled you can provide the compiler with command
  814. # line options that you would normally use when invoking the compiler. Note that
  815. # the include paths will already be set by doxygen for the files and directories
  816. # specified with INPUT and INCLUDE_PATH.
  817. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  818. CLANG_OPTIONS =
  819. #---------------------------------------------------------------------------
  820. # Configuration options related to the alphabetical class index
  821. #---------------------------------------------------------------------------
  822. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  823. # compounds will be generated. Enable this if the project contains a lot of
  824. # classes, structs, unions or interfaces.
  825. # The default value is: YES.
  826. ALPHABETICAL_INDEX = YES
  827. # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  828. # which the alphabetical index list will be split.
  829. # Minimum value: 1, maximum value: 20, default value: 5.
  830. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  831. COLS_IN_ALPHA_INDEX = 5
  832. # In case all classes in a project start with a common prefix, all classes will
  833. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  834. # can be used to specify a prefix (or a list of prefixes) that should be ignored
  835. # while generating the index headers.
  836. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  837. IGNORE_PREFIX =
  838. #---------------------------------------------------------------------------
  839. # Configuration options related to the HTML output
  840. #---------------------------------------------------------------------------
  841. # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  842. # The default value is: YES.
  843. GENERATE_HTML = NO
  844. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  845. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  846. # it.
  847. # The default directory is: html.
  848. # This tag requires that the tag GENERATE_HTML is set to YES.
  849. HTML_OUTPUT = html
  850. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  851. # generated HTML page (for example: .htm, .php, .asp).
  852. # The default value is: .html.
  853. # This tag requires that the tag GENERATE_HTML is set to YES.
  854. HTML_FILE_EXTENSION = .html
  855. # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  856. # each generated HTML page. If the tag is left blank doxygen will generate a
  857. # standard header.
  858. #
  859. # To get valid HTML the header file that includes any scripts and style sheets
  860. # that doxygen needs, which is dependent on the configuration options used (e.g.
  861. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  862. # default header using
  863. # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  864. # YourConfigFile
  865. # and then modify the file new_header.html. See also section "Doxygen usage"
  866. # for information on how to generate the default header that doxygen normally
  867. # uses.
  868. # Note: The header is subject to change so you typically have to regenerate the
  869. # default header when upgrading to a newer version of doxygen. For a description
  870. # of the possible markers and block names see the documentation.
  871. # This tag requires that the tag GENERATE_HTML is set to YES.
  872. HTML_HEADER =
  873. # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  874. # generated HTML page. If the tag is left blank doxygen will generate a standard
  875. # footer. See HTML_HEADER for more information on how to generate a default
  876. # footer and what special commands can be used inside the footer. See also
  877. # section "Doxygen usage" for information on how to generate the default footer
  878. # that doxygen normally uses.
  879. # This tag requires that the tag GENERATE_HTML is set to YES.
  880. HTML_FOOTER =
  881. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  882. # sheet that is used by each HTML page. It can be used to fine-tune the look of
  883. # the HTML output. If left blank doxygen will generate a default style sheet.
  884. # See also section "Doxygen usage" for information on how to generate the style
  885. # sheet that doxygen normally uses.
  886. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  887. # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  888. # obsolete.
  889. # This tag requires that the tag GENERATE_HTML is set to YES.
  890. HTML_STYLESHEET =
  891. # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  892. # cascading style sheets that are included after the standard style sheets
  893. # created by doxygen. Using this option one can overrule certain style aspects.
  894. # This is preferred over using HTML_STYLESHEET since it does not replace the
  895. # standard style sheet and is therefore more robust against future updates.
  896. # Doxygen will copy the style sheet files to the output directory.
  897. # Note: The order of the extra style sheet files is of importance (e.g. the last
  898. # style sheet in the list overrules the setting of the previous ones in the
  899. # list). For an example see the documentation.
  900. # This tag requires that the tag GENERATE_HTML is set to YES.
  901. HTML_EXTRA_STYLESHEET =
  902. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  903. # other source files which should be copied to the HTML output directory. Note
  904. # that these files will be copied to the base HTML output directory. Use the
  905. # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  906. # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  907. # files will be copied as-is; there are no commands or markers available.
  908. # This tag requires that the tag GENERATE_HTML is set to YES.
  909. HTML_EXTRA_FILES =
  910. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  911. # will adjust the colors in the style sheet and background images according to
  912. # this color. Hue is specified as an angle on a colorwheel, see
  913. # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  914. # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  915. # purple, and 360 is red again.
  916. # Minimum value: 0, maximum value: 359, default value: 220.
  917. # This tag requires that the tag GENERATE_HTML is set to YES.
  918. HTML_COLORSTYLE_HUE = 220
  919. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  920. # in the HTML output. For a value of 0 the output will use grayscales only. A
  921. # value of 255 will produce the most vivid colors.
  922. # Minimum value: 0, maximum value: 255, default value: 100.
  923. # This tag requires that the tag GENERATE_HTML is set to YES.
  924. HTML_COLORSTYLE_SAT = 100
  925. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  926. # luminance component of the colors in the HTML output. Values below 100
  927. # gradually make the output lighter, whereas values above 100 make the output
  928. # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  929. # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  930. # change the gamma.
  931. # Minimum value: 40, maximum value: 240, default value: 80.
  932. # This tag requires that the tag GENERATE_HTML is set to YES.
  933. HTML_COLORSTYLE_GAMMA = 80
  934. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  935. # page will contain the date and time when the page was generated. Setting this
  936. # to YES can help to show when doxygen was last run and thus if the
  937. # documentation is up to date.
  938. # The default value is: NO.
  939. # This tag requires that the tag GENERATE_HTML is set to YES.
  940. HTML_TIMESTAMP = YES
  941. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  942. # documentation will contain sections that can be hidden and shown after the
  943. # page has loaded.
  944. # The default value is: NO.
  945. # This tag requires that the tag GENERATE_HTML is set to YES.
  946. HTML_DYNAMIC_SECTIONS = NO
  947. # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  948. # shown in the various tree structured indices initially; the user can expand
  949. # and collapse entries dynamically later on. Doxygen will expand the tree to
  950. # such a level that at most the specified number of entries are visible (unless
  951. # a fully collapsed tree already exceeds this amount). So setting the number of
  952. # entries 1 will produce a full collapsed tree by default. 0 is a special value
  953. # representing an infinite number of entries and will result in a full expanded
  954. # tree by default.
  955. # Minimum value: 0, maximum value: 9999, default value: 100.
  956. # This tag requires that the tag GENERATE_HTML is set to YES.
  957. HTML_INDEX_NUM_ENTRIES = 100
  958. # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  959. # generated that can be used as input for Apple's Xcode 3 integrated development
  960. # environment (see: http://developer.apple.com/tools/xcode/), introduced with
  961. # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  962. # Makefile in the HTML output directory. Running make will produce the docset in
  963. # that directory and running make install will install the docset in
  964. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  965. # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  966. # for more information.
  967. # The default value is: NO.
  968. # This tag requires that the tag GENERATE_HTML is set to YES.
  969. GENERATE_DOCSET = NO
  970. # This tag determines the name of the docset feed. A documentation feed provides
  971. # an umbrella under which multiple documentation sets from a single provider
  972. # (such as a company or product suite) can be grouped.
  973. # The default value is: Doxygen generated docs.
  974. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  975. DOCSET_FEEDNAME = "Doxygen generated docs"
  976. # This tag specifies a string that should uniquely identify the documentation
  977. # set bundle. This should be a reverse domain-name style string, e.g.
  978. # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  979. # The default value is: org.doxygen.Project.
  980. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  981. DOCSET_BUNDLE_ID = org.doxygen.Project
  982. # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  983. # the documentation publisher. This should be a reverse domain-name style
  984. # string, e.g. com.mycompany.MyDocSet.documentation.
  985. # The default value is: org.doxygen.Publisher.
  986. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  987. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  988. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  989. # The default value is: Publisher.
  990. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  991. DOCSET_PUBLISHER_NAME = Publisher
  992. # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  993. # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  994. # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  995. # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  996. # Windows.
  997. #
  998. # The HTML Help Workshop contains a compiler that can convert all HTML output
  999. # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1000. # files are now used as the Windows 98 help format, and will replace the old
  1001. # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1002. # HTML files also contain an index, a table of contents, and you can search for
  1003. # words in the documentation. The HTML workshop also contains a viewer for
  1004. # compressed HTML files.
  1005. # The default value is: NO.
  1006. # This tag requires that the tag GENERATE_HTML is set to YES.
  1007. GENERATE_HTMLHELP = NO
  1008. # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1009. # file. You can add a path in front of the file if the result should not be
  1010. # written to the html output directory.
  1011. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1012. CHM_FILE =
  1013. # The HHC_LOCATION tag can be used to specify the location (absolute path
  1014. # including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1015. # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1016. # The file has to be specified with full path.
  1017. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1018. HHC_LOCATION =
  1019. # The GENERATE_CHI flag controls if a separate .chi index file is generated
  1020. # (YES) or that it should be included in the master .chm file (NO).
  1021. # The default value is: NO.
  1022. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1023. GENERATE_CHI = NO
  1024. # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1025. # and project file content.
  1026. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1027. CHM_INDEX_ENCODING =
  1028. # The BINARY_TOC flag controls whether a binary table of contents is generated
  1029. # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1030. # enables the Previous and Next buttons.
  1031. # The default value is: NO.
  1032. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1033. BINARY_TOC = NO
  1034. # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1035. # the table of contents of the HTML help documentation and to the tree view.
  1036. # The default value is: NO.
  1037. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1038. TOC_EXPAND = NO
  1039. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1040. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1041. # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1042. # (.qch) of the generated HTML documentation.
  1043. # The default value is: NO.
  1044. # This tag requires that the tag GENERATE_HTML is set to YES.
  1045. GENERATE_QHP = NO
  1046. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1047. # the file name of the resulting .qch file. The path specified is relative to
  1048. # the HTML output folder.
  1049. # This tag requires that the tag GENERATE_QHP is set to YES.
  1050. QCH_FILE =
  1051. # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1052. # Project output. For more information please see Qt Help Project / Namespace
  1053. # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1054. # The default value is: org.doxygen.Project.
  1055. # This tag requires that the tag GENERATE_QHP is set to YES.
  1056. QHP_NAMESPACE = org.doxygen.Project
  1057. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1058. # Help Project output. For more information please see Qt Help Project / Virtual
  1059. # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1060. # folders).
  1061. # The default value is: doc.
  1062. # This tag requires that the tag GENERATE_QHP is set to YES.
  1063. QHP_VIRTUAL_FOLDER = doc
  1064. # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1065. # filter to add. For more information please see Qt Help Project / Custom
  1066. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1067. # filters).
  1068. # This tag requires that the tag GENERATE_QHP is set to YES.
  1069. QHP_CUST_FILTER_NAME =
  1070. # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1071. # custom filter to add. For more information please see Qt Help Project / Custom
  1072. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1073. # filters).
  1074. # This tag requires that the tag GENERATE_QHP is set to YES.
  1075. QHP_CUST_FILTER_ATTRS =
  1076. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1077. # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1078. # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1079. # This tag requires that the tag GENERATE_QHP is set to YES.
  1080. QHP_SECT_FILTER_ATTRS =
  1081. # The QHG_LOCATION tag can be used to specify the location of Qt's
  1082. # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1083. # generated .qhp file.
  1084. # This tag requires that the tag GENERATE_QHP is set to YES.
  1085. QHG_LOCATION =
  1086. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1087. # generated, together with the HTML files, they form an Eclipse help plugin. To
  1088. # install this plugin and make it available under the help contents menu in
  1089. # Eclipse, the contents of the directory containing the HTML and XML files needs
  1090. # to be copied into the plugins directory of eclipse. The name of the directory
  1091. # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1092. # After copying Eclipse needs to be restarted before the help appears.
  1093. # The default value is: NO.
  1094. # This tag requires that the tag GENERATE_HTML is set to YES.
  1095. GENERATE_ECLIPSEHELP = NO
  1096. # A unique identifier for the Eclipse help plugin. When installing the plugin
  1097. # the directory name containing the HTML and XML files should also have this
  1098. # name. Each documentation set should have its own identifier.
  1099. # The default value is: org.doxygen.Project.
  1100. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1101. ECLIPSE_DOC_ID = org.doxygen.Project
  1102. # If you want full control over the layout of the generated HTML pages it might
  1103. # be necessary to disable the index and replace it with your own. The
  1104. # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1105. # of each HTML page. A value of NO enables the index and the value YES disables
  1106. # it. Since the tabs in the index contain the same information as the navigation
  1107. # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1108. # The default value is: NO.
  1109. # This tag requires that the tag GENERATE_HTML is set to YES.
  1110. DISABLE_INDEX = NO
  1111. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1112. # structure should be generated to display hierarchical information. If the tag
  1113. # value is set to YES, a side panel will be generated containing a tree-like
  1114. # index structure (just like the one that is generated for HTML Help). For this
  1115. # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1116. # (i.e. any modern browser). Windows users are probably better off using the
  1117. # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1118. # further fine-tune the look of the index. As an example, the default style
  1119. # sheet generated by doxygen has an example that shows how to put an image at
  1120. # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1121. # the same information as the tab index, you could consider setting
  1122. # DISABLE_INDEX to YES when enabling this option.
  1123. # The default value is: NO.
  1124. # This tag requires that the tag GENERATE_HTML is set to YES.
  1125. GENERATE_TREEVIEW = NO
  1126. # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1127. # doxygen will group on one line in the generated HTML documentation.
  1128. #
  1129. # Note that a value of 0 will completely suppress the enum values from appearing
  1130. # in the overview section.
  1131. # Minimum value: 0, maximum value: 20, default value: 4.
  1132. # This tag requires that the tag GENERATE_HTML is set to YES.
  1133. ENUM_VALUES_PER_LINE = 4
  1134. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1135. # to set the initial width (in pixels) of the frame in which the tree is shown.
  1136. # Minimum value: 0, maximum value: 1500, default value: 250.
  1137. # This tag requires that the tag GENERATE_HTML is set to YES.
  1138. TREEVIEW_WIDTH = 250
  1139. # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1140. # external symbols imported via tag files in a separate window.
  1141. # The default value is: NO.
  1142. # This tag requires that the tag GENERATE_HTML is set to YES.
  1143. EXT_LINKS_IN_WINDOW = NO
  1144. # Use this tag to change the font size of LaTeX formulas included as images in
  1145. # the HTML documentation. When you change the font size after a successful
  1146. # doxygen run you need to manually remove any form_*.png images from the HTML
  1147. # output directory to force them to be regenerated.
  1148. # Minimum value: 8, maximum value: 50, default value: 10.
  1149. # This tag requires that the tag GENERATE_HTML is set to YES.
  1150. FORMULA_FONTSIZE = 10
  1151. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1152. # generated for formulas are transparent PNGs. Transparent PNGs are not
  1153. # supported properly for IE 6.0, but are supported on all modern browsers.
  1154. #
  1155. # Note that when changing this option you need to delete any form_*.png files in
  1156. # the HTML output directory before the changes have effect.
  1157. # The default value is: YES.
  1158. # This tag requires that the tag GENERATE_HTML is set to YES.
  1159. FORMULA_TRANSPARENT = YES
  1160. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1161. # http://www.mathjax.org) which uses client side Javascript for the rendering
  1162. # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1163. # installed or if you want to formulas look prettier in the HTML output. When
  1164. # enabled you may also need to install MathJax separately and configure the path
  1165. # to it using the MATHJAX_RELPATH option.
  1166. # The default value is: NO.
  1167. # This tag requires that the tag GENERATE_HTML is set to YES.
  1168. USE_MATHJAX = NO
  1169. # When MathJax is enabled you can set the default output format to be used for
  1170. # the MathJax output. See the MathJax site (see:
  1171. # http://docs.mathjax.org/en/latest/output.html) for more details.
  1172. # Possible values are: HTML-CSS (which is slower, but has the best
  1173. # compatibility), NativeMML (i.e. MathML) and SVG.
  1174. # The default value is: HTML-CSS.
  1175. # This tag requires that the tag USE_MATHJAX is set to YES.
  1176. MATHJAX_FORMAT = HTML-CSS
  1177. # When MathJax is enabled you need to specify the location relative to the HTML
  1178. # output directory using the MATHJAX_RELPATH option. The destination directory
  1179. # should contain the MathJax.js script. For instance, if the mathjax directory
  1180. # is located at the same level as the HTML output directory, then
  1181. # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1182. # Content Delivery Network so you can quickly see the result without installing
  1183. # MathJax. However, it is strongly recommended to install a local copy of
  1184. # MathJax from http://www.mathjax.org before deployment.
  1185. # The default value is: http://cdn.mathjax.org/mathjax/latest.
  1186. # This tag requires that the tag USE_MATHJAX is set to YES.
  1187. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1188. # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1189. # extension names that should be enabled during MathJax rendering. For example
  1190. # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1191. # This tag requires that the tag USE_MATHJAX is set to YES.
  1192. MATHJAX_EXTENSIONS =
  1193. # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1194. # of code that will be used on startup of the MathJax code. See the MathJax site
  1195. # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1196. # example see the documentation.
  1197. # This tag requires that the tag USE_MATHJAX is set to YES.
  1198. MATHJAX_CODEFILE =
  1199. # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1200. # the HTML output. The underlying search engine uses javascript and DHTML and
  1201. # should work on any modern browser. Note that when using HTML help
  1202. # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1203. # there is already a search function so this one should typically be disabled.
  1204. # For large projects the javascript based search engine can be slow, then
  1205. # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1206. # search using the keyboard; to jump to the search box use <access key> + S
  1207. # (what the <access key> is depends on the OS and browser, but it is typically
  1208. # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1209. # key> to jump into the search results window, the results can be navigated
  1210. # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1211. # the search. The filter options can be selected when the cursor is inside the
  1212. # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1213. # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1214. # option.
  1215. # The default value is: YES.
  1216. # This tag requires that the tag GENERATE_HTML is set to YES.
  1217. SEARCHENGINE = YES
  1218. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1219. # implemented using a web server instead of a web client using Javascript. There
  1220. # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1221. # setting. When disabled, doxygen will generate a PHP script for searching and
  1222. # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1223. # and searching needs to be provided by external tools. See the section
  1224. # "External Indexing and Searching" for details.
  1225. # The default value is: NO.
  1226. # This tag requires that the tag SEARCHENGINE is set to YES.
  1227. SERVER_BASED_SEARCH = NO
  1228. # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1229. # script for searching. Instead the search results are written to an XML file
  1230. # which needs to be processed by an external indexer. Doxygen will invoke an
  1231. # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1232. # search results.
  1233. #
  1234. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1235. # (doxysearch.cgi) which are based on the open source search engine library
  1236. # Xapian (see: http://xapian.org/).
  1237. #
  1238. # See the section "External Indexing and Searching" for details.
  1239. # The default value is: NO.
  1240. # This tag requires that the tag SEARCHENGINE is set to YES.
  1241. EXTERNAL_SEARCH = NO
  1242. # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1243. # which will return the search results when EXTERNAL_SEARCH is enabled.
  1244. #
  1245. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1246. # (doxysearch.cgi) which are based on the open source search engine library
  1247. # Xapian (see: http://xapian.org/). See the section "External Indexing and
  1248. # Searching" for details.
  1249. # This tag requires that the tag SEARCHENGINE is set to YES.
  1250. SEARCHENGINE_URL =
  1251. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1252. # search data is written to a file for indexing by an external tool. With the
  1253. # SEARCHDATA_FILE tag the name of this file can be specified.
  1254. # The default file is: searchdata.xml.
  1255. # This tag requires that the tag SEARCHENGINE is set to YES.
  1256. SEARCHDATA_FILE = searchdata.xml
  1257. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1258. # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1259. # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1260. # projects and redirect the results back to the right project.
  1261. # This tag requires that the tag SEARCHENGINE is set to YES.
  1262. EXTERNAL_SEARCH_ID =
  1263. # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1264. # projects other than the one defined by this configuration file, but that are
  1265. # all added to the same external search index. Each project needs to have a
  1266. # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1267. # to a relative location where the documentation can be found. The format is:
  1268. # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1269. # This tag requires that the tag SEARCHENGINE is set to YES.
  1270. EXTRA_SEARCH_MAPPINGS =
  1271. #---------------------------------------------------------------------------
  1272. # Configuration options related to the LaTeX output
  1273. #---------------------------------------------------------------------------
  1274. # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1275. # The default value is: YES.
  1276. GENERATE_LATEX = NO
  1277. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1278. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1279. # it.
  1280. # The default directory is: latex.
  1281. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1282. LATEX_OUTPUT = latex
  1283. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1284. # invoked.
  1285. #
  1286. # Note that when enabling USE_PDFLATEX this option is only used for generating
  1287. # bitmaps for formulas in the HTML output, but not in the Makefile that is
  1288. # written to the output directory.
  1289. # The default file is: latex.
  1290. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1291. LATEX_CMD_NAME = latex
  1292. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1293. # index for LaTeX.
  1294. # The default file is: makeindex.
  1295. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1296. MAKEINDEX_CMD_NAME = makeindex
  1297. # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1298. # documents. This may be useful for small projects and may help to save some
  1299. # trees in general.
  1300. # The default value is: NO.
  1301. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1302. COMPACT_LATEX = NO
  1303. # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1304. # printer.
  1305. # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1306. # 14 inches) and executive (7.25 x 10.5 inches).
  1307. # The default value is: a4.
  1308. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1309. PAPER_TYPE = a4
  1310. # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1311. # that should be included in the LaTeX output. To get the times font for
  1312. # instance you can specify
  1313. # EXTRA_PACKAGES=times
  1314. # If left blank no extra packages will be included.
  1315. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1316. EXTRA_PACKAGES =
  1317. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1318. # generated LaTeX document. The header should contain everything until the first
  1319. # chapter. If it is left blank doxygen will generate a standard header. See
  1320. # section "Doxygen usage" for information on how to let doxygen write the
  1321. # default header to a separate file.
  1322. #
  1323. # Note: Only use a user-defined header if you know what you are doing! The
  1324. # following commands have a special meaning inside the header: $title,
  1325. # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1326. # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1327. # string, for the replacement values of the other commands the user is referred
  1328. # to HTML_HEADER.
  1329. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1330. LATEX_HEADER =
  1331. # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1332. # generated LaTeX document. The footer should contain everything after the last
  1333. # chapter. If it is left blank doxygen will generate a standard footer. See
  1334. # LATEX_HEADER for more information on how to generate a default footer and what
  1335. # special commands can be used inside the footer.
  1336. #
  1337. # Note: Only use a user-defined footer if you know what you are doing!
  1338. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1339. LATEX_FOOTER =
  1340. # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1341. # LaTeX style sheets that are included after the standard style sheets created
  1342. # by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1343. # will copy the style sheet files to the output directory.
  1344. # Note: The order of the extra style sheet files is of importance (e.g. the last
  1345. # style sheet in the list overrules the setting of the previous ones in the
  1346. # list).
  1347. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1348. LATEX_EXTRA_STYLESHEET =
  1349. # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1350. # other source files which should be copied to the LATEX_OUTPUT output
  1351. # directory. Note that the files will be copied as-is; there are no commands or
  1352. # markers available.
  1353. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1354. LATEX_EXTRA_FILES =
  1355. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1356. # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1357. # contain links (just like the HTML output) instead of page references. This
  1358. # makes the output suitable for online browsing using a PDF viewer.
  1359. # The default value is: YES.
  1360. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1361. PDF_HYPERLINKS = YES
  1362. # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1363. # the PDF file directly from the LaTeX files. Set this option to YES, to get a
  1364. # higher quality PDF documentation.
  1365. # The default value is: YES.
  1366. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1367. USE_PDFLATEX = YES
  1368. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1369. # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1370. # if errors occur, instead of asking the user for help. This option is also used
  1371. # when generating formulas in HTML.
  1372. # The default value is: NO.
  1373. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1374. LATEX_BATCHMODE = NO
  1375. # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1376. # index chapters (such as File Index, Compound Index, etc.) in the output.
  1377. # The default value is: NO.
  1378. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1379. LATEX_HIDE_INDICES = NO
  1380. # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1381. # code with syntax highlighting in the LaTeX output.
  1382. #
  1383. # Note that which sources are shown also depends on other settings such as
  1384. # SOURCE_BROWSER.
  1385. # The default value is: NO.
  1386. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1387. LATEX_SOURCE_CODE = NO
  1388. # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1389. # bibliography, e.g. plainnat, or ieeetr. See
  1390. # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1391. # The default value is: plain.
  1392. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1393. LATEX_BIB_STYLE = plain
  1394. #---------------------------------------------------------------------------
  1395. # Configuration options related to the RTF output
  1396. #---------------------------------------------------------------------------
  1397. # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1398. # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1399. # readers/editors.
  1400. # The default value is: NO.
  1401. GENERATE_RTF = NO
  1402. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1403. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1404. # it.
  1405. # The default directory is: rtf.
  1406. # This tag requires that the tag GENERATE_RTF is set to YES.
  1407. RTF_OUTPUT = rtf
  1408. # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1409. # documents. This may be useful for small projects and may help to save some
  1410. # trees in general.
  1411. # The default value is: NO.
  1412. # This tag requires that the tag GENERATE_RTF is set to YES.
  1413. COMPACT_RTF = NO
  1414. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1415. # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1416. # output) instead of page references. This makes the output suitable for online
  1417. # browsing using Word or some other Word compatible readers that support those
  1418. # fields.
  1419. #
  1420. # Note: WordPad (write) and others do not support links.
  1421. # The default value is: NO.
  1422. # This tag requires that the tag GENERATE_RTF is set to YES.
  1423. RTF_HYPERLINKS = NO
  1424. # Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1425. # file, i.e. a series of assignments. You only have to provide replacements,
  1426. # missing definitions are set to their default value.
  1427. #
  1428. # See also section "Doxygen usage" for information on how to generate the
  1429. # default style sheet that doxygen normally uses.
  1430. # This tag requires that the tag GENERATE_RTF is set to YES.
  1431. RTF_STYLESHEET_FILE =
  1432. # Set optional variables used in the generation of an RTF document. Syntax is
  1433. # similar to doxygen's config file. A template extensions file can be generated
  1434. # using doxygen -e rtf extensionFile.
  1435. # This tag requires that the tag GENERATE_RTF is set to YES.
  1436. RTF_EXTENSIONS_FILE =
  1437. # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1438. # with syntax highlighting in the RTF output.
  1439. #
  1440. # Note that which sources are shown also depends on other settings such as
  1441. # SOURCE_BROWSER.
  1442. # The default value is: NO.
  1443. # This tag requires that the tag GENERATE_RTF is set to YES.
  1444. RTF_SOURCE_CODE = NO
  1445. #---------------------------------------------------------------------------
  1446. # Configuration options related to the man page output
  1447. #---------------------------------------------------------------------------
  1448. # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1449. # classes and files.
  1450. # The default value is: NO.
  1451. GENERATE_MAN = NO
  1452. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1453. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1454. # it. A directory man3 will be created inside the directory specified by
  1455. # MAN_OUTPUT.
  1456. # The default directory is: man.
  1457. # This tag requires that the tag GENERATE_MAN is set to YES.
  1458. MAN_OUTPUT = man
  1459. # The MAN_EXTENSION tag determines the extension that is added to the generated
  1460. # man pages. In case the manual section does not start with a number, the number
  1461. # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1462. # optional.
  1463. # The default value is: .3.
  1464. # This tag requires that the tag GENERATE_MAN is set to YES.
  1465. MAN_EXTENSION = .3
  1466. # The MAN_SUBDIR tag determines the name of the directory created within
  1467. # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1468. # MAN_EXTENSION with the initial . removed.
  1469. # This tag requires that the tag GENERATE_MAN is set to YES.
  1470. MAN_SUBDIR =
  1471. # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1472. # will generate one additional man file for each entity documented in the real
  1473. # man page(s). These additional files only source the real man page, but without
  1474. # them the man command would be unable to find the correct page.
  1475. # The default value is: NO.
  1476. # This tag requires that the tag GENERATE_MAN is set to YES.
  1477. MAN_LINKS = NO
  1478. #---------------------------------------------------------------------------
  1479. # Configuration options related to the XML output
  1480. #---------------------------------------------------------------------------
  1481. # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1482. # captures the structure of the code including all documentation.
  1483. # The default value is: NO.
  1484. GENERATE_XML = YES
  1485. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1486. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1487. # it.
  1488. # The default directory is: xml.
  1489. # This tag requires that the tag GENERATE_XML is set to YES.
  1490. XML_OUTPUT = xml
  1491. # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1492. # listings (including syntax highlighting and cross-referencing information) to
  1493. # the XML output. Note that enabling this will significantly increase the size
  1494. # of the XML output.
  1495. # The default value is: YES.
  1496. # This tag requires that the tag GENERATE_XML is set to YES.
  1497. XML_PROGRAMLISTING = YES
  1498. #---------------------------------------------------------------------------
  1499. # Configuration options related to the DOCBOOK output
  1500. #---------------------------------------------------------------------------
  1501. # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1502. # that can be used to generate PDF.
  1503. # The default value is: NO.
  1504. GENERATE_DOCBOOK = NO
  1505. # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1506. # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1507. # front of it.
  1508. # The default directory is: docbook.
  1509. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1510. DOCBOOK_OUTPUT = docbook
  1511. # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1512. # program listings (including syntax highlighting and cross-referencing
  1513. # information) to the DOCBOOK output. Note that enabling this will significantly
  1514. # increase the size of the DOCBOOK output.
  1515. # The default value is: NO.
  1516. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1517. DOCBOOK_PROGRAMLISTING = NO
  1518. #---------------------------------------------------------------------------
  1519. # Configuration options for the AutoGen Definitions output
  1520. #---------------------------------------------------------------------------
  1521. # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1522. # AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1523. # structure of the code including all documentation. Note that this feature is
  1524. # still experimental and incomplete at the moment.
  1525. # The default value is: NO.
  1526. GENERATE_AUTOGEN_DEF = NO
  1527. #---------------------------------------------------------------------------
  1528. # Configuration options related to the Perl module output
  1529. #---------------------------------------------------------------------------
  1530. # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1531. # file that captures the structure of the code including all documentation.
  1532. #
  1533. # Note that this feature is still experimental and incomplete at the moment.
  1534. # The default value is: NO.
  1535. GENERATE_PERLMOD = NO
  1536. # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1537. # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1538. # output from the Perl module output.
  1539. # The default value is: NO.
  1540. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1541. PERLMOD_LATEX = NO
  1542. # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1543. # formatted so it can be parsed by a human reader. This is useful if you want to
  1544. # understand what is going on. On the other hand, if this tag is set to NO, the
  1545. # size of the Perl module output will be much smaller and Perl will parse it
  1546. # just the same.
  1547. # The default value is: YES.
  1548. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1549. PERLMOD_PRETTY = YES
  1550. # The names of the make variables in the generated doxyrules.make file are
  1551. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1552. # so different doxyrules.make files included by the same Makefile don't
  1553. # overwrite each other's variables.
  1554. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1555. PERLMOD_MAKEVAR_PREFIX =
  1556. #---------------------------------------------------------------------------
  1557. # Configuration options related to the preprocessor
  1558. #---------------------------------------------------------------------------
  1559. # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1560. # C-preprocessor directives found in the sources and include files.
  1561. # The default value is: YES.
  1562. ENABLE_PREPROCESSING = YES
  1563. # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1564. # in the source code. If set to NO, only conditional compilation will be
  1565. # performed. Macro expansion can be done in a controlled way by setting
  1566. # EXPAND_ONLY_PREDEF to YES.
  1567. # The default value is: NO.
  1568. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1569. MACRO_EXPANSION = NO
  1570. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1571. # the macro expansion is limited to the macros specified with the PREDEFINED and
  1572. # EXPAND_AS_DEFINED tags.
  1573. # The default value is: NO.
  1574. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1575. EXPAND_ONLY_PREDEF = NO
  1576. # If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1577. # INCLUDE_PATH will be searched if a #include is found.
  1578. # The default value is: YES.
  1579. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1580. SEARCH_INCLUDES = YES
  1581. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1582. # contain include files that are not input files but should be processed by the
  1583. # preprocessor.
  1584. # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1585. INCLUDE_PATH =
  1586. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1587. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1588. # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1589. # used.
  1590. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1591. INCLUDE_FILE_PATTERNS =
  1592. # The PREDEFINED tag can be used to specify one or more macro names that are
  1593. # defined before the preprocessor is started (similar to the -D option of e.g.
  1594. # gcc). The argument of the tag is a list of macros of the form: name or
  1595. # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1596. # is assumed. To prevent a macro definition from being undefined via #undef or
  1597. # recursively expanded use the := operator instead of the = operator.
  1598. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1599. PREDEFINED =
  1600. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1601. # tag can be used to specify a list of macro names that should be expanded. The
  1602. # macro definition that is found in the sources will be used. Use the PREDEFINED
  1603. # tag if you want to use a different macro definition that overrules the
  1604. # definition found in the source code.
  1605. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1606. EXPAND_AS_DEFINED =
  1607. # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1608. # remove all references to function-like macros that are alone on a line, have
  1609. # an all uppercase name, and do not end with a semicolon. Such function macros
  1610. # are typically used for boiler-plate code, and will confuse the parser if not
  1611. # removed.
  1612. # The default value is: YES.
  1613. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1614. SKIP_FUNCTION_MACROS = YES
  1615. #---------------------------------------------------------------------------
  1616. # Configuration options related to external references
  1617. #---------------------------------------------------------------------------
  1618. # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1619. # file the location of the external documentation should be added. The format of
  1620. # a tag file without this location is as follows:
  1621. # TAGFILES = file1 file2 ...
  1622. # Adding location for the tag files is done as follows:
  1623. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1624. # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1625. # section "Linking to external documentation" for more information about the use
  1626. # of tag files.
  1627. # Note: Each tag file must have a unique name (where the name does NOT include
  1628. # the path). If a tag file is not located in the directory in which doxygen is
  1629. # run, you must also specify the path to the tagfile here.
  1630. TAGFILES =
  1631. # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1632. # tag file that is based on the input files it reads. See section "Linking to
  1633. # external documentation" for more information about the usage of tag files.
  1634. GENERATE_TAGFILE =
  1635. # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  1636. # the class index. If set to NO, only the inherited external classes will be
  1637. # listed.
  1638. # The default value is: NO.
  1639. ALLEXTERNALS = NO
  1640. # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  1641. # in the modules index. If set to NO, only the current project's groups will be
  1642. # listed.
  1643. # The default value is: YES.
  1644. EXTERNAL_GROUPS = YES
  1645. # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  1646. # the related pages index. If set to NO, only the current project's pages will
  1647. # be listed.
  1648. # The default value is: YES.
  1649. EXTERNAL_PAGES = YES
  1650. # The PERL_PATH should be the absolute path and name of the perl script
  1651. # interpreter (i.e. the result of 'which perl').
  1652. # The default file (with absolute path) is: /usr/bin/perl.
  1653. PERL_PATH = /usr/bin/perl
  1654. #---------------------------------------------------------------------------
  1655. # Configuration options related to the dot tool
  1656. #---------------------------------------------------------------------------
  1657. # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  1658. # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  1659. # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  1660. # disabled, but it is recommended to install and use dot, since it yields more
  1661. # powerful graphs.
  1662. # The default value is: YES.
  1663. CLASS_DIAGRAMS = NO
  1664. # You can define message sequence charts within doxygen comments using the \msc
  1665. # command. Doxygen will then run the mscgen tool (see:
  1666. # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  1667. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1668. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1669. # default search path.
  1670. MSCGEN_PATH =
  1671. # You can include diagrams made with dia in doxygen documentation. Doxygen will
  1672. # then run dia to produce the diagram and insert it in the documentation. The
  1673. # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  1674. # If left empty dia is assumed to be found in the default search path.
  1675. DIA_PATH =
  1676. # If set to YES the inheritance and collaboration graphs will hide inheritance
  1677. # and usage relations if the target is undocumented or is not a class.
  1678. # The default value is: YES.
  1679. HIDE_UNDOC_RELATIONS = YES
  1680. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1681. # available from the path. This tool is part of Graphviz (see:
  1682. # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  1683. # Bell Labs. The other options in this section have no effect if this option is
  1684. # set to NO
  1685. # The default value is: YES.
  1686. HAVE_DOT = NO
  1687. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  1688. # to run in parallel. When set to 0 doxygen will base this on the number of
  1689. # processors available in the system. You can set it explicitly to a value
  1690. # larger than 0 to get control over the balance between CPU load and processing
  1691. # speed.
  1692. # Minimum value: 0, maximum value: 32, default value: 0.
  1693. # This tag requires that the tag HAVE_DOT is set to YES.
  1694. DOT_NUM_THREADS = 0
  1695. # When you want a differently looking font in the dot files that doxygen
  1696. # generates you can specify the font name using DOT_FONTNAME. You need to make
  1697. # sure dot is able to find the font, which can be done by putting it in a
  1698. # standard location or by setting the DOTFONTPATH environment variable or by
  1699. # setting DOT_FONTPATH to the directory containing the font.
  1700. # The default value is: Helvetica.
  1701. # This tag requires that the tag HAVE_DOT is set to YES.
  1702. DOT_FONTNAME = Helvetica
  1703. # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  1704. # dot graphs.
  1705. # Minimum value: 4, maximum value: 24, default value: 10.
  1706. # This tag requires that the tag HAVE_DOT is set to YES.
  1707. DOT_FONTSIZE = 10
  1708. # By default doxygen will tell dot to use the default font as specified with
  1709. # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  1710. # the path where dot can find it using this tag.
  1711. # This tag requires that the tag HAVE_DOT is set to YES.
  1712. DOT_FONTPATH =
  1713. # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  1714. # each documented class showing the direct and indirect inheritance relations.
  1715. # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  1716. # The default value is: YES.
  1717. # This tag requires that the tag HAVE_DOT is set to YES.
  1718. CLASS_GRAPH = YES
  1719. # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  1720. # graph for each documented class showing the direct and indirect implementation
  1721. # dependencies (inheritance, containment, and class references variables) of the
  1722. # class with other documented classes.
  1723. # The default value is: YES.
  1724. # This tag requires that the tag HAVE_DOT is set to YES.
  1725. COLLABORATION_GRAPH = YES
  1726. # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  1727. # groups, showing the direct groups dependencies.
  1728. # The default value is: YES.
  1729. # This tag requires that the tag HAVE_DOT is set to YES.
  1730. GROUP_GRAPHS = YES
  1731. # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  1732. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1733. # Language.
  1734. # The default value is: NO.
  1735. # This tag requires that the tag HAVE_DOT is set to YES.
  1736. UML_LOOK = NO
  1737. # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  1738. # class node. If there are many fields or methods and many nodes the graph may
  1739. # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  1740. # number of items for each type to make the size more manageable. Set this to 0
  1741. # for no limit. Note that the threshold may be exceeded by 50% before the limit
  1742. # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  1743. # but if the number exceeds 15, the total amount of fields shown is limited to
  1744. # 10.
  1745. # Minimum value: 0, maximum value: 100, default value: 10.
  1746. # This tag requires that the tag HAVE_DOT is set to YES.
  1747. UML_LIMIT_NUM_FIELDS = 10
  1748. # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  1749. # collaboration graphs will show the relations between templates and their
  1750. # instances.
  1751. # The default value is: NO.
  1752. # This tag requires that the tag HAVE_DOT is set to YES.
  1753. TEMPLATE_RELATIONS = NO
  1754. # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  1755. # YES then doxygen will generate a graph for each documented file showing the
  1756. # direct and indirect include dependencies of the file with other documented
  1757. # files.
  1758. # The default value is: YES.
  1759. # This tag requires that the tag HAVE_DOT is set to YES.
  1760. INCLUDE_GRAPH = YES
  1761. # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  1762. # set to YES then doxygen will generate a graph for each documented file showing
  1763. # the direct and indirect include dependencies of the file with other documented
  1764. # files.
  1765. # The default value is: YES.
  1766. # This tag requires that the tag HAVE_DOT is set to YES.
  1767. INCLUDED_BY_GRAPH = YES
  1768. # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  1769. # dependency graph for every global function or class method.
  1770. #
  1771. # Note that enabling this option will significantly increase the time of a run.
  1772. # So in most cases it will be better to enable call graphs for selected
  1773. # functions only using the \callgraph command.
  1774. # The default value is: NO.
  1775. # This tag requires that the tag HAVE_DOT is set to YES.
  1776. CALL_GRAPH = NO
  1777. # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  1778. # dependency graph for every global function or class method.
  1779. #
  1780. # Note that enabling this option will significantly increase the time of a run.
  1781. # So in most cases it will be better to enable caller graphs for selected
  1782. # functions only using the \callergraph command.
  1783. # The default value is: NO.
  1784. # This tag requires that the tag HAVE_DOT is set to YES.
  1785. CALLER_GRAPH = NO
  1786. # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  1787. # hierarchy of all classes instead of a textual one.
  1788. # The default value is: YES.
  1789. # This tag requires that the tag HAVE_DOT is set to YES.
  1790. GRAPHICAL_HIERARCHY = YES
  1791. # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  1792. # dependencies a directory has on other directories in a graphical way. The
  1793. # dependency relations are determined by the #include relations between the
  1794. # files in the directories.
  1795. # The default value is: YES.
  1796. # This tag requires that the tag HAVE_DOT is set to YES.
  1797. DIRECTORY_GRAPH = YES
  1798. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1799. # generated by dot.
  1800. # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  1801. # to make the SVG files visible in IE 9+ (other browsers do not have this
  1802. # requirement).
  1803. # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  1804. # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  1805. # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
  1806. # The default value is: png.
  1807. # This tag requires that the tag HAVE_DOT is set to YES.
  1808. DOT_IMAGE_FORMAT = png
  1809. # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1810. # enable generation of interactive SVG images that allow zooming and panning.
  1811. #
  1812. # Note that this requires a modern browser other than Internet Explorer. Tested
  1813. # and working are Firefox, Chrome, Safari, and Opera.
  1814. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  1815. # the SVG files visible. Older versions of IE do not have SVG support.
  1816. # The default value is: NO.
  1817. # This tag requires that the tag HAVE_DOT is set to YES.
  1818. INTERACTIVE_SVG = NO
  1819. # The DOT_PATH tag can be used to specify the path where the dot tool can be
  1820. # found. If left blank, it is assumed the dot tool can be found in the path.
  1821. # This tag requires that the tag HAVE_DOT is set to YES.
  1822. DOT_PATH =
  1823. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1824. # contain dot files that are included in the documentation (see the \dotfile
  1825. # command).
  1826. # This tag requires that the tag HAVE_DOT is set to YES.
  1827. DOTFILE_DIRS =
  1828. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1829. # contain msc files that are included in the documentation (see the \mscfile
  1830. # command).
  1831. MSCFILE_DIRS =
  1832. # The DIAFILE_DIRS tag can be used to specify one or more directories that
  1833. # contain dia files that are included in the documentation (see the \diafile
  1834. # command).
  1835. DIAFILE_DIRS =
  1836. # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  1837. # path where java can find the plantuml.jar file. If left blank, it is assumed
  1838. # PlantUML is not used or called during a preprocessing step. Doxygen will
  1839. # generate a warning when it encounters a \startuml command in this case and
  1840. # will not generate output for the diagram.
  1841. PLANTUML_JAR_PATH =
  1842. # When using plantuml, the specified paths are searched for files specified by
  1843. # the !include statement in a plantuml block.
  1844. PLANTUML_INCLUDE_PATH =
  1845. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  1846. # that will be shown in the graph. If the number of nodes in a graph becomes
  1847. # larger than this value, doxygen will truncate the graph, which is visualized
  1848. # by representing a node as a red box. Note that doxygen if the number of direct
  1849. # children of the root node in a graph is already larger than
  1850. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  1851. # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1852. # Minimum value: 0, maximum value: 10000, default value: 50.
  1853. # This tag requires that the tag HAVE_DOT is set to YES.
  1854. DOT_GRAPH_MAX_NODES = 50
  1855. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  1856. # generated by dot. A depth value of 3 means that only nodes reachable from the
  1857. # root by following a path via at most 3 edges will be shown. Nodes that lay
  1858. # further from the root node will be omitted. Note that setting this option to 1
  1859. # or 2 may greatly reduce the computation time needed for large code bases. Also
  1860. # note that the size of a graph can be further restricted by
  1861. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1862. # Minimum value: 0, maximum value: 1000, default value: 0.
  1863. # This tag requires that the tag HAVE_DOT is set to YES.
  1864. MAX_DOT_GRAPH_DEPTH = 0
  1865. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1866. # background. This is disabled by default, because dot on Windows does not seem
  1867. # to support this out of the box.
  1868. #
  1869. # Warning: Depending on the platform used, enabling this option may lead to
  1870. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  1871. # read).
  1872. # The default value is: NO.
  1873. # This tag requires that the tag HAVE_DOT is set to YES.
  1874. DOT_TRANSPARENT = NO
  1875. # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  1876. # files in one run (i.e. multiple -o and -T options on the command line). This
  1877. # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  1878. # this, this feature is disabled by default.
  1879. # The default value is: NO.
  1880. # This tag requires that the tag HAVE_DOT is set to YES.
  1881. DOT_MULTI_TARGETS = NO
  1882. # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  1883. # explaining the meaning of the various boxes and arrows in the dot generated
  1884. # graphs.
  1885. # The default value is: YES.
  1886. # This tag requires that the tag HAVE_DOT is set to YES.
  1887. GENERATE_LEGEND = YES
  1888. # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  1889. # files that are used to generate the various graphs.
  1890. # The default value is: YES.
  1891. # This tag requires that the tag HAVE_DOT is set to YES.
  1892. DOT_CLEANUP = YES