Doxyfile 68 KB

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