asterisk-ng-doxygen 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329
  1. # Doxyfile 1.5.2
  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 that
  15. # follow. The default is UTF-8 which is also the encoding used for all text before
  16. # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
  17. # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
  18. # 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/api
  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, Finnish, French, German, Greek, Hungarian,
  45. # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
  46. # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
  47. # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
  48. OUTPUT_LANGUAGE = English
  49. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  50. # include brief member descriptions after the members that are listed in
  51. # the file and class documentation (similar to JavaDoc).
  52. # Set to NO to disable this.
  53. BRIEF_MEMBER_DESC = YES
  54. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  55. # the brief description of a member or function before the detailed description.
  56. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  57. # brief descriptions will be completely suppressed.
  58. REPEAT_BRIEF = YES
  59. # This tag implements a quasi-intelligent brief description abbreviator
  60. # that is used to form the text in various listings. Each string
  61. # in this list, if found as the leading text of the brief description, will be
  62. # stripped from the text and the result after processing the whole list, is
  63. # used as the annotated text. Otherwise, the brief description is used as-is.
  64. # If left blank, the following values are used ("$name" is automatically
  65. # replaced with the name of the entity): "The $name class" "The $name widget"
  66. # "The $name file" "is" "provides" "specifies" "contains"
  67. # "represents" "a" "an" "the"
  68. ABBREVIATE_BRIEF =
  69. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  70. # Doxygen will generate a detailed section even if there is only a brief
  71. # description.
  72. ALWAYS_DETAILED_SEC = NO
  73. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  74. # inherited members of a class in the documentation of that class as if those
  75. # members were ordinary class members. Constructors, destructors and assignment
  76. # operators of the base classes will not be shown.
  77. INLINE_INHERITED_MEMB = NO
  78. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  79. # path before files name in the file list and in the header files. If set
  80. # to NO the shortest path that makes the file name unique will be used.
  81. FULL_PATH_NAMES = NO
  82. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  83. # can be used to strip a user-defined part of the path. Stripping is
  84. # only done if one of the specified strings matches the left-hand part of
  85. # the path. The tag can be used to show relative paths in the file list.
  86. # If left blank the directory from which doxygen is run is used as the
  87. # path to strip.
  88. STRIP_FROM_PATH =
  89. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  90. # the path mentioned in the documentation of a class, which tells
  91. # the reader which header file to include in order to use a class.
  92. # If left blank only the name of the header file containing the class
  93. # definition is used. Otherwise one should specify the include paths that
  94. # are normally passed to the compiler using the -I flag.
  95. STRIP_FROM_INC_PATH =
  96. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  97. # (but less readable) file names. This can be useful is your file systems
  98. # doesn't support long names like on DOS, Mac, or CD-ROM.
  99. SHORT_NAMES = NO
  100. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  101. # will interpret the first line (until the first dot) of a JavaDoc-style
  102. # comment as the brief description. If set to NO, the JavaDoc
  103. # comments will behave just like the Qt-style comments (thus requiring an
  104. # explicit @brief command for a brief description.
  105. JAVADOC_AUTOBRIEF = NO
  106. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  107. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  108. # comments) as a brief description. This used to be the default behaviour.
  109. # The new default is to treat a multi-line C++ comment block as a detailed
  110. # description. Set this tag to YES if you prefer the old behaviour instead.
  111. MULTILINE_CPP_IS_BRIEF = NO
  112. # If the DETAILS_AT_TOP tag is set to YES then Doxygen
  113. # will output the detailed description near the top, like JavaDoc.
  114. # If set to NO, the detailed description appears after the member
  115. # documentation.
  116. DETAILS_AT_TOP = NO
  117. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  118. # member inherits the documentation from any documented member that it
  119. # re-implements.
  120. INHERIT_DOCS = YES
  121. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  122. # a new page for each member. If set to NO, the documentation of a member will
  123. # be part of the file/class/namespace that contains it.
  124. SEPARATE_MEMBER_PAGES = NO
  125. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  126. # Doxygen uses this value to replace tabs by spaces in code fragments.
  127. TAB_SIZE = 3
  128. # This tag can be used to specify a number of aliases that acts
  129. # as commands in the documentation. An alias has the form "name=value".
  130. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  131. # put the command \sideeffect (or @sideeffect) in the documentation, which
  132. # will result in a user-defined paragraph with heading "Side Effects:".
  133. # You can put \n's in the value part of an alias to insert newlines.
  134. ALIASES = "extref=\xrefitem extref \"ExtRef\" \"External references\""
  135. ALIASES += "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."
  136. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  137. # sources only. Doxygen will then generate output that is more tailored for C.
  138. # For instance, some of the names that are used will be different. The list
  139. # of all members will be omitted, etc.
  140. OPTIMIZE_OUTPUT_FOR_C = YES
  141. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  142. # sources only. Doxygen will then generate output that is more tailored for Java.
  143. # For instance, namespaces will be presented as packages, qualified scopes
  144. # will look different, etc.
  145. OPTIMIZE_OUTPUT_JAVA = NO
  146. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
  147. # include (a tag file for) the STL sources as input, then you should
  148. # set this tag to YES in order to let doxygen match functions declarations and
  149. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  150. # func(std::string) {}). This also make the inheritance and collaboration
  151. # diagrams that involve STL classes more complete and accurate.
  152. BUILTIN_STL_SUPPORT = NO
  153. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  154. # enable parsing support.
  155. CPP_CLI_SUPPORT = NO
  156. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  157. # tag is set to YES, then doxygen will reuse the documentation of the first
  158. # member in the group (if any) for the other members of the group. By default
  159. # all members of a group must be documented explicitly.
  160. DISTRIBUTE_GROUP_DOC = NO
  161. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  162. # the same type (for instance a group of public functions) to be put as a
  163. # subgroup of that type (e.g. under the Public Functions section). Set it to
  164. # NO to prevent subgrouping. Alternatively, this can be done per class using
  165. # the \nosubgrouping command.
  166. SUBGROUPING = YES
  167. #---------------------------------------------------------------------------
  168. # Build related configuration options
  169. #---------------------------------------------------------------------------
  170. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  171. # documentation are documented, even if no documentation was available.
  172. # Private class members and static file members will be hidden unless
  173. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  174. EXTRACT_ALL = YES
  175. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  176. # will be included in the documentation.
  177. EXTRACT_PRIVATE = NO
  178. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  179. # will be included in the documentation.
  180. EXTRACT_STATIC = YES
  181. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  182. # defined locally in source files will be included in the documentation.
  183. # If set to NO only classes defined in header files are included.
  184. EXTRACT_LOCAL_CLASSES = YES
  185. # This flag is only useful for Objective-C code. When set to YES local
  186. # methods, which are defined in the implementation section but not in
  187. # the interface are included in the documentation.
  188. # If set to NO (the default) only methods in the interface are included.
  189. EXTRACT_LOCAL_METHODS = NO
  190. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  191. # undocumented members of documented classes, files or namespaces.
  192. # If set to NO (the default) these members will be included in the
  193. # various overviews, but no documentation section is generated.
  194. # This option has no effect if EXTRACT_ALL is enabled.
  195. HIDE_UNDOC_MEMBERS = NO
  196. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  197. # undocumented classes that are normally visible in the class hierarchy.
  198. # If set to NO (the default) these classes will be included in the various
  199. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  200. HIDE_UNDOC_CLASSES = NO
  201. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  202. # friend (class|struct|union) declarations.
  203. # If set to NO (the default) these declarations will be included in the
  204. # documentation.
  205. HIDE_FRIEND_COMPOUNDS = NO
  206. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  207. # documentation blocks found inside the body of a function.
  208. # If set to NO (the default) these blocks will be appended to the
  209. # function's detailed documentation block.
  210. HIDE_IN_BODY_DOCS = NO
  211. # The INTERNAL_DOCS tag determines if documentation
  212. # that is typed after a \internal command is included. If the tag is set
  213. # to NO (the default) then the documentation will be excluded.
  214. # Set it to YES to include the internal documentation.
  215. INTERNAL_DOCS = NO
  216. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  217. # file names in lower-case letters. If set to YES upper-case letters are also
  218. # allowed. This is useful if you have classes or files whose names only differ
  219. # in case and if your file system supports case sensitive file names. Windows
  220. # and Mac users are advised to set this option to NO.
  221. CASE_SENSE_NAMES = YES
  222. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  223. # will show members with their full class and namespace scopes in the
  224. # documentation. If set to YES the scope will be hidden.
  225. HIDE_SCOPE_NAMES = YES
  226. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  227. # will put a list of the files that are included by a file in the documentation
  228. # of that file.
  229. SHOW_INCLUDE_FILES = YES
  230. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  231. # is inserted in the documentation for inline members.
  232. INLINE_INFO = YES
  233. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  234. # will sort the (detailed) documentation of file and class members
  235. # alphabetically by member name. If set to NO the members will appear in
  236. # declaration order.
  237. SORT_MEMBER_DOCS = YES
  238. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  239. # brief documentation of file, namespace and class members alphabetically
  240. # by member name. If set to NO (the default) the members will appear in
  241. # declaration order.
  242. SORT_BRIEF_DOCS = YES
  243. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  244. # sorted by fully-qualified names, including namespaces. If set to
  245. # NO (the default), the class list will be sorted only by class name,
  246. # not including the namespace part.
  247. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  248. # Note: This option applies only to the class list, not to the
  249. # alphabetical list.
  250. SORT_BY_SCOPE_NAME = NO
  251. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  252. # disable (NO) the todo list. This list is created by putting \todo
  253. # commands in the documentation.
  254. GENERATE_TODOLIST = YES
  255. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  256. # disable (NO) the test list. This list is created by putting \test
  257. # commands in the documentation.
  258. GENERATE_TESTLIST = YES
  259. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  260. # disable (NO) the bug list. This list is created by putting \bug
  261. # commands in the documentation.
  262. GENERATE_BUGLIST = YES
  263. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  264. # disable (NO) the deprecated list. This list is created by putting
  265. # \deprecated commands in the documentation.
  266. GENERATE_DEPRECATEDLIST= YES
  267. # The ENABLED_SECTIONS tag can be used to enable conditional
  268. # documentation sections, marked by \if sectionname ... \endif.
  269. ENABLED_SECTIONS =
  270. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  271. # the initial value of a variable or define consists of for it to appear in
  272. # the documentation. If the initializer consists of more lines than specified
  273. # here it will be hidden. Use a value of 0 to hide initializers completely.
  274. # The appearance of the initializer of individual variables and defines in the
  275. # documentation can be controlled using \showinitializer or \hideinitializer
  276. # command in the documentation regardless of this setting.
  277. MAX_INITIALIZER_LINES = 5
  278. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  279. # at the bottom of the documentation of classes and structs. If set to YES the
  280. # list will mention the files that were used to generate the documentation.
  281. SHOW_USED_FILES = YES
  282. # If the sources in your project are distributed over multiple directories
  283. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  284. # in the documentation. The default is NO.
  285. SHOW_DIRECTORIES = YES
  286. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  287. # doxygen should invoke to get the current version for each file (typically from the
  288. # version control system). Doxygen will invoke the program by executing (via
  289. # popen()) the command <command> <input-file>, where <command> is the value of
  290. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  291. # provided by doxygen. Whatever the program writes to standard output
  292. # is used as the file version. See the manual for examples.
  293. FILE_VERSION_FILTER =
  294. #---------------------------------------------------------------------------
  295. # configuration options related to warning and progress messages
  296. #---------------------------------------------------------------------------
  297. # The QUIET tag can be used to turn on/off the messages that are generated
  298. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  299. QUIET = NO
  300. # The WARNINGS tag can be used to turn on/off the warning messages that are
  301. # generated by doxygen. Possible values are YES and NO. If left blank
  302. # NO is used.
  303. WARNINGS = YES
  304. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  305. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  306. # automatically be disabled.
  307. WARN_IF_UNDOCUMENTED = YES
  308. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  309. # potential errors in the documentation, such as not documenting some
  310. # parameters in a documented function, or documenting parameters that
  311. # don't exist or using markup commands wrongly.
  312. WARN_IF_DOC_ERROR = YES
  313. # This WARN_NO_PARAMDOC option can be abled to get warnings for
  314. # functions that are documented, but have no documentation for their parameters
  315. # or return value. If set to NO (the default) doxygen will only warn about
  316. # wrong or incomplete parameter documentation, but not about the absence of
  317. # documentation.
  318. WARN_NO_PARAMDOC = NO
  319. # The WARN_FORMAT tag determines the format of the warning messages that
  320. # doxygen can produce. The string should contain the $file, $line, and $text
  321. # tags, which will be replaced by the file and line number from which the
  322. # warning originated and the warning text. Optionally the format may contain
  323. # $version, which will be replaced by the version of the file (if it could
  324. # be obtained via FILE_VERSION_FILTER)
  325. WARN_FORMAT =
  326. # The WARN_LOGFILE tag can be used to specify a file to which warning
  327. # and error messages should be written. If left blank the output is written
  328. # to stderr.
  329. WARN_LOGFILE =
  330. #---------------------------------------------------------------------------
  331. # configuration options related to the input files
  332. #---------------------------------------------------------------------------
  333. # The INPUT tag can be used to specify the files and/or directories that contain
  334. # documented source files. You may enter file names like "myfile.cpp" or
  335. # directories like "/usr/src/myproject". Separate the files or directories
  336. # with spaces.
  337. INPUT = ./ \
  338. agi \
  339. apps \
  340. bridges \
  341. cdr \
  342. channels \
  343. channels/sip \
  344. channels/misdn \
  345. codecs \
  346. formats \
  347. funcs \
  348. include \
  349. include/asterisk \
  350. include/asterisk/doxygen \
  351. main \
  352. main/stdtime \
  353. pbx \
  354. res \
  355. res/ael \
  356. res/ais \
  357. res/snmp
  358. # This tag can be used to specify the character encoding of the source files that
  359. # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
  360. # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
  361. # See http://www.gnu.org/software/libiconv for the list of possible encodings.
  362. INPUT_ENCODING = UTF-8
  363. # If the value of the INPUT tag contains directories, you can use the
  364. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  365. # and *.h) to filter out the source-files in the directories. If left
  366. # blank the following patterns are tested:
  367. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  368. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
  369. FILE_PATTERNS = *.c \
  370. *.h
  371. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  372. # should be searched for input files as well. Possible values are YES and NO.
  373. # If left blank NO is used.
  374. RECURSIVE = NO
  375. # The EXCLUDE tag can be used to specify files and/or directories that should
  376. # excluded from the INPUT source files. This way you can easily exclude a
  377. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  378. EXCLUDE =
  379. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  380. # directories that are symbolic links (a Unix filesystem feature) are excluded
  381. # from the input.
  382. EXCLUDE_SYMLINKS = NO
  383. # If the value of the INPUT tag contains directories, you can use the
  384. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  385. # certain files from those directories. Note that the wildcards are matched
  386. # against the file with absolute path, so to exclude all test directories
  387. # for example use the pattern */test/*
  388. EXCLUDE_PATTERNS =
  389. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  390. # (namespaces, classes, functions, etc.) that should be excluded from the output.
  391. # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
  392. # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
  393. EXCLUDE_SYMBOLS =
  394. # The EXAMPLE_PATH tag can be used to specify one or more files or
  395. # directories that contain example code fragments that are included (see
  396. # the \include command).
  397. EXAMPLE_PATH = ./ \
  398. doc \
  399. configs
  400. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  401. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  402. # and *.h) to filter out the source-files in the directories. If left
  403. # blank all files are included.
  404. EXAMPLE_PATTERNS =
  405. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  406. # searched for input files to be used with the \include or \dontinclude
  407. # commands irrespective of the value of the RECURSIVE tag.
  408. # Possible values are YES and NO. If left blank NO is used.
  409. EXAMPLE_RECURSIVE = NO
  410. # The IMAGE_PATH tag can be used to specify one or more files or
  411. # directories that contain image that are included in the documentation (see
  412. # the \image command).
  413. IMAGE_PATH = images
  414. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  415. # invoke to filter for each input file. Doxygen will invoke the filter program
  416. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  417. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  418. # input file. Doxygen will then use the output that the filter program writes
  419. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  420. # ignored.
  421. INPUT_FILTER =
  422. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  423. # basis. Doxygen will compare the file name with each pattern and apply the
  424. # filter if there is a match. The filters are a list of the form:
  425. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  426. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  427. # is applied to all files.
  428. FILTER_PATTERNS =
  429. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  430. # INPUT_FILTER) will be used to filter the input files when producing source
  431. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  432. FILTER_SOURCE_FILES = NO
  433. #---------------------------------------------------------------------------
  434. # configuration options related to source browsing
  435. #---------------------------------------------------------------------------
  436. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  437. # be generated. Documented entities will be cross-referenced with these sources.
  438. # Note: To get rid of all source code in the generated output, make sure also
  439. # VERBATIM_HEADERS is set to NO.
  440. SOURCE_BROWSER = YES
  441. # Setting the INLINE_SOURCES tag to YES will include the body
  442. # of functions and classes directly in the documentation.
  443. INLINE_SOURCES = YES
  444. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  445. # doxygen to hide any special comment blocks from generated source code
  446. # fragments. Normal C and C++ comments will always remain visible.
  447. STRIP_CODE_COMMENTS = NO
  448. # If the REFERENCED_BY_RELATION tag is set to YES (the default)
  449. # then for each documented function all documented
  450. # functions referencing it will be listed.
  451. REFERENCED_BY_RELATION = YES
  452. # If the REFERENCES_RELATION tag is set to YES (the default)
  453. # then for each documented function all documented entities
  454. # called/used by that function will be listed.
  455. REFERENCES_RELATION = YES
  456. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  457. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  458. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  459. # link to the source code. Otherwise they will link to the documentstion.
  460. REFERENCES_LINK_SOURCE = YES
  461. # If the USE_HTAGS tag is set to YES then the references to source code
  462. # will point to the HTML generated by the htags(1) tool instead of doxygen
  463. # built-in source browser. The htags tool is part of GNU's global source
  464. # tagging system (see http://www.gnu.org/software/global/global.html). You
  465. # will need version 4.8.6 or higher.
  466. USE_HTAGS = NO
  467. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  468. # will generate a verbatim copy of the header file for each class for
  469. # which an include is specified. Set to NO to disable this.
  470. VERBATIM_HEADERS = YES
  471. #---------------------------------------------------------------------------
  472. # configuration options related to the alphabetical class index
  473. #---------------------------------------------------------------------------
  474. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  475. # of all compounds will be generated. Enable this if the project
  476. # contains a lot of classes, structs, unions or interfaces.
  477. ALPHABETICAL_INDEX = YES
  478. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  479. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  480. # in which this list will be split (can be a number in the range [1..20])
  481. COLS_IN_ALPHA_INDEX = 5
  482. # In case all classes in a project start with a common prefix, all
  483. # classes will be put under the same header in the alphabetical index.
  484. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  485. # should be ignored while generating the index headers.
  486. IGNORE_PREFIX =
  487. #---------------------------------------------------------------------------
  488. # configuration options related to the HTML output
  489. #---------------------------------------------------------------------------
  490. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  491. # generate HTML output.
  492. GENERATE_HTML = YES
  493. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  494. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  495. # put in front of it. If left blank `html' will be used as the default path.
  496. HTML_OUTPUT =
  497. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  498. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  499. # doxygen will generate files with .html extension.
  500. HTML_FILE_EXTENSION = .html
  501. # The HTML_HEADER tag can be used to specify a personal HTML header for
  502. # each generated HTML page. If it is left blank doxygen will generate a
  503. # standard header.
  504. HTML_HEADER = contrib/asterisk-doxygen-header
  505. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  506. # each generated HTML page. If it is left blank doxygen will generate a
  507. # standard footer.
  508. HTML_FOOTER =
  509. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  510. # style sheet that is used by each HTML page. It can be used to
  511. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  512. # will generate a default style sheet. Note that doxygen will try to copy
  513. # the style sheet file to the HTML output directory, so don't put your own
  514. # stylesheet in the HTML output directory as well, or it will be erased!
  515. HTML_STYLESHEET =
  516. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  517. # files or namespaces will be aligned in HTML using tables. If set to
  518. # NO a bullet list will be used.
  519. HTML_ALIGN_MEMBERS = YES
  520. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  521. # will be generated that can be used as input for tools like the
  522. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  523. # of the generated HTML documentation.
  524. GENERATE_HTMLHELP = NO
  525. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  526. # be used to specify the file name of the resulting .chm file. You
  527. # can add a path in front of the file if the result should not be
  528. # written to the html output directory.
  529. CHM_FILE =
  530. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  531. # be used to specify the location (absolute path including file name) of
  532. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  533. # the HTML help compiler on the generated index.hhp.
  534. HHC_LOCATION =
  535. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  536. # controls if a separate .chi index file is generated (YES) or that
  537. # it should be included in the master .chm file (NO).
  538. GENERATE_CHI = NO
  539. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  540. # controls whether a binary table of contents is generated (YES) or a
  541. # normal table of contents (NO) in the .chm file.
  542. BINARY_TOC = NO
  543. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  544. # to the contents of the HTML help documentation and to the tree view.
  545. TOC_EXPAND = NO
  546. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  547. # top of each HTML page. The value NO (the default) enables the index and
  548. # the value YES disables it.
  549. DISABLE_INDEX = NO
  550. # This tag can be used to set the number of enum values (range [1..20])
  551. # that doxygen will group on one line in the generated HTML documentation.
  552. ENUM_VALUES_PER_LINE = 4
  553. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  554. # generated containing a tree-like index structure (just like the one that
  555. # is generated for HTML Help). For this to work a browser that supports
  556. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
  557. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  558. # probably better off using the HTML help feature.
  559. GENERATE_TREEVIEW = YES
  560. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  561. # used to set the initial width (in pixels) of the frame in which the tree
  562. # is shown.
  563. TREEVIEW_WIDTH = 250
  564. #---------------------------------------------------------------------------
  565. # configuration options related to the LaTeX output
  566. #---------------------------------------------------------------------------
  567. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  568. # generate Latex output.
  569. GENERATE_LATEX = NO
  570. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  571. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  572. # put in front of it. If left blank `latex' will be used as the default path.
  573. LATEX_OUTPUT =
  574. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  575. # invoked. If left blank `latex' will be used as the default command name.
  576. LATEX_CMD_NAME = latex
  577. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  578. # generate index for LaTeX. If left blank `makeindex' will be used as the
  579. # default command name.
  580. MAKEINDEX_CMD_NAME = makeindex
  581. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  582. # LaTeX documents. This may be useful for small projects and may help to
  583. # save some trees in general.
  584. COMPACT_LATEX = NO
  585. # The PAPER_TYPE tag can be used to set the paper type that is used
  586. # by the printer. Possible values are: a4, a4wide, letter, legal and
  587. # executive. If left blank a4wide will be used.
  588. PAPER_TYPE = a4wide
  589. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  590. # packages that should be included in the LaTeX output.
  591. EXTRA_PACKAGES =
  592. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  593. # the generated latex document. The header should contain everything until
  594. # the first chapter. If it is left blank doxygen will generate a
  595. # standard header. Notice: only use this tag if you know what you are doing!
  596. LATEX_HEADER =
  597. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  598. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  599. # contain links (just like the HTML output) instead of page references
  600. # This makes the output suitable for online browsing using a pdf viewer.
  601. PDF_HYPERLINKS = NO
  602. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  603. # plain latex in the generated Makefile. Set this option to YES to get a
  604. # higher quality PDF documentation.
  605. USE_PDFLATEX = NO
  606. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  607. # command to the generated LaTeX files. This will instruct LaTeX to keep
  608. # running if errors occur, instead of asking the user for help.
  609. # This option is also used when generating formulas in HTML.
  610. LATEX_BATCHMODE = NO
  611. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  612. # include the index chapters (such as File Index, Compound Index, etc.)
  613. # in the output.
  614. LATEX_HIDE_INDICES = NO
  615. #---------------------------------------------------------------------------
  616. # configuration options related to the RTF output
  617. #---------------------------------------------------------------------------
  618. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  619. # The RTF output is optimized for Word 97 and may not look very pretty with
  620. # other RTF readers or editors.
  621. GENERATE_RTF = NO
  622. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  623. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  624. # put in front of it. If left blank `rtf' will be used as the default path.
  625. RTF_OUTPUT =
  626. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  627. # RTF documents. This may be useful for small projects and may help to
  628. # save some trees in general.
  629. COMPACT_RTF = NO
  630. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  631. # will contain hyperlink fields. The RTF file will
  632. # contain links (just like the HTML output) instead of page references.
  633. # This makes the output suitable for online browsing using WORD or other
  634. # programs which support those fields.
  635. # Note: wordpad (write) and others do not support links.
  636. RTF_HYPERLINKS = NO
  637. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  638. # config file, i.e. a series of assignments. You only have to provide
  639. # replacements, missing definitions are set to their default value.
  640. RTF_STYLESHEET_FILE =
  641. # Set optional variables used in the generation of an rtf document.
  642. # Syntax is similar to doxygen's config file.
  643. RTF_EXTENSIONS_FILE =
  644. #---------------------------------------------------------------------------
  645. # configuration options related to the man page output
  646. #---------------------------------------------------------------------------
  647. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  648. # generate man pages
  649. GENERATE_MAN = NO
  650. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  651. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  652. # put in front of it. If left blank `man' will be used as the default path.
  653. MAN_OUTPUT =
  654. # The MAN_EXTENSION tag determines the extension that is added to
  655. # the generated man pages (default is the subroutine's section .3)
  656. MAN_EXTENSION =
  657. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  658. # then it will generate one additional man file for each entity
  659. # documented in the real man page(s). These additional files
  660. # only source the real man page, but without them the man command
  661. # would be unable to find the correct page. The default is NO.
  662. MAN_LINKS = NO
  663. #---------------------------------------------------------------------------
  664. # configuration options related to the XML output
  665. #---------------------------------------------------------------------------
  666. # If the GENERATE_XML tag is set to YES Doxygen will
  667. # generate an XML file that captures the structure of
  668. # the code including all documentation.
  669. GENERATE_XML = NO
  670. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  671. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  672. # put in front of it. If left blank `xml' will be used as the default path.
  673. XML_OUTPUT = xml
  674. # The XML_SCHEMA tag can be used to specify an XML schema,
  675. # which can be used by a validating XML parser to check the
  676. # syntax of the XML files.
  677. XML_SCHEMA =
  678. # The XML_DTD tag can be used to specify an XML DTD,
  679. # which can be used by a validating XML parser to check the
  680. # syntax of the XML files.
  681. XML_DTD =
  682. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  683. # dump the program listings (including syntax highlighting
  684. # and cross-referencing information) to the XML output. Note that
  685. # enabling this will significantly increase the size of the XML output.
  686. XML_PROGRAMLISTING = YES
  687. #---------------------------------------------------------------------------
  688. # configuration options for the AutoGen Definitions output
  689. #---------------------------------------------------------------------------
  690. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  691. # generate an AutoGen Definitions (see autogen.sf.net) file
  692. # that captures the structure of the code including all
  693. # documentation. Note that this feature is still experimental
  694. # and incomplete at the moment.
  695. GENERATE_AUTOGEN_DEF = NO
  696. #---------------------------------------------------------------------------
  697. # configuration options related to the Perl module output
  698. #---------------------------------------------------------------------------
  699. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  700. # generate a Perl module file that captures the structure of
  701. # the code including all documentation. Note that this
  702. # feature is still experimental and incomplete at the
  703. # moment.
  704. GENERATE_PERLMOD = NO
  705. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  706. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  707. # to generate PDF and DVI output from the Perl module output.
  708. PERLMOD_LATEX = NO
  709. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  710. # nicely formatted so it can be parsed by a human reader. This is useful
  711. # if you want to understand what is going on. On the other hand, if this
  712. # tag is set to NO the size of the Perl module output will be much smaller
  713. # and Perl will parse it just the same.
  714. PERLMOD_PRETTY = YES
  715. # The names of the make variables in the generated doxyrules.make file
  716. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  717. # This is useful so different doxyrules.make files included by the same
  718. # Makefile don't overwrite each other's variables.
  719. PERLMOD_MAKEVAR_PREFIX =
  720. #---------------------------------------------------------------------------
  721. # Configuration options related to the preprocessor
  722. #---------------------------------------------------------------------------
  723. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  724. # evaluate all C-preprocessor directives found in the sources and include
  725. # files.
  726. ENABLE_PREPROCESSING = YES
  727. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  728. # names in the source code. If set to NO (the default) only conditional
  729. # compilation will be performed. Macro expansion can be done in a controlled
  730. # way by setting EXPAND_ONLY_PREDEF to YES.
  731. MACRO_EXPANSION = YES
  732. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  733. # then the macro expansion is limited to the macros specified with the
  734. # PREDEFINED and EXPAND_AS_DEFINED tags.
  735. EXPAND_ONLY_PREDEF = YES
  736. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  737. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  738. SEARCH_INCLUDES = YES
  739. # The INCLUDE_PATH tag can be used to specify one or more directories that
  740. # contain include files that are not input files but should be processed by
  741. # the preprocessor.
  742. INCLUDE_PATH = include/ include/asterisk/
  743. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  744. # patterns (like *.h and *.hpp) to filter out the header-files in the
  745. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  746. # be used.
  747. INCLUDE_FILE_PATTERNS =
  748. # The PREDEFINED tag can be used to specify one or more macro names that
  749. # are defined before the preprocessor is started (similar to the -D option of
  750. # gcc). The argument of the tag is a list of macros of the form: name
  751. # or name=definition (no spaces). If the definition and the = are
  752. # omitted =1 is assumed. To prevent a macro definition from being
  753. # undefined via #undef or recursively expanded use the := operator
  754. # instead of the = operator.
  755. PREDEFINED = \
  756. __GNUC__ \
  757. __attribute__(x)=
  758. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  759. # this tag can be used to specify a list of macro names that should be expanded.
  760. # The macro definition that is found in the sources will be used.
  761. # Use the PREDEFINED tag if you want to use a different macro definition.
  762. EXPAND_AS_DEFINED = \
  763. AST_INLINE_API \
  764. AST_DECLARE_STRING_FIELDS \
  765. AST_STRING_FIELD \
  766. AST_THREADSTORAGE \
  767. AST_THREADSTORAGE_CUSTOM \
  768. AST_MODULE_INFO \
  769. AST_MODULE_INFO_STANDARD \
  770. __AST_MUTEX_DEFINE \
  771. AST_MUTEX_DEFINE_STATIC \
  772. AST_MUTEX_DEFINE_STATIC_NOTRACKING \
  773. __AST_RWLOCK_DEFINE \
  774. AST_RWLOCK_DEFINE_STATIC \
  775. AST_LIST_HEAD \
  776. AST_RWLIST_HEAD \
  777. AST_LIST_HEAD_NOLOCK \
  778. AST_LIST_HEAD_STATIC \
  779. AST_RWLIST_HEAD_STATIC \
  780. AST_LIST_HEAD_NOLOCK_STATIC \
  781. AST_LIST_ENTRY \
  782. AST_RWLIST_ENTRY \
  783. __ASTOBJ_HASH \
  784. ASTOBJ_COMPONENTS_NOLOCK_FULL \
  785. ASTOBJ_COMPONENTS_NOLOCK \
  786. ASTOBJ_COMPONENTS_FULL \
  787. ASTOBJ_COMPONENTS \
  788. AST_IVR_DECLARE_MENU \
  789. AST_DECLARE_APP_ARGS \
  790. AST_DEFINE_APP_ARGS_TYPE \
  791. AST_APP_ARG \
  792. BEGIN_OPTIONS \
  793. END_OPTIONS \
  794. AST_APP_OPTIONS \
  795. AST_APP_OPTION \
  796. AST_APP_OPTION_ARG \
  797. AST_DLLIST_HEAD \
  798. AST_DLLIST_HEAD_STATIC \
  799. AST_DLLIST_HEAD_NOLOCK \
  800. AST_DLLIST_HEAD_NOLOCK_STATIC \
  801. AST_RWDLLIST_HEAD \
  802. AST_RWDLLIST_HEAD_STATIC \
  803. AST_DLLIST_ENTRY \
  804. AST_RWDLLIST_ENTRY \
  805. AST_CLI_DEFINE \
  806. AST_OPTIONAL_API \
  807. AST_OPTIONAL_API_ATTR
  808. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  809. # doxygen's preprocessor will remove all function-like macros that are alone
  810. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  811. # function macros are typically used for boiler-plate code, and will confuse
  812. # the parser if not removed.
  813. SKIP_FUNCTION_MACROS = YES
  814. #---------------------------------------------------------------------------
  815. # Configuration::additions related to external references
  816. #---------------------------------------------------------------------------
  817. # The TAGFILES option can be used to specify one or more tagfiles.
  818. # Optionally an initial location of the external documentation
  819. # can be added for each tagfile. The format of a tag file without
  820. # this location is as follows:
  821. # TAGFILES = file1 file2 ...
  822. # Adding location for the tag files is done as follows:
  823. # TAGFILES = file1=loc1 "file2 = loc2" ...
  824. # where "loc1" and "loc2" can be relative or absolute paths or
  825. # URLs. If a location is present for each tag, the installdox tool
  826. # does not have to be run to correct the links.
  827. # Note that each tag file must have a unique name
  828. # (where the name does NOT include the path)
  829. # If a tag file is not located in the directory in which doxygen
  830. # is run, you must also specify the path to the tagfile here.
  831. TAGFILES =
  832. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  833. # a tag file that is based on the input files it reads.
  834. GENERATE_TAGFILE =
  835. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  836. # in the class index. If set to NO only the inherited external classes
  837. # will be listed.
  838. ALLEXTERNALS = NO
  839. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  840. # in the modules index. If set to NO, only the current project's groups will
  841. # be listed.
  842. EXTERNAL_GROUPS = YES
  843. # The PERL_PATH should be the absolute path and name of the perl script
  844. # interpreter (i.e. the result of `which perl').
  845. PERL_PATH = /usr/bin/perl
  846. #---------------------------------------------------------------------------
  847. # Configuration options related to the dot tool
  848. #---------------------------------------------------------------------------
  849. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  850. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  851. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  852. # this option is superseded by the HAVE_DOT option below. This is only a
  853. # fallback. It is recommended to install and use dot, since it yields more
  854. # powerful graphs.
  855. CLASS_DIAGRAMS = NO
  856. # You can define message sequence charts within doxygen comments using the \msc
  857. # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
  858. # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
  859. # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
  860. # be found in the default search path.
  861. MSCGEN_PATH =
  862. # If set to YES, the inheritance and collaboration graphs will hide
  863. # inheritance and usage relations if the target is undocumented
  864. # or is not a class.
  865. HIDE_UNDOC_RELATIONS = YES
  866. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  867. # available from the path. This tool is part of Graphviz, a graph visualization
  868. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  869. # have no effect if this option is set to NO (the default)
  870. HAVE_DOT = NO
  871. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  872. # will generate a graph for each documented class showing the direct and
  873. # indirect inheritance relations. Setting this tag to YES will force the
  874. # the CLASS_DIAGRAMS tag to NO.
  875. CLASS_GRAPH = YES
  876. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  877. # will generate a graph for each documented class showing the direct and
  878. # indirect implementation dependencies (inheritance, containment, and
  879. # class references variables) of the class with other documented classes.
  880. COLLABORATION_GRAPH = YES
  881. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  882. # will generate a graph for groups, showing the direct groups dependencies
  883. GROUP_GRAPHS = YES
  884. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  885. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  886. # Language.
  887. UML_LOOK = NO
  888. # If set to YES, the inheritance and collaboration graphs will show the
  889. # relations between templates and their instances.
  890. TEMPLATE_RELATIONS = YES
  891. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  892. # tags are set to YES then doxygen will generate a graph for each documented
  893. # file showing the direct and indirect include dependencies of the file with
  894. # other documented files.
  895. INCLUDE_GRAPH = YES
  896. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  897. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  898. # documented header file showing the documented files that directly or
  899. # indirectly include this file.
  900. INCLUDED_BY_GRAPH = YES
  901. # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
  902. # generate a call dependency graph for every global function or class method.
  903. # Note that enabling this option will significantly increase the time of a run.
  904. # So in most cases it will be better to enable call graphs for selected
  905. # functions only using the \callgraph command.
  906. CALL_GRAPH = NO
  907. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
  908. # generate a caller dependency graph for every global function or class method.
  909. # Note that enabling this option will significantly increase the time of a run.
  910. # So in most cases it will be better to enable caller graphs for selected
  911. # functions only using the \callergraph command.
  912. CALLER_GRAPH = NO
  913. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  914. # will graphical hierarchy of all classes instead of a textual one.
  915. GRAPHICAL_HIERARCHY = YES
  916. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  917. # then doxygen will show the dependencies a directory has on other directories
  918. # in a graphical way. The dependency relations are determined by the #include
  919. # relations between the files in the directories.
  920. DIRECTORY_GRAPH = YES
  921. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  922. # generated by dot. Possible values are png, jpg, or gif
  923. # If left blank png will be used.
  924. DOT_IMAGE_FORMAT = png
  925. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  926. # found. If left blank, it is assumed the dot tool can be found in the path.
  927. DOT_PATH =
  928. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  929. # contain dot files that are included in the documentation (see the
  930. # \dotfile command).
  931. DOTFILE_DIRS =
  932. # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  933. # nodes that will be shown in the graph. If the number of nodes in a graph
  934. # becomes larger than this value, doxygen will truncate the graph, which is
  935. # visualized by representing a node as a red box. Note that doxygen will always
  936. # show the root nodes and its direct children regardless of this setting.
  937. DOT_GRAPH_MAX_NODES = 50
  938. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  939. # background. This is disabled by default, which results in a white background.
  940. # Warning: Depending on the platform used, enabling this option may lead to
  941. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  942. # read).
  943. DOT_TRANSPARENT = NO
  944. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  945. # files in one run (i.e. multiple -o and -T options on the command line). This
  946. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  947. # support this, this feature is disabled by default.
  948. DOT_MULTI_TARGETS = NO
  949. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  950. # generate a legend page explaining the meaning of the various boxes and
  951. # arrows in the dot generated graphs.
  952. GENERATE_LEGEND = YES
  953. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  954. # remove the intermediate dot files that are used to generate
  955. # the various graphs.
  956. DOT_CLEANUP = YES
  957. #---------------------------------------------------------------------------
  958. # Configuration::additions related to the search engine
  959. #---------------------------------------------------------------------------
  960. # The SEARCHENGINE tag specifies whether or not a search engine should be
  961. # used. If set to NO the values of all tags below this one will be ignored.
  962. SEARCHENGINE = NO