asterisk-ng-doxygen.in 69 KB

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