ubxproto.doxyconf 78 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871
  1. # Doxyfile 1.8.3.1
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for a project.
  4. #
  5. # All text after a hash (#) is considered a comment and will be ignored.
  6. # The format is:
  7. # TAG = value [value, ...]
  8. # For lists items can also be appended using:
  9. # TAG += value [value, ...]
  10. # Values that contain spaces should be placed between quotes (" ").
  11. #---------------------------------------------------------------------------
  12. # Project related configuration options
  13. #---------------------------------------------------------------------------
  14. # This tag specifies the encoding used for all characters in the config file
  15. # that follow. The default is UTF-8 which is also the encoding used for all
  16. # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  17. # iconv built into libc) for the transcoding. See
  18. # http://www.gnu.org/software/libiconv for the list of possible encodings.
  19. DOXYFILE_ENCODING = UTF-8
  20. # The PROJECT_NAME tag is a single word (or sequence of words) that should
  21. # identify the project. Note that if you do not use Doxywizard you need
  22. # to put quotes around the project name if it contains spaces.
  23. PROJECT_NAME = "ubxproto"
  24. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  25. # This could be handy for archiving the generated documentation or
  26. # if some version control system is used.
  27. PROJECT_NUMBER = "V14"
  28. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  29. # for a project that appears at the top of each page and should give viewer
  30. # a quick idea about the purpose of the project. Keep the description short.
  31. PROJECT_BRIEF = "u-blox 7
  32. Receiver Protocol Specification V14
  33. "
  34. # With the PROJECT_LOGO tag one can specify an logo or icon that is
  35. # included in the documentation. The maximum height of the logo should not
  36. # exceed 55 pixels and the maximum width should not exceed 200 pixels.
  37. # Doxygen will copy the logo to the output directory.
  38. #PROJECT_LOGO =
  39. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  40. # base path where the generated documentation will be put.
  41. # If a relative path is entered, it will be relative to the location
  42. # where doxygen was started. If left blank the current directory will be used.
  43. OUTPUT_DIRECTORY = ./doc
  44. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  45. # 4096 sub-directories (in 2 levels) under the output directory of each output
  46. # format and will distribute the generated files over these directories.
  47. # Enabling this option can be useful when feeding doxygen a huge amount of
  48. # source files, where putting all generated files in the same directory would
  49. # otherwise cause performance problems for the file system.
  50. CREATE_SUBDIRS = NO
  51. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  52. # documentation generated by doxygen is written. Doxygen will use this
  53. # information to generate all constant output in the proper language.
  54. # The default language is English, other supported languages are:
  55. # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  56. # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
  57. # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
  58. # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
  59. # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
  60. # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  61. OUTPUT_LANGUAGE = English
  62. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  63. # include brief member descriptions after the members that are listed in
  64. # the file and class documentation (similar to JavaDoc).
  65. # Set to NO to disable this.
  66. BRIEF_MEMBER_DESC = YES
  67. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  68. # the brief description of a member or function before the detailed description.
  69. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  70. # brief descriptions will be completely suppressed.
  71. REPEAT_BRIEF = YES
  72. # This tag implements a quasi-intelligent brief description abbreviator
  73. # that is used to form the text in various listings. Each string
  74. # in this list, if found as the leading text of the brief description, will be
  75. # stripped from the text and the result after processing the whole list, is
  76. # used as the annotated text. Otherwise, the brief description is used as-is.
  77. # If left blank, the following values are used ("$name" is automatically
  78. # replaced with the name of the entity): "The $name class" "The $name widget"
  79. # "The $name file" "is" "provides" "specifies" "contains"
  80. # "represents" "a" "an" "the"
  81. #ABBREVIATE_BRIEF =
  82. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  83. # Doxygen will generate a detailed section even if there is only a brief
  84. # description.
  85. ALWAYS_DETAILED_SEC = NO
  86. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  87. # inherited members of a class in the documentation of that class as if those
  88. # members were ordinary class members. Constructors, destructors and assignment
  89. # operators of the base classes will not be shown.
  90. INLINE_INHERITED_MEMB = NO
  91. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  92. # path before files name in the file list and in the header files. If set
  93. # to NO the shortest path that makes the file name unique will be used.
  94. FULL_PATH_NAMES = YES
  95. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  96. # can be used to strip a user-defined part of the path. Stripping is
  97. # only done if one of the specified strings matches the left-hand part of
  98. # the path. The tag can be used to show relative paths in the file list.
  99. # If left blank the directory from which doxygen is run is used as the
  100. # path to strip. Note that you specify absolute paths here, but also
  101. # relative paths, which will be relative from the directory where doxygen is
  102. # started.
  103. STRIP_FROM_PATH =
  104. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  105. # the path mentioned in the documentation of a class, which tells
  106. # the reader which header file to include in order to use a class.
  107. # If left blank only the name of the header file containing the class
  108. # definition is used. Otherwise one should specify the include paths that
  109. # are normally passed to the compiler using the -I flag.
  110. STRIP_FROM_INC_PATH =
  111. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  112. # (but less readable) file names. This can be useful if your file system
  113. # doesn't support long names like on DOS, Mac, or CD-ROM.
  114. SHORT_NAMES = NO
  115. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  116. # will interpret the first line (until the first dot) of a JavaDoc-style
  117. # comment as the brief description. If set to NO, the JavaDoc
  118. # comments will behave just like regular Qt-style comments
  119. # (thus requiring an explicit @brief command for a brief description.)
  120. JAVADOC_AUTOBRIEF = NO
  121. # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  122. # interpret the first line (until the first dot) of a Qt-style
  123. # comment as the brief description. If set to NO, the comments
  124. # will behave just like regular Qt-style comments (thus requiring
  125. # an explicit \brief command for a brief description.)
  126. QT_AUTOBRIEF = NO
  127. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  128. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  129. # comments) as a brief description. This used to be the default behaviour.
  130. # The new default is to treat a multi-line C++ comment block as a detailed
  131. # description. Set this tag to YES if you prefer the old behaviour instead.
  132. MULTILINE_CPP_IS_BRIEF = NO
  133. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  134. # member inherits the documentation from any documented member that it
  135. # re-implements.
  136. INHERIT_DOCS = YES
  137. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  138. # a new page for each member. If set to NO, the documentation of a member will
  139. # be part of the file/class/namespace that contains it.
  140. SEPARATE_MEMBER_PAGES = NO
  141. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  142. # Doxygen uses this value to replace tabs by spaces in code fragments.
  143. TAB_SIZE = 4
  144. # This tag can be used to specify a number of aliases that acts
  145. # as commands in the documentation. An alias has the form "name=value".
  146. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  147. # put the command \sideeffect (or @sideeffect) in the documentation, which
  148. # will result in a user-defined paragraph with heading "Side Effects:".
  149. # You can put \n's in the value part of an alias to insert newlines.
  150. ALIASES =
  151. # This tag can be used to specify a number of word-keyword mappings (TCL only).
  152. # A mapping has the form "name=value". For example adding
  153. # "class=itcl::class" will allow you to use the command class in the
  154. # itcl::class meaning.
  155. TCL_SUBST =
  156. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  157. # sources only. Doxygen will then generate output that is more tailored for C.
  158. # For instance, some of the names that are used will be different. The list
  159. # of all members will be omitted, etc.
  160. OPTIMIZE_OUTPUT_FOR_C = NO
  161. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  162. # sources only. Doxygen will then generate output that is more tailored for
  163. # Java. For instance, namespaces will be presented as packages, qualified
  164. # scopes will look different, etc.
  165. OPTIMIZE_OUTPUT_JAVA = NO
  166. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  167. # sources only. Doxygen will then generate output that is more tailored for
  168. # Fortran.
  169. OPTIMIZE_FOR_FORTRAN = NO
  170. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  171. # sources. Doxygen will then generate output that is tailored for
  172. # VHDL.
  173. OPTIMIZE_OUTPUT_VHDL = NO
  174. # Doxygen selects the parser to use depending on the extension of the files it
  175. # parses. With this tag you can assign which parser to use for a given
  176. # extension. Doxygen has a built-in mapping, but you can override or extend it
  177. # using this tag. The format is ext=language, where ext is a file extension,
  178. # and language is one of the parsers supported by doxygen: IDL, Java,
  179. # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
  180. # C++. For instance to make doxygen treat .inc files as Fortran files (default
  181. # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
  182. # that for custom extensions you also need to set FILE_PATTERNS otherwise the
  183. # files are not read by doxygen.
  184. EXTENSION_MAPPING =
  185. # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
  186. # comments according to the Markdown format, which allows for more readable
  187. # documentation. See http://daringfireball.net/projects/markdown/ for details.
  188. # The output of markdown processing is further processed by doxygen, so you
  189. # can mix doxygen, HTML, and XML commands with Markdown formatting.
  190. # Disable only in case of backward compatibilities issues.
  191. MARKDOWN_SUPPORT = YES
  192. # When enabled doxygen tries to link words that correspond to documented classes,
  193. # or namespaces to their corresponding documentation. Such a link can be
  194. # prevented in individual cases by by putting a % sign in front of the word or
  195. # globally by setting AUTOLINK_SUPPORT to NO.
  196. AUTOLINK_SUPPORT = YES
  197. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  198. # to include (a tag file for) the STL sources as input, then you should
  199. # set this tag to YES in order to let doxygen match functions declarations and
  200. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  201. # func(std::string) {}). This also makes the inheritance and collaboration
  202. # diagrams that involve STL classes more complete and accurate.
  203. BUILTIN_STL_SUPPORT = NO
  204. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  205. # enable parsing support.
  206. CPP_CLI_SUPPORT = NO
  207. # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  208. # Doxygen will parse them like normal C++ but will assume all classes use public
  209. # instead of private inheritance when no explicit protection keyword is present.
  210. SIP_SUPPORT = NO
  211. # For Microsoft's IDL there are propget and propput attributes to indicate
  212. # getter and setter methods for a property. Setting this option to YES (the
  213. # default) will make doxygen replace the get and set methods by a property in
  214. # the documentation. This will only work if the methods are indeed getting or
  215. # setting a simple type. If this is not the case, or you want to show the
  216. # methods anyway, you should set this option to NO.
  217. IDL_PROPERTY_SUPPORT = YES
  218. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  219. # tag is set to YES, then doxygen will reuse the documentation of the first
  220. # member in the group (if any) for the other members of the group. By default
  221. # all members of a group must be documented explicitly.
  222. DISTRIBUTE_GROUP_DOC = NO
  223. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  224. # the same type (for instance a group of public functions) to be put as a
  225. # subgroup of that type (e.g. under the Public Functions section). Set it to
  226. # NO to prevent subgrouping. Alternatively, this can be done per class using
  227. # the \nosubgrouping command.
  228. SUBGROUPING = YES
  229. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
  230. # unions are shown inside the group in which they are included (e.g. using
  231. # @ingroup) instead of on a separate page (for HTML and Man pages) or
  232. # section (for LaTeX and RTF).
  233. INLINE_GROUPED_CLASSES = NO
  234. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
  235. # unions with only public data fields will be shown inline in the documentation
  236. # of the scope in which they are defined (i.e. file, namespace, or group
  237. # documentation), provided this scope is documented. If set to NO (the default),
  238. # structs, classes, and unions are shown on a separate page (for HTML and Man
  239. # pages) or section (for LaTeX and RTF).
  240. INLINE_SIMPLE_STRUCTS = NO
  241. # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  242. # is documented as struct, union, or enum with the name of the typedef. So
  243. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  244. # with name TypeT. When disabled the typedef will appear as a member of a file,
  245. # namespace, or class. And the struct will be named TypeS. This can typically
  246. # be useful for C code in case the coding convention dictates that all compound
  247. # types are typedef'ed and only the typedef is referenced, never the tag name.
  248. TYPEDEF_HIDES_STRUCT = NO
  249. # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
  250. # determine which symbols to keep in memory and which to flush to disk.
  251. # When the cache is full, less often used symbols will be written to disk.
  252. # For small to medium size projects (<1000 input files) the default value is
  253. # probably good enough. For larger projects a too small cache size can cause
  254. # doxygen to be busy swapping symbols to and from disk most of the time
  255. # causing a significant performance penalty.
  256. # If the system has enough physical memory increasing the cache will improve the
  257. # performance by keeping more symbols in memory. Note that the value works on
  258. # a logarithmic scale so increasing the size by one will roughly double the
  259. # memory usage. The cache size is given by this formula:
  260. # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
  261. # corresponding to a cache size of 2^16 = 65536 symbols.
  262. SYMBOL_CACHE_SIZE = 0
  263. # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
  264. # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
  265. # their name and scope. Since this can be an expensive process and often the
  266. # same symbol appear multiple times in the code, doxygen keeps a cache of
  267. # pre-resolved symbols. If the cache is too small doxygen will become slower.
  268. # If the cache is too large, memory is wasted. The cache size is given by this
  269. # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
  270. # corresponding to a cache size of 2^16 = 65536 symbols.
  271. LOOKUP_CACHE_SIZE = 0
  272. #---------------------------------------------------------------------------
  273. # Build related configuration options
  274. #---------------------------------------------------------------------------
  275. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  276. # documentation are documented, even if no documentation was available.
  277. # Private class members and static file members will be hidden unless
  278. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  279. EXTRACT_ALL = NO
  280. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  281. # will be included in the documentation.
  282. EXTRACT_PRIVATE = NO
  283. # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
  284. # scope will be included in the documentation.
  285. EXTRACT_PACKAGE = NO
  286. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  287. # will be included in the documentation.
  288. EXTRACT_STATIC = NO
  289. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  290. # defined locally in source files will be included in the documentation.
  291. # If set to NO only classes defined in header files are included.
  292. EXTRACT_LOCAL_CLASSES = YES
  293. # This flag is only useful for Objective-C code. When set to YES local
  294. # methods, which are defined in the implementation section but not in
  295. # the interface are included in the documentation.
  296. # If set to NO (the default) only methods in the interface are included.
  297. EXTRACT_LOCAL_METHODS = NO
  298. # If this flag is set to YES, the members of anonymous namespaces will be
  299. # extracted and appear in the documentation as a namespace called
  300. # 'anonymous_namespace{file}', where file will be replaced with the base
  301. # name of the file that contains the anonymous namespace. By default
  302. # anonymous namespaces are hidden.
  303. EXTRACT_ANON_NSPACES = NO
  304. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  305. # undocumented members of documented classes, files or namespaces.
  306. # If set to NO (the default) these members will be included in the
  307. # various overviews, but no documentation section is generated.
  308. # This option has no effect if EXTRACT_ALL is enabled.
  309. HIDE_UNDOC_MEMBERS = NO
  310. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  311. # undocumented classes that are normally visible in the class hierarchy.
  312. # If set to NO (the default) these classes will be included in the various
  313. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  314. HIDE_UNDOC_CLASSES = NO
  315. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  316. # friend (class|struct|union) declarations.
  317. # If set to NO (the default) these declarations will be included in the
  318. # documentation.
  319. HIDE_FRIEND_COMPOUNDS = NO
  320. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  321. # documentation blocks found inside the body of a function.
  322. # If set to NO (the default) these blocks will be appended to the
  323. # function's detailed documentation block.
  324. HIDE_IN_BODY_DOCS = NO
  325. # The INTERNAL_DOCS tag determines if documentation
  326. # that is typed after a \internal command is included. If the tag is set
  327. # to NO (the default) then the documentation will be excluded.
  328. # Set it to YES to include the internal documentation.
  329. INTERNAL_DOCS = NO
  330. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  331. # file names in lower-case letters. If set to YES upper-case letters are also
  332. # allowed. This is useful if you have classes or files whose names only differ
  333. # in case and if your file system supports case sensitive file names. Windows
  334. # and Mac users are advised to set this option to NO.
  335. CASE_SENSE_NAMES = YES
  336. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  337. # will show members with their full class and namespace scopes in the
  338. # documentation. If set to YES the scope will be hidden.
  339. HIDE_SCOPE_NAMES = NO
  340. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  341. # will put a list of the files that are included by a file in the documentation
  342. # of that file.
  343. SHOW_INCLUDE_FILES = YES
  344. # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
  345. # will list include files with double quotes in the documentation
  346. # rather than with sharp brackets.
  347. FORCE_LOCAL_INCLUDES = NO
  348. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  349. # is inserted in the documentation for inline members.
  350. INLINE_INFO = YES
  351. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  352. # will sort the (detailed) documentation of file and class members
  353. # alphabetically by member name. If set to NO the members will appear in
  354. # declaration order.
  355. SORT_MEMBER_DOCS = YES
  356. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  357. # brief documentation of file, namespace and class members alphabetically
  358. # by member name. If set to NO (the default) the members will appear in
  359. # declaration order.
  360. SORT_BRIEF_DOCS = NO
  361. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
  362. # will sort the (brief and detailed) documentation of class members so that
  363. # constructors and destructors are listed first. If set to NO (the default)
  364. # the constructors will appear in the respective orders defined by
  365. # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
  366. # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
  367. # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
  368. SORT_MEMBERS_CTORS_1ST = NO
  369. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  370. # hierarchy of group names into alphabetical order. If set to NO (the default)
  371. # the group names will appear in their defined order.
  372. SORT_GROUP_NAMES = NO
  373. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  374. # sorted by fully-qualified names, including namespaces. If set to
  375. # NO (the default), the class list will be sorted only by class name,
  376. # not including the namespace part.
  377. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  378. # Note: This option applies only to the class list, not to the
  379. # alphabetical list.
  380. SORT_BY_SCOPE_NAME = NO
  381. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
  382. # do proper type resolution of all parameters of a function it will reject a
  383. # match between the prototype and the implementation of a member function even
  384. # if there is only one candidate or it is obvious which candidate to choose
  385. # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
  386. # will still accept a match between prototype and implementation in such cases.
  387. STRICT_PROTO_MATCHING = NO
  388. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  389. # disable (NO) the todo list. This list is created by putting \todo
  390. # commands in the documentation.
  391. GENERATE_TODOLIST = YES
  392. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  393. # disable (NO) the test list. This list is created by putting \test
  394. # commands in the documentation.
  395. GENERATE_TESTLIST = YES
  396. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  397. # disable (NO) the bug list. This list is created by putting \bug
  398. # commands in the documentation.
  399. GENERATE_BUGLIST = YES
  400. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  401. # disable (NO) the deprecated list. This list is created by putting
  402. # \deprecated commands in the documentation.
  403. GENERATE_DEPRECATEDLIST= YES
  404. # The ENABLED_SECTIONS tag can be used to enable conditional
  405. # documentation sections, marked by \if section-label ... \endif
  406. # and \cond section-label ... \endcond blocks.
  407. ENABLED_SECTIONS =
  408. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  409. # the initial value of a variable or macro consists of for it to appear in
  410. # the documentation. If the initializer consists of more lines than specified
  411. # here it will be hidden. Use a value of 0 to hide initializers completely.
  412. # The appearance of the initializer of individual variables and macros in the
  413. # documentation can be controlled using \showinitializer or \hideinitializer
  414. # command in the documentation regardless of this setting.
  415. MAX_INITIALIZER_LINES = 30
  416. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  417. # at the bottom of the documentation of classes and structs. If set to YES the
  418. # list will mention the files that were used to generate the documentation.
  419. SHOW_USED_FILES = YES
  420. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  421. # This will remove the Files entry from the Quick Index and from the
  422. # Folder Tree View (if specified). The default is YES.
  423. SHOW_FILES = YES
  424. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  425. # Namespaces page.
  426. # This will remove the Namespaces entry from the Quick Index
  427. # and from the Folder Tree View (if specified). The default is YES.
  428. SHOW_NAMESPACES = YES
  429. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  430. # doxygen should invoke to get the current version for each file (typically from
  431. # the version control system). Doxygen will invoke the program by executing (via
  432. # popen()) the command <command> <input-file>, where <command> is the value of
  433. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  434. # provided by doxygen. Whatever the program writes to standard output
  435. # is used as the file version. See the manual for examples.
  436. FILE_VERSION_FILTER =
  437. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  438. # by doxygen. The layout file controls the global structure of the generated
  439. # output files in an output format independent way. To create the layout file
  440. # that represents doxygen's defaults, run doxygen with the -l option.
  441. # You can optionally specify a file name after the option, if omitted
  442. # DoxygenLayout.xml will be used as the name of the layout file.
  443. LAYOUT_FILE =
  444. # The CITE_BIB_FILES tag can be used to specify one or more bib files
  445. # containing the references data. This must be a list of .bib files. The
  446. # .bib extension is automatically appended if omitted. Using this command
  447. # requires the bibtex tool to be installed. See also
  448. # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
  449. # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
  450. # feature you need bibtex and perl available in the search path. Do not use
  451. # file names with spaces, bibtex cannot handle them.
  452. CITE_BIB_FILES =
  453. #---------------------------------------------------------------------------
  454. # configuration options related to warning and progress messages
  455. #---------------------------------------------------------------------------
  456. # The QUIET tag can be used to turn on/off the messages that are generated
  457. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  458. QUIET = NO
  459. # The WARNINGS tag can be used to turn on/off the warning messages that are
  460. # generated by doxygen. Possible values are YES and NO. If left blank
  461. # NO is used.
  462. WARNINGS = YES
  463. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  464. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  465. # automatically be disabled.
  466. WARN_IF_UNDOCUMENTED = YES
  467. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  468. # potential errors in the documentation, such as not documenting some
  469. # parameters in a documented function, or documenting parameters that
  470. # don't exist or using markup commands wrongly.
  471. WARN_IF_DOC_ERROR = YES
  472. # The WARN_NO_PARAMDOC option can be enabled to get warnings for
  473. # functions that are documented, but have no documentation for their parameters
  474. # or return value. If set to NO (the default) doxygen will only warn about
  475. # wrong or incomplete parameter documentation, but not about the absence of
  476. # documentation.
  477. WARN_NO_PARAMDOC = NO
  478. # The WARN_FORMAT tag determines the format of the warning messages that
  479. # doxygen can produce. The string should contain the $file, $line, and $text
  480. # tags, which will be replaced by the file and line number from which the
  481. # warning originated and the warning text. Optionally the format may contain
  482. # $version, which will be replaced by the version of the file (if it could
  483. # be obtained via FILE_VERSION_FILTER)
  484. WARN_FORMAT = "$file:$line: $text"
  485. # The WARN_LOGFILE tag can be used to specify a file to which warning
  486. # and error messages should be written. If left blank the output is written
  487. # to stderr.
  488. WARN_LOGFILE =
  489. #---------------------------------------------------------------------------
  490. # configuration options related to the input files
  491. #---------------------------------------------------------------------------
  492. # The INPUT tag can be used to specify the files and/or directories that contain
  493. # documented source files. You may enter file names like "myfile.cpp" or
  494. # directories like "/usr/src/myproject". Separate the files or directories
  495. # with spaces.
  496. INPUT = ./
  497. # This tag can be used to specify the character encoding of the source files
  498. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  499. # also the default input encoding. Doxygen uses libiconv (or the iconv built
  500. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  501. # the list of possible encodings.
  502. INPUT_ENCODING = UTF-8
  503. # If the value of the INPUT tag contains directories, you can use the
  504. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  505. # and *.h) to filter out the source-files in the directories. If left
  506. # blank the following patterns are tested:
  507. # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
  508. # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
  509. # *.f90 *.f *.for *.vhd *.vhdl
  510. FILE_PATTERNS = *.c *.h *.cpp .dox
  511. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  512. # should be searched for input files as well. Possible values are YES and NO.
  513. # If left blank NO is used.
  514. RECURSIVE = NO
  515. # The EXCLUDE tag can be used to specify files and/or directories that should be
  516. # excluded from the INPUT source files. This way you can easily exclude a
  517. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  518. # Note that relative paths are relative to the directory from which doxygen is
  519. # run.
  520. EXCLUDE = ubx.h portable_endian.h
  521. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  522. # directories that are symbolic links (a Unix file system feature) are excluded
  523. # from the input.
  524. EXCLUDE_SYMLINKS = NO
  525. # If the value of the INPUT tag contains directories, you can use the
  526. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  527. # certain files from those directories. Note that the wildcards are matched
  528. # against the file with absolute path, so to exclude all test directories
  529. # for example use the pattern */test/*
  530. EXCLUDE_PATTERNS = *.pro
  531. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  532. # (namespaces, classes, functions, etc.) that should be excluded from the
  533. # output. The symbol name can be a fully qualified name, a word, or if the
  534. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  535. # AClass::ANamespace, ANamespace::*Test
  536. EXCLUDE_SYMBOLS =
  537. # The EXAMPLE_PATH tag can be used to specify one or more files or
  538. # directories that contain example code fragments that are included (see
  539. # the \include command).
  540. EXAMPLE_PATH =
  541. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  542. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  543. # and *.h) to filter out the source-files in the directories. If left
  544. # blank all files are included.
  545. EXAMPLE_PATTERNS =
  546. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  547. # searched for input files to be used with the \include or \dontinclude
  548. # commands irrespective of the value of the RECURSIVE tag.
  549. # Possible values are YES and NO. If left blank NO is used.
  550. EXAMPLE_RECURSIVE = NO
  551. # The IMAGE_PATH tag can be used to specify one or more files or
  552. # directories that contain image that are included in the documentation (see
  553. # the \image command).
  554. IMAGE_PATH =
  555. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  556. # invoke to filter for each input file. Doxygen will invoke the filter program
  557. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  558. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  559. # input file. Doxygen will then use the output that the filter program writes
  560. # to standard output.
  561. # If FILTER_PATTERNS is specified, this tag will be
  562. # ignored.
  563. INPUT_FILTER =
  564. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  565. # basis.
  566. # Doxygen will compare the file name with each pattern and apply the
  567. # filter if there is a match.
  568. # The filters are a list of the form:
  569. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  570. # info on how filters are used. If FILTER_PATTERNS is empty or if
  571. # non of the patterns match the file name, INPUT_FILTER is applied.
  572. FILTER_PATTERNS =
  573. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  574. # INPUT_FILTER) will be used to filter the input files when producing source
  575. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  576. FILTER_SOURCE_FILES = NO
  577. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  578. # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
  579. # and it is also possible to disable source filtering for a specific pattern
  580. # using *.ext= (so without naming a filter). This option only has effect when
  581. # FILTER_SOURCE_FILES is enabled.
  582. FILTER_SOURCE_PATTERNS =
  583. # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
  584. # is part of the input, its contents will be placed on the main page (index.html).
  585. # This can be useful if you have a project on for instance GitHub and want reuse
  586. # the introduction page also for the doxygen output.
  587. USE_MDFILE_AS_MAINPAGE =
  588. #---------------------------------------------------------------------------
  589. # configuration options related to source browsing
  590. #---------------------------------------------------------------------------
  591. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  592. # be generated. Documented entities will be cross-referenced with these sources.
  593. # Note: To get rid of all source code in the generated output, make sure also
  594. # VERBATIM_HEADERS is set to NO.
  595. SOURCE_BROWSER = NO
  596. # Setting the INLINE_SOURCES tag to YES will include the body
  597. # of functions and classes directly in the documentation.
  598. INLINE_SOURCES = NO
  599. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  600. # doxygen to hide any special comment blocks from generated source code
  601. # fragments. Normal C, C++ and Fortran comments will always remain visible.
  602. STRIP_CODE_COMMENTS = YES
  603. # If the REFERENCED_BY_RELATION tag is set to YES
  604. # then for each documented function all documented
  605. # functions referencing it will be listed.
  606. REFERENCED_BY_RELATION = NO
  607. # If the REFERENCES_RELATION tag is set to YES
  608. # then for each documented function all documented entities
  609. # called/used by that function will be listed.
  610. REFERENCES_RELATION = NO
  611. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  612. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  613. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  614. # link to the source code.
  615. # Otherwise they will link to the documentation.
  616. REFERENCES_LINK_SOURCE = YES
  617. # If the USE_HTAGS tag is set to YES then the references to source code
  618. # will point to the HTML generated by the htags(1) tool instead of doxygen
  619. # built-in source browser. The htags tool is part of GNU's global source
  620. # tagging system (see http://www.gnu.org/software/global/global.html). You
  621. # will need version 4.8.6 or higher.
  622. USE_HTAGS = NO
  623. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  624. # will generate a verbatim copy of the header file for each class for
  625. # which an include is specified. Set to NO to disable this.
  626. VERBATIM_HEADERS = YES
  627. #---------------------------------------------------------------------------
  628. # configuration options related to the alphabetical class index
  629. #---------------------------------------------------------------------------
  630. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  631. # of all compounds will be generated. Enable this if the project
  632. # contains a lot of classes, structs, unions or interfaces.
  633. ALPHABETICAL_INDEX = YES
  634. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  635. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  636. # in which this list will be split (can be a number in the range [1..20])
  637. COLS_IN_ALPHA_INDEX = 5
  638. # In case all classes in a project start with a common prefix, all
  639. # classes will be put under the same header in the alphabetical index.
  640. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  641. # should be ignored while generating the index headers.
  642. IGNORE_PREFIX =
  643. #---------------------------------------------------------------------------
  644. # configuration options related to the HTML output
  645. #---------------------------------------------------------------------------
  646. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  647. # generate HTML output.
  648. GENERATE_HTML = YES
  649. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  650. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  651. # put in front of it. If left blank `html' will be used as the default path.
  652. HTML_OUTPUT = html
  653. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  654. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  655. # doxygen will generate files with .html extension.
  656. HTML_FILE_EXTENSION = .html
  657. # The HTML_HEADER tag can be used to specify a personal HTML header for
  658. # each generated HTML page. If it is left blank doxygen will generate a
  659. # standard header. Note that when using a custom header you are responsible
  660. # for the proper inclusion of any scripts and style sheets that doxygen
  661. # needs, which is dependent on the configuration options used.
  662. # It is advised to generate a default header using "doxygen -w html
  663. # header.html footer.html stylesheet.css YourConfigFile" and then modify
  664. # that header. Note that the header is subject to change so you typically
  665. # have to redo this when upgrading to a newer version of doxygen or when
  666. # changing the value of configuration settings such as GENERATE_TREEVIEW!
  667. HTML_HEADER =
  668. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  669. # each generated HTML page. If it is left blank doxygen will generate a
  670. # standard footer.
  671. HTML_FOOTER =
  672. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  673. # style sheet that is used by each HTML page. It can be used to
  674. # fine-tune the look of the HTML output. If left blank doxygen will
  675. # generate a default style sheet. Note that it is recommended to use
  676. # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
  677. # tag will in the future become obsolete.
  678. HTML_STYLESHEET =
  679. # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
  680. # user-defined cascading style sheet that is included after the standard
  681. # style sheets created by doxygen. Using this option one can overrule
  682. # certain style aspects. This is preferred over using HTML_STYLESHEET
  683. # since it does not replace the standard style sheet and is therefor more
  684. # robust against future updates. Doxygen will copy the style sheet file to
  685. # the output directory.
  686. HTML_EXTRA_STYLESHEET =
  687. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  688. # other source files which should be copied to the HTML output directory. Note
  689. # that these files will be copied to the base HTML output directory. Use the
  690. # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  691. # files. In the HTML_STYLESHEET file, use the file name only. Also note that
  692. # the files will be copied as-is; there are no commands or markers available.
  693. HTML_EXTRA_FILES =
  694. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
  695. # Doxygen will adjust the colors in the style sheet and background images
  696. # according to this color. Hue is specified as an angle on a colorwheel,
  697. # see http://en.wikipedia.org/wiki/Hue for more information.
  698. # For instance the value 0 represents red, 60 is yellow, 120 is green,
  699. # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
  700. # The allowed range is 0 to 359.
  701. HTML_COLORSTYLE_HUE = 220
  702. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
  703. # the colors in the HTML output. For a value of 0 the output will use
  704. # grayscales only. A value of 255 will produce the most vivid colors.
  705. HTML_COLORSTYLE_SAT = 100
  706. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
  707. # the luminance component of the colors in the HTML output. Values below
  708. # 100 gradually make the output lighter, whereas values above 100 make
  709. # the output darker. The value divided by 100 is the actual gamma applied,
  710. # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
  711. # and 100 does not change the gamma.
  712. HTML_COLORSTYLE_GAMMA = 80
  713. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  714. # page will contain the date and time when the page was generated. Setting
  715. # this to NO can help when comparing the output of multiple runs.
  716. HTML_TIMESTAMP = YES
  717. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  718. # documentation will contain sections that can be hidden and shown after the
  719. # page has loaded.
  720. HTML_DYNAMIC_SECTIONS = NO
  721. # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
  722. # entries shown in the various tree structured indices initially; the user
  723. # can expand and collapse entries dynamically later on. Doxygen will expand
  724. # the tree to such a level that at most the specified number of entries are
  725. # visible (unless a fully collapsed tree already exceeds this amount).
  726. # So setting the number of entries 1 will produce a full collapsed tree by
  727. # default. 0 is a special value representing an infinite number of entries
  728. # and will result in a full expanded tree by default.
  729. HTML_INDEX_NUM_ENTRIES = 100
  730. # If the GENERATE_DOCSET tag is set to YES, additional index files
  731. # will be generated that can be used as input for Apple's Xcode 3
  732. # integrated development environment, introduced with OSX 10.5 (Leopard).
  733. # To create a documentation set, doxygen will generate a Makefile in the
  734. # HTML output directory. Running make will produce the docset in that
  735. # directory and running "make install" will install the docset in
  736. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  737. # it at startup.
  738. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  739. # for more information.
  740. GENERATE_DOCSET = NO
  741. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  742. # feed. A documentation feed provides an umbrella under which multiple
  743. # documentation sets from a single provider (such as a company or product suite)
  744. # can be grouped.
  745. DOCSET_FEEDNAME = "Doxygen generated docs"
  746. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  747. # should uniquely identify the documentation set bundle. This should be a
  748. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  749. # will append .docset to the name.
  750. DOCSET_BUNDLE_ID = org.doxygen.Project
  751. # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
  752. # identify the documentation publisher. This should be a reverse domain-name
  753. # style string, e.g. com.mycompany.MyDocSet.documentation.
  754. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  755. # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
  756. DOCSET_PUBLISHER_NAME = Publisher
  757. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  758. # will be generated that can be used as input for tools like the
  759. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  760. # of the generated HTML documentation.
  761. GENERATE_HTMLHELP = NO
  762. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  763. # be used to specify the file name of the resulting .chm file. You
  764. # can add a path in front of the file if the result should not be
  765. # written to the html output directory.
  766. CHM_FILE =
  767. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  768. # be used to specify the location (absolute path including file name) of
  769. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  770. # the HTML help compiler on the generated index.hhp.
  771. HHC_LOCATION =
  772. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  773. # controls if a separate .chi index file is generated (YES) or that
  774. # it should be included in the master .chm file (NO).
  775. GENERATE_CHI = NO
  776. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  777. # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  778. # content.
  779. CHM_INDEX_ENCODING =
  780. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  781. # controls whether a binary table of contents is generated (YES) or a
  782. # normal table of contents (NO) in the .chm file.
  783. BINARY_TOC = NO
  784. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  785. # to the contents of the HTML help documentation and to the tree view.
  786. TOC_EXPAND = NO
  787. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  788. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
  789. # that can be used as input for Qt's qhelpgenerator to generate a
  790. # Qt Compressed Help (.qch) of the generated HTML documentation.
  791. GENERATE_QHP = NO
  792. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
  793. # be used to specify the file name of the resulting .qch file.
  794. # The path specified is relative to the HTML output folder.
  795. QCH_FILE =
  796. # The QHP_NAMESPACE tag specifies the namespace to use when generating
  797. # Qt Help Project output. For more information please see
  798. # http://doc.trolltech.com/qthelpproject.html#namespace
  799. QHP_NAMESPACE = org.doxygen.Project
  800. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
  801. # Qt Help Project output. For more information please see
  802. # http://doc.trolltech.com/qthelpproject.html#virtual-folders
  803. QHP_VIRTUAL_FOLDER = doc
  804. # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
  805. # add. For more information please see
  806. # http://doc.trolltech.com/qthelpproject.html#custom-filters
  807. QHP_CUST_FILTER_NAME =
  808. # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
  809. # custom filter to add. For more information please see
  810. # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
  811. # Qt Help Project / Custom Filters</a>.
  812. QHP_CUST_FILTER_ATTRS =
  813. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  814. # project's
  815. # filter section matches.
  816. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
  817. # Qt Help Project / Filter Attributes</a>.
  818. QHP_SECT_FILTER_ATTRS =
  819. # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
  820. # be used to specify the location of Qt's qhelpgenerator.
  821. # If non-empty doxygen will try to run qhelpgenerator on the generated
  822. # .qhp file.
  823. QHG_LOCATION =
  824. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
  825. # will be generated, which together with the HTML files, form an Eclipse help
  826. # plugin. To install this plugin and make it available under the help contents
  827. # menu in Eclipse, the contents of the directory containing the HTML and XML
  828. # files needs to be copied into the plugins directory of eclipse. The name of
  829. # the directory within the plugins directory should be the same as
  830. # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
  831. # the help appears.
  832. GENERATE_ECLIPSEHELP = NO
  833. # A unique identifier for the eclipse help plugin. When installing the plugin
  834. # the directory name containing the HTML and XML files should also have
  835. # this name.
  836. ECLIPSE_DOC_ID = org.doxygen.Project
  837. # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
  838. # at top of each HTML page. The value NO (the default) enables the index and
  839. # the value YES disables it. Since the tabs have the same information as the
  840. # navigation tree you can set this option to NO if you already set
  841. # GENERATE_TREEVIEW to YES.
  842. DISABLE_INDEX = NO
  843. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  844. # structure should be generated to display hierarchical information.
  845. # If the tag value is set to YES, a side panel will be generated
  846. # containing a tree-like index structure (just like the one that
  847. # is generated for HTML Help). For this to work a browser that supports
  848. # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
  849. # Windows users are probably better off using the HTML help feature.
  850. # Since the tree basically has the same information as the tab index you
  851. # could consider to set DISABLE_INDEX to NO when enabling this option.
  852. GENERATE_TREEVIEW = NO
  853. # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
  854. # (range [0,1..20]) that doxygen will group on one line in the generated HTML
  855. # documentation. Note that a value of 0 will completely suppress the enum
  856. # values from appearing in the overview section.
  857. ENUM_VALUES_PER_LINE = 1
  858. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  859. # used to set the initial width (in pixels) of the frame in which the tree
  860. # is shown.
  861. TREEVIEW_WIDTH = 250
  862. # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
  863. # links to external symbols imported via tag files in a separate window.
  864. EXT_LINKS_IN_WINDOW = NO
  865. # Use this tag to change the font size of Latex formulas included
  866. # as images in the HTML documentation. The default is 10. Note that
  867. # when you change the font size after a successful doxygen run you need
  868. # to manually remove any form_*.png images from the HTML output directory
  869. # to force them to be regenerated.
  870. FORMULA_FONTSIZE = 10
  871. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  872. # generated for formulas are transparent PNGs. Transparent PNGs are
  873. # not supported properly for IE 6.0, but are supported on all modern browsers.
  874. # Note that when changing this option you need to delete any form_*.png files
  875. # in the HTML output before the changes have effect.
  876. FORMULA_TRANSPARENT = YES
  877. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
  878. # (see http://www.mathjax.org) which uses client side Javascript for the
  879. # rendering instead of using prerendered bitmaps. Use this if you do not
  880. # have LaTeX installed or if you want to formulas look prettier in the HTML
  881. # output. When enabled you may also need to install MathJax separately and
  882. # configure the path to it using the MATHJAX_RELPATH option.
  883. USE_MATHJAX = NO
  884. # When MathJax is enabled you can set the default output format to be used for
  885. # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
  886. # SVG. The default value is HTML-CSS, which is slower, but has the best
  887. # compatibility.
  888. MATHJAX_FORMAT = HTML-CSS
  889. # When MathJax is enabled you need to specify the location relative to the
  890. # HTML output directory using the MATHJAX_RELPATH option. The destination
  891. # directory should contain the MathJax.js script. For instance, if the mathjax
  892. # directory is located at the same level as the HTML output directory, then
  893. # MATHJAX_RELPATH should be ../mathjax. The default value points to
  894. # the MathJax Content Delivery Network so you can quickly see the result without
  895. # installing MathJax.
  896. # However, it is strongly recommended to install a local
  897. # copy of MathJax from http://www.mathjax.org before deployment.
  898. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  899. # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
  900. # names that should be enabled during MathJax rendering.
  901. MATHJAX_EXTENSIONS =
  902. # When the SEARCHENGINE tag is enabled doxygen will generate a search box
  903. # for the HTML output. The underlying search engine uses javascript
  904. # and DHTML and should work on any modern browser. Note that when using
  905. # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
  906. # (GENERATE_DOCSET) there is already a search function so this one should
  907. # typically be disabled. For large projects the javascript based search engine
  908. # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
  909. SEARCHENGINE = YES
  910. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  911. # implemented using a web server instead of a web client using Javascript.
  912. # There are two flavours of web server based search depending on the
  913. # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
  914. # searching and an index file used by the script. When EXTERNAL_SEARCH is
  915. # enabled the indexing and searching needs to be provided by external tools.
  916. # See the manual for details.
  917. SERVER_BASED_SEARCH = YES
  918. # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
  919. # script for searching. Instead the search results are written to an XML file
  920. # which needs to be processed by an external indexer. Doxygen will invoke an
  921. # external search engine pointed to by the SEARCHENGINE_URL option to obtain
  922. # the search results. Doxygen ships with an example indexer (doxyindexer) and
  923. # search engine (doxysearch.cgi) which are based on the open source search engine
  924. # library Xapian. See the manual for configuration details.
  925. EXTERNAL_SEARCH = NO
  926. # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  927. # which will returned the search results when EXTERNAL_SEARCH is enabled.
  928. # Doxygen ships with an example search engine (doxysearch) which is based on
  929. # the open source search engine library Xapian. See the manual for configuration
  930. # details.
  931. SEARCHENGINE_URL =
  932. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  933. # search data is written to a file for indexing by an external tool. With the
  934. # SEARCHDATA_FILE tag the name of this file can be specified.
  935. SEARCHDATA_FILE = searchdata.xml
  936. # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
  937. # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  938. # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  939. # projects and redirect the results back to the right project.
  940. EXTERNAL_SEARCH_ID =
  941. # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  942. # projects other than the one defined by this configuration file, but that are
  943. # all added to the same external search index. Each project needs to have a
  944. # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
  945. # of to a relative location where the documentation can be found.
  946. # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
  947. EXTRA_SEARCH_MAPPINGS =
  948. #---------------------------------------------------------------------------
  949. # configuration options related to the LaTeX output
  950. #---------------------------------------------------------------------------
  951. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  952. # generate Latex output.
  953. GENERATE_LATEX = YES
  954. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  955. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  956. # put in front of it. If left blank `latex' will be used as the default path.
  957. LATEX_OUTPUT = latex
  958. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  959. # invoked. If left blank `latex' will be used as the default command name.
  960. # Note that when enabling USE_PDFLATEX this option is only used for
  961. # generating bitmaps for formulas in the HTML output, but not in the
  962. # Makefile that is written to the output directory.
  963. LATEX_CMD_NAME = latex
  964. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  965. # generate index for LaTeX. If left blank `makeindex' will be used as the
  966. # default command name.
  967. MAKEINDEX_CMD_NAME = makeindex
  968. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  969. # LaTeX documents. This may be useful for small projects and may help to
  970. # save some trees in general.
  971. COMPACT_LATEX = NO
  972. # The PAPER_TYPE tag can be used to set the paper type that is used
  973. # by the printer. Possible values are: a4, letter, legal and
  974. # executive. If left blank a4wide will be used.
  975. PAPER_TYPE = a4
  976. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  977. # packages that should be included in the LaTeX output.
  978. EXTRA_PACKAGES =
  979. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  980. # the generated latex document. The header should contain everything until
  981. # the first chapter. If it is left blank doxygen will generate a
  982. # standard header. Notice: only use this tag if you know what you are doing!
  983. LATEX_HEADER =
  984. # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
  985. # the generated latex document. The footer should contain everything after
  986. # the last chapter. If it is left blank doxygen will generate a
  987. # standard footer. Notice: only use this tag if you know what you are doing!
  988. LATEX_FOOTER =
  989. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  990. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  991. # contain links (just like the HTML output) instead of page references
  992. # This makes the output suitable for online browsing using a pdf viewer.
  993. PDF_HYPERLINKS = YES
  994. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  995. # plain latex in the generated Makefile. Set this option to YES to get a
  996. # higher quality PDF documentation.
  997. USE_PDFLATEX = YES
  998. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  999. # command to the generated LaTeX files. This will instruct LaTeX to keep
  1000. # running if errors occur, instead of asking the user for help.
  1001. # This option is also used when generating formulas in HTML.
  1002. LATEX_BATCHMODE = NO
  1003. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  1004. # include the index chapters (such as File Index, Compound Index, etc.)
  1005. # in the output.
  1006. LATEX_HIDE_INDICES = NO
  1007. # If LATEX_SOURCE_CODE is set to YES then doxygen will include
  1008. # source code with syntax highlighting in the LaTeX output.
  1009. # Note that which sources are shown also depends on other settings
  1010. # such as SOURCE_BROWSER.
  1011. LATEX_SOURCE_CODE = NO
  1012. # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1013. # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
  1014. # http://en.wikipedia.org/wiki/BibTeX for more info.
  1015. LATEX_BIB_STYLE = plain
  1016. #---------------------------------------------------------------------------
  1017. # configuration options related to the RTF output
  1018. #---------------------------------------------------------------------------
  1019. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  1020. # The RTF output is optimized for Word 97 and may not look very pretty with
  1021. # other RTF readers or editors.
  1022. GENERATE_RTF = NO
  1023. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  1024. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1025. # put in front of it. If left blank `rtf' will be used as the default path.
  1026. RTF_OUTPUT = rtf
  1027. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  1028. # RTF documents. This may be useful for small projects and may help to
  1029. # save some trees in general.
  1030. COMPACT_RTF = NO
  1031. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  1032. # will contain hyperlink fields. The RTF file will
  1033. # contain links (just like the HTML output) instead of page references.
  1034. # This makes the output suitable for online browsing using WORD or other
  1035. # programs which support those fields.
  1036. # Note: wordpad (write) and others do not support links.
  1037. RTF_HYPERLINKS = NO
  1038. # Load style sheet definitions from file. Syntax is similar to doxygen's
  1039. # config file, i.e. a series of assignments. You only have to provide
  1040. # replacements, missing definitions are set to their default value.
  1041. RTF_STYLESHEET_FILE =
  1042. # Set optional variables used in the generation of an rtf document.
  1043. # Syntax is similar to doxygen's config file.
  1044. RTF_EXTENSIONS_FILE =
  1045. #---------------------------------------------------------------------------
  1046. # configuration options related to the man page output
  1047. #---------------------------------------------------------------------------
  1048. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  1049. # generate man pages
  1050. GENERATE_MAN = NO
  1051. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  1052. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1053. # put in front of it. If left blank `man' will be used as the default path.
  1054. MAN_OUTPUT = man
  1055. # The MAN_EXTENSION tag determines the extension that is added to
  1056. # the generated man pages (default is the subroutine's section .3)
  1057. MAN_EXTENSION = .3
  1058. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  1059. # then it will generate one additional man file for each entity
  1060. # documented in the real man page(s). These additional files
  1061. # only source the real man page, but without them the man command
  1062. # would be unable to find the correct page. The default is NO.
  1063. MAN_LINKS = NO
  1064. #---------------------------------------------------------------------------
  1065. # configuration options related to the XML output
  1066. #---------------------------------------------------------------------------
  1067. # If the GENERATE_XML tag is set to YES Doxygen will
  1068. # generate an XML file that captures the structure of
  1069. # the code including all documentation.
  1070. GENERATE_XML = NO
  1071. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  1072. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  1073. # put in front of it. If left blank `xml' will be used as the default path.
  1074. XML_OUTPUT = xml
  1075. # The XML_SCHEMA tag can be used to specify an XML schema,
  1076. # which can be used by a validating XML parser to check the
  1077. # syntax of the XML files.
  1078. XML_SCHEMA =
  1079. # The XML_DTD tag can be used to specify an XML DTD,
  1080. # which can be used by a validating XML parser to check the
  1081. # syntax of the XML files.
  1082. XML_DTD =
  1083. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  1084. # dump the program listings (including syntax highlighting
  1085. # and cross-referencing information) to the XML output. Note that
  1086. # enabling this will significantly increase the size of the XML output.
  1087. XML_PROGRAMLISTING = YES
  1088. #---------------------------------------------------------------------------
  1089. # configuration options for the AutoGen Definitions output
  1090. #---------------------------------------------------------------------------
  1091. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  1092. # generate an AutoGen Definitions (see autogen.sf.net) file
  1093. # that captures the structure of the code including all
  1094. # documentation. Note that this feature is still experimental
  1095. # and incomplete at the moment.
  1096. GENERATE_AUTOGEN_DEF = NO
  1097. #---------------------------------------------------------------------------
  1098. # configuration options related to the Perl module output
  1099. #---------------------------------------------------------------------------
  1100. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  1101. # generate a Perl module file that captures the structure of
  1102. # the code including all documentation. Note that this
  1103. # feature is still experimental and incomplete at the
  1104. # moment.
  1105. GENERATE_PERLMOD = NO
  1106. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  1107. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  1108. # to generate PDF and DVI output from the Perl module output.
  1109. PERLMOD_LATEX = NO
  1110. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  1111. # nicely formatted so it can be parsed by a human reader.
  1112. # This is useful
  1113. # if you want to understand what is going on.
  1114. # On the other hand, if this
  1115. # tag is set to NO the size of the Perl module output will be much smaller
  1116. # and Perl will parse it just the same.
  1117. PERLMOD_PRETTY = YES
  1118. # The names of the make variables in the generated doxyrules.make file
  1119. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  1120. # This is useful so different doxyrules.make files included by the same
  1121. # Makefile don't overwrite each other's variables.
  1122. PERLMOD_MAKEVAR_PREFIX =
  1123. #---------------------------------------------------------------------------
  1124. # Configuration options related to the preprocessor
  1125. #---------------------------------------------------------------------------
  1126. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  1127. # evaluate all C-preprocessor directives found in the sources and include
  1128. # files.
  1129. ENABLE_PREPROCESSING = YES
  1130. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  1131. # names in the source code. If set to NO (the default) only conditional
  1132. # compilation will be performed. Macro expansion can be done in a controlled
  1133. # way by setting EXPAND_ONLY_PREDEF to YES.
  1134. MACRO_EXPANSION = NO
  1135. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  1136. # then the macro expansion is limited to the macros specified with the
  1137. # PREDEFINED and EXPAND_AS_DEFINED tags.
  1138. EXPAND_ONLY_PREDEF = NO
  1139. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  1140. # pointed to by INCLUDE_PATH will be searched when a #include is found.
  1141. SEARCH_INCLUDES = YES
  1142. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1143. # contain include files that are not input files but should be processed by
  1144. # the preprocessor.
  1145. INCLUDE_PATH =
  1146. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1147. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1148. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  1149. # be used.
  1150. INCLUDE_FILE_PATTERNS =
  1151. # The PREDEFINED tag can be used to specify one or more macro names that
  1152. # are defined before the preprocessor is started (similar to the -D option of
  1153. # gcc). The argument of the tag is a list of macros of the form: name
  1154. # or name=definition (no spaces). If the definition and the = are
  1155. # omitted =1 is assumed. To prevent a macro definition from being
  1156. # undefined via #undef or recursively expanded use the := operator
  1157. # instead of the = operator.
  1158. PREDEFINED =
  1159. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  1160. # this tag can be used to specify a list of macro names that should be expanded.
  1161. # The macro definition that is found in the sources will be used.
  1162. # Use the PREDEFINED tag if you want to use a different macro definition that
  1163. # overrules the definition found in the source code.
  1164. EXPAND_AS_DEFINED =
  1165. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  1166. # doxygen's preprocessor will remove all references to function-like macros
  1167. # that are alone on a line, have an all uppercase name, and do not end with a
  1168. # semicolon, because these will confuse the parser if not removed.
  1169. SKIP_FUNCTION_MACROS = YES
  1170. #---------------------------------------------------------------------------
  1171. # Configuration::additions related to external references
  1172. #---------------------------------------------------------------------------
  1173. # The TAGFILES option can be used to specify one or more tagfiles. For each
  1174. # tag file the location of the external documentation should be added. The
  1175. # format of a tag file without this location is as follows:
  1176. #
  1177. # TAGFILES = file1 file2 ...
  1178. # Adding location for the tag files is done as follows:
  1179. #
  1180. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1181. # where "loc1" and "loc2" can be relative or absolute paths
  1182. # or URLs. Note that each tag file must have a unique name (where the name does
  1183. # NOT include the path). If a tag file is not located in the directory in which
  1184. # doxygen is run, you must also specify the path to the tagfile here.
  1185. TAGFILES =
  1186. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  1187. # a tag file that is based on the input files it reads.
  1188. GENERATE_TAGFILE =
  1189. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  1190. # in the class index. If set to NO only the inherited external classes
  1191. # will be listed.
  1192. ALLEXTERNALS = NO
  1193. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  1194. # in the modules index. If set to NO, only the current project's groups will
  1195. # be listed.
  1196. EXTERNAL_GROUPS = YES
  1197. # The PERL_PATH should be the absolute path and name of the perl script
  1198. # interpreter (i.e. the result of `which perl').
  1199. PERL_PATH = /usr/bin/perl
  1200. #---------------------------------------------------------------------------
  1201. # Configuration options related to the dot tool
  1202. #---------------------------------------------------------------------------
  1203. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  1204. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  1205. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  1206. # this option also works with HAVE_DOT disabled, but it is recommended to
  1207. # install and use dot, since it yields more powerful graphs.
  1208. CLASS_DIAGRAMS = NO
  1209. # You can define message sequence charts within doxygen comments using the \msc
  1210. # command. Doxygen will then run the mscgen tool (see
  1211. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  1212. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1213. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1214. # default search path.
  1215. MSCGEN_PATH =
  1216. # If set to YES, the inheritance and collaboration graphs will hide
  1217. # inheritance and usage relations if the target is undocumented
  1218. # or is not a class.
  1219. HIDE_UNDOC_RELATIONS = YES
  1220. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1221. # available from the path. This tool is part of Graphviz, a graph visualization
  1222. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  1223. # have no effect if this option is set to NO (the default)
  1224. HAVE_DOT = NO
  1225. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
  1226. # allowed to run in parallel. When set to 0 (the default) doxygen will
  1227. # base this on the number of processors available in the system. You can set it
  1228. # explicitly to a value larger than 0 to get control over the balance
  1229. # between CPU load and processing speed.
  1230. DOT_NUM_THREADS = 0
  1231. # By default doxygen will use the Helvetica font for all dot files that
  1232. # doxygen generates. When you want a differently looking font you can specify
  1233. # the font name using DOT_FONTNAME. You need to make sure dot is able to find
  1234. # the font, which can be done by putting it in a standard location or by setting
  1235. # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
  1236. # directory containing the font.
  1237. DOT_FONTNAME = Helvetica
  1238. # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
  1239. # The default size is 10pt.
  1240. DOT_FONTSIZE = 10
  1241. # By default doxygen will tell dot to use the Helvetica font.
  1242. # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
  1243. # set the path where dot can find it.
  1244. DOT_FONTPATH =
  1245. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1246. # will generate a graph for each documented class showing the direct and
  1247. # indirect inheritance relations. Setting this tag to YES will force the
  1248. # CLASS_DIAGRAMS tag to NO.
  1249. CLASS_GRAPH = YES
  1250. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  1251. # will generate a graph for each documented class showing the direct and
  1252. # indirect implementation dependencies (inheritance, containment, and
  1253. # class references variables) of the class with other documented classes.
  1254. COLLABORATION_GRAPH = YES
  1255. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  1256. # will generate a graph for groups, showing the direct groups dependencies
  1257. GROUP_GRAPHS = YES
  1258. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  1259. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1260. # Language.
  1261. UML_LOOK = NO
  1262. # If the UML_LOOK tag is enabled, the fields and methods are shown inside
  1263. # the class node. If there are many fields or methods and many nodes the
  1264. # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
  1265. # threshold limits the number of items for each type to make the size more
  1266. # managable. Set this to 0 for no limit. Note that the threshold may be
  1267. # exceeded by 50% before the limit is enforced.
  1268. UML_LIMIT_NUM_FIELDS = 10
  1269. # If set to YES, the inheritance and collaboration graphs will show the
  1270. # relations between templates and their instances.
  1271. TEMPLATE_RELATIONS = NO
  1272. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  1273. # tags are set to YES then doxygen will generate a graph for each documented
  1274. # file showing the direct and indirect include dependencies of the file with
  1275. # other documented files.
  1276. INCLUDE_GRAPH = YES
  1277. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  1278. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  1279. # documented header file showing the documented files that directly or
  1280. # indirectly include this file.
  1281. INCLUDED_BY_GRAPH = YES
  1282. # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  1283. # doxygen will generate a call dependency graph for every global function
  1284. # or class method. Note that enabling this option will significantly increase
  1285. # the time of a run. So in most cases it will be better to enable call graphs
  1286. # for selected functions only using the \callgraph command.
  1287. CALL_GRAPH = NO
  1288. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  1289. # doxygen will generate a caller dependency graph for every global function
  1290. # or class method. Note that enabling this option will significantly increase
  1291. # the time of a run. So in most cases it will be better to enable caller
  1292. # graphs for selected functions only using the \callergraph command.
  1293. CALLER_GRAPH = NO
  1294. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  1295. # will generate a graphical hierarchy of all classes instead of a textual one.
  1296. GRAPHICAL_HIERARCHY = YES
  1297. # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
  1298. # then doxygen will show the dependencies a directory has on other directories
  1299. # in a graphical way. The dependency relations are determined by the #include
  1300. # relations between the files in the directories.
  1301. DIRECTORY_GRAPH = YES
  1302. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1303. # generated by dot. Possible values are svg, png, jpg, or gif.
  1304. # If left blank png will be used. If you choose svg you need to set
  1305. # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1306. # visible in IE 9+ (other browsers do not have this requirement).
  1307. DOT_IMAGE_FORMAT = png
  1308. # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1309. # enable generation of interactive SVG images that allow zooming and panning.
  1310. # Note that this requires a modern browser other than Internet Explorer.
  1311. # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
  1312. # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
  1313. # visible. Older versions of IE do not have SVG support.
  1314. INTERACTIVE_SVG = NO
  1315. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  1316. # found. If left blank, it is assumed the dot tool can be found in the path.
  1317. DOT_PATH =
  1318. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1319. # contain dot files that are included in the documentation (see the
  1320. # \dotfile command).
  1321. DOTFILE_DIRS =
  1322. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1323. # contain msc files that are included in the documentation (see the
  1324. # \mscfile command).
  1325. MSCFILE_DIRS =
  1326. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  1327. # nodes that will be shown in the graph. If the number of nodes in a graph
  1328. # becomes larger than this value, doxygen will truncate the graph, which is
  1329. # visualized by representing a node as a red box. Note that doxygen if the
  1330. # number of direct children of the root node in a graph is already larger than
  1331. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  1332. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1333. DOT_GRAPH_MAX_NODES = 50
  1334. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  1335. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  1336. # from the root by following a path via at most 3 edges will be shown. Nodes
  1337. # that lay further from the root node will be omitted. Note that setting this
  1338. # option to 1 or 2 may greatly reduce the computation time needed for large
  1339. # code bases. Also note that the size of a graph can be further restricted by
  1340. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1341. MAX_DOT_GRAPH_DEPTH = 0
  1342. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1343. # background. This is disabled by default, because dot on Windows does not
  1344. # seem to support this out of the box. Warning: Depending on the platform used,
  1345. # enabling this option may lead to badly anti-aliased labels on the edges of
  1346. # a graph (i.e. they become hard to read).
  1347. DOT_TRANSPARENT = NO
  1348. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  1349. # files in one run (i.e. multiple -o and -T options on the command line). This
  1350. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  1351. # support this, this feature is disabled by default.
  1352. DOT_MULTI_TARGETS = NO
  1353. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1354. # generate a legend page explaining the meaning of the various boxes and
  1355. # arrows in the dot generated graphs.
  1356. GENERATE_LEGEND = YES
  1357. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1358. # remove the intermediate dot files that are used to generate
  1359. # the various graphs.
  1360. DOT_CLEANUP = YES