Doxyfile.in 119 KB

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