The official µGFX library repository.

Doxygenfile 100KB

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