doxy-config 120 KB

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