doxygen.cfg 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046
  1. # Doxyfile 1.3-rc3
  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. # General configuration options
  13. #---------------------------------------------------------------------------
  14. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  15. # by quotes) that should identify the project.
  16. PROJECT_NAME = "PJNATH Reference"
  17. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  18. # This could be handy for archiving the generated documentation or
  19. # if some version control system is used.
  20. PROJECT_NUMBER = $(PJ_VERSION)
  21. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  22. # base path where the generated documentation will be put.
  23. # If a relative path is entered, it will be relative to the location
  24. # where doxygen was started. If left blank the current directory will be used.
  25. OUTPUT_DIRECTORY = docs/$(PJ_VERSION)
  26. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  27. # documentation generated by doxygen is written. Doxygen will use this
  28. # information to generate all constant output in the proper language.
  29. # The default language is English, other supported languages are:
  30. # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
  31. # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
  32. # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
  33. # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
  34. OUTPUT_LANGUAGE = English
  35. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  36. # documentation are documented, even if no documentation was available.
  37. # Private class members and static file members will be hidden unless
  38. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  39. EXTRACT_ALL = NO
  40. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  41. # will be included in the documentation.
  42. EXTRACT_PRIVATE = NO
  43. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  44. # will be included in the documentation.
  45. EXTRACT_STATIC = NO
  46. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  47. # defined locally in source files will be included in the documentation.
  48. # If set to NO only classes defined in header files are included.
  49. EXTRACT_LOCAL_CLASSES = YES
  50. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  51. # undocumented members of documented classes, files or namespaces.
  52. # If set to NO (the default) these members will be included in the
  53. # various overviews, but no documentation section is generated.
  54. # This option has no effect if EXTRACT_ALL is enabled.
  55. HIDE_UNDOC_MEMBERS = NO
  56. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  57. # undocumented classes that are normally visible in the class hierarchy.
  58. # If set to NO (the default) these class will be included in the various
  59. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  60. HIDE_UNDOC_CLASSES = NO
  61. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  62. # friend (class|struct|union) declarations.
  63. # If set to NO (the default) these declarations will be included in the
  64. # documentation.
  65. HIDE_FRIEND_COMPOUNDS = NO
  66. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  67. # documentation blocks found inside the body of a function.
  68. # If set to NO (the default) these blocks will be appended to the
  69. # function's detailed documentation block.
  70. HIDE_IN_BODY_DOCS = NO
  71. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  72. # include brief member descriptions after the members that are listed in
  73. # the file and class documentation (similar to JavaDoc).
  74. # Set to NO to disable this.
  75. BRIEF_MEMBER_DESC = YES
  76. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  77. # the brief description of a member or function before the detailed description.
  78. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  79. # brief descriptions will be completely suppressed.
  80. REPEAT_BRIEF = NO
  81. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  82. # Doxygen will generate a detailed section even if there is only a brief
  83. # description.
  84. ALWAYS_DETAILED_SEC = NO
  85. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
  86. # members of a class in the documentation of that class as if those members were
  87. # ordinary class members. Constructors, destructors and assignment operators of
  88. # the base classes will not be shown.
  89. INLINE_INHERITED_MEMB = NO
  90. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  91. # path before files name in the file list and in the header files. If set
  92. # to NO the shortest path that makes the file name unique will be used.
  93. FULL_PATH_NAMES = NO
  94. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  95. # can be used to strip a user defined part of the path. Stripping is
  96. # only done if one of the specified strings matches the left-hand part of
  97. # the path. It is allowed to use relative paths in the argument list.
  98. STRIP_FROM_PATH = "c:\project\pjproject"
  99. # The INTERNAL_DOCS tag determines if documentation
  100. # that is typed after a \internal command is included. If the tag is set
  101. # to NO (the default) then the documentation will be excluded.
  102. # Set it to YES to include the internal documentation.
  103. INTERNAL_DOCS = NO
  104. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  105. # file names in lower case letters. If set to YES upper case letters are also
  106. # allowed. This is useful if you have classes or files whose names only differ
  107. # in case and if your file system supports case sensitive file names. Windows
  108. # users are adviced to set this option to NO.
  109. CASE_SENSE_NAMES = YES
  110. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  111. # (but less readable) file names. This can be useful is your file systems
  112. # doesn't support long names like on DOS, Mac, or CD-ROM.
  113. SHORT_NAMES = NO
  114. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  115. # will show members with their full class and namespace scopes in the
  116. # documentation. If set to YES the scope will be hidden.
  117. HIDE_SCOPE_NAMES = NO
  118. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  119. # will generate a verbatim copy of the header file for each class for
  120. # which an include is specified. Set to NO to disable this.
  121. VERBATIM_HEADERS = YES
  122. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  123. # will put list of the files that are included by a file in the documentation
  124. # of that file.
  125. SHOW_INCLUDE_FILES = NO
  126. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  127. # will interpret the first line (until the first dot) of a JavaDoc-style
  128. # comment as the brief description. If set to NO, the JavaDoc
  129. # comments will behave just like the Qt-style comments (thus requiring an
  130. # explict @brief command for a brief description.
  131. JAVADOC_AUTOBRIEF = NO
  132. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  133. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  134. # comments) as a brief description. This used to be the default behaviour.
  135. # The new default is to treat a multi-line C++ comment block as a detailed
  136. # description. Set this tag to YES if you prefer the old behaviour instead.
  137. MULTILINE_CPP_IS_BRIEF = NO
  138. # If the DETAILS_AT_TOP tag is set to YES then Doxygen
  139. # will output the detailed description near the top, like JavaDoc.
  140. # If set to NO, the detailed description appears after the member
  141. # documentation.
  142. DETAILS_AT_TOP = YES
  143. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  144. # member inherits the documentation from any documented member that it
  145. # reimplements.
  146. INHERIT_DOCS = YES
  147. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  148. # is inserted in the documentation for inline members.
  149. INLINE_INFO = YES
  150. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  151. # will sort the (detailed) documentation of file and class members
  152. # alphabetically by member name. If set to NO the members will appear in
  153. # declaration order.
  154. SORT_MEMBER_DOCS = YES
  155. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  156. # tag is set to YES, then doxygen will reuse the documentation of the first
  157. # member in the group (if any) for the other members of the group. By default
  158. # all members of a group must be documented explicitly.
  159. DISTRIBUTE_GROUP_DOC = NO
  160. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  161. # Doxygen uses this value to replace tabs by spaces in code fragments.
  162. TAB_SIZE = 8
  163. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  164. # disable (NO) the todo list. This list is created by putting \todo
  165. # commands in the documentation.
  166. GENERATE_TODOLIST = YES
  167. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  168. # disable (NO) the test list. This list is created by putting \test
  169. # commands in the documentation.
  170. GENERATE_TESTLIST = YES
  171. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  172. # disable (NO) the bug list. This list is created by putting \bug
  173. # commands in the documentation.
  174. GENERATE_BUGLIST = YES
  175. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  176. # disable (NO) the deprecated list. This list is created by putting
  177. # \deprecated commands in the documentation.
  178. GENERATE_DEPRECATEDLIST= YES
  179. # This tag can be used to specify a number of aliases that acts
  180. # as commands in the documentation. An alias has the form "name=value".
  181. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  182. # put the command \sideeffect (or @sideeffect) in the documentation, which
  183. # will result in a user defined paragraph with heading "Side Effects:".
  184. # You can put \n's in the value part of an alias to insert newlines.
  185. ALIASES =
  186. ALIASES += src{1}="\verbatim embed:rst:inline :source:`\1` \endverbatim"
  187. ALIASES += srcdir{1}="\verbatim embed:rst:inline :sourcedir:`\1` \endverbatim"
  188. ALIASES += img{1}="<img src=\"https://raw.githubusercontent.com/pjsip/pjproject/master/\1\" />"
  189. ALIASES += img{2}="<img src=\"https://raw.githubusercontent.com/pjsip/pjproject/master/\1\" alt=\"\2\" />"
  190. # The ENABLED_SECTIONS tag can be used to enable conditional
  191. # documentation sections, marked by \if sectionname ... \endif.
  192. ENABLED_SECTIONS =
  193. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  194. # the initial value of a variable or define consist of for it to appear in
  195. # the documentation. If the initializer consists of more lines than specified
  196. # here it will be hidden. Use a value of 0 to hide initializers completely.
  197. # The appearance of the initializer of individual variables and defines in the
  198. # documentation can be controlled using \showinitializer or \hideinitializer
  199. # command in the documentation regardless of this setting.
  200. MAX_INITIALIZER_LINES = 30
  201. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  202. # only. Doxygen will then generate output that is more tailored for C.
  203. # For instance some of the names that are used will be different. The list
  204. # of all members will be omitted, etc.
  205. OPTIMIZE_OUTPUT_FOR_C = YES
  206. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
  207. # only. Doxygen will then generate output that is more tailored for Java.
  208. # For instance namespaces will be presented as packages, qualified scopes
  209. # will look different, etc.
  210. OPTIMIZE_OUTPUT_JAVA = NO
  211. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  212. # at the bottom of the documentation of classes and structs. If set to YES the
  213. # list will mention the files that were used to generate the documentation.
  214. SHOW_USED_FILES = YES
  215. TYPEDEF_HIDES_STRUCT = YES
  216. #---------------------------------------------------------------------------
  217. # configuration options related to warning and progress messages
  218. #---------------------------------------------------------------------------
  219. # The QUIET tag can be used to turn on/off the messages that are generated
  220. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  221. QUIET = NO
  222. # The WARNINGS tag can be used to turn on/off the warning messages that are
  223. # generated by doxygen. Possible values are YES and NO. If left blank
  224. # NO is used.
  225. WARNINGS = YES
  226. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  227. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  228. # automatically be disabled.
  229. WARN_IF_UNDOCUMENTED = YES
  230. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  231. # potential errors in the documentation, such as not documenting some
  232. # parameters in a documented function, or documenting parameters that
  233. # don't exist or using markup commands wrongly.
  234. WARN_IF_DOC_ERROR = YES
  235. # The WARN_FORMAT tag determines the format of the warning messages that
  236. # doxygen can produce. The string should contain the $file, $line, and $text
  237. # tags, which will be replaced by the file and line number from which the
  238. # warning originated and the warning text.
  239. WARN_FORMAT = "$file:$line: $text"
  240. # The WARN_LOGFILE tag can be used to specify a file to which warning
  241. # and error messages should be written. If left blank the output is written
  242. # to stderr.
  243. WARN_LOGFILE =
  244. #---------------------------------------------------------------------------
  245. # configuration options related to the input files
  246. #---------------------------------------------------------------------------
  247. # The INPUT tag can be used to specify the files and/or directories that contain
  248. # documented source files. You may enter file names like "myfile.cpp" or
  249. # directories like "/usr/src/myproject". Separate the files or directories
  250. # with spaces.
  251. INPUT = docs include/pjnath
  252. # If the value of the INPUT tag contains directories, you can use the
  253. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  254. # and *.h) to filter out the source-files in the directories. If left
  255. # blank the following patterns are tested:
  256. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
  257. # *.h++ *.idl *.odl
  258. FILE_PATTERNS = *.h *.c
  259. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  260. # should be searched for input files as well. Possible values are YES and NO.
  261. # If left blank NO is used.
  262. RECURSIVE = YES
  263. # The EXCLUDE tag can be used to specify files and/or directories that should
  264. # excluded from the INPUT source files. This way you can easily exclude a
  265. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  266. EXCLUDE =
  267. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
  268. # that are symbolic links (a Unix filesystem feature) are excluded from the input.
  269. EXCLUDE_SYMLINKS = NO
  270. # If the value of the INPUT tag contains directories, you can use the
  271. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  272. # certain files from those directories.
  273. EXCLUDE_PATTERNS = "*_i.h" "*/compat/*"
  274. # The EXAMPLE_PATH tag can be used to specify one or more files or
  275. # directories that contain example code fragments that are included (see
  276. # the \include command).
  277. EXAMPLE_PATH = ../pjsip-apps/src/samples src/pjturn-client
  278. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  279. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  280. # and *.h) to filter out the source-files in the directories. If left
  281. # blank all files are included.
  282. EXAMPLE_PATTERNS =
  283. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  284. # searched for input files to be used with the \include or \dontinclude
  285. # commands irrespective of the value of the RECURSIVE tag.
  286. # Possible values are YES and NO. If left blank NO is used.
  287. EXAMPLE_RECURSIVE = YES
  288. # The IMAGE_PATH tag can be used to specify one or more files or
  289. # directories that contain image that are included in the documentation (see
  290. # the \image command).
  291. IMAGE_PATH = docs
  292. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  293. # invoke to filter for each input file. Doxygen will invoke the filter program
  294. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  295. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  296. # input file. Doxygen will then use the output that the filter program writes
  297. # to standard output.
  298. INPUT_FILTER =
  299. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  300. # INPUT_FILTER) will be used to filter the input files when producing source
  301. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  302. FILTER_SOURCE_FILES = NO
  303. #---------------------------------------------------------------------------
  304. # configuration options related to source browsing
  305. #---------------------------------------------------------------------------
  306. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  307. # be generated. Documented entities will be cross-referenced with these sources.
  308. SOURCE_BROWSER = NO
  309. # Setting the INLINE_SOURCES tag to YES will include the body
  310. # of functions and classes directly in the documentation.
  311. INLINE_SOURCES = NO
  312. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  313. # doxygen to hide any special comment blocks from generated source code
  314. # fragments. Normal C and C++ comments will always remain visible.
  315. STRIP_CODE_COMMENTS = YES
  316. # If the REFERENCED_BY_RELATION tag is set to YES (the default)
  317. # then for each documented function all documented
  318. # functions referencing it will be listed.
  319. REFERENCED_BY_RELATION = YES
  320. # If the REFERENCES_RELATION tag is set to YES (the default)
  321. # then for each documented function all documented entities
  322. # called/used by that function will be listed.
  323. REFERENCES_RELATION = YES
  324. #---------------------------------------------------------------------------
  325. # configuration options related to the alphabetical class index
  326. #---------------------------------------------------------------------------
  327. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  328. # of all compounds will be generated. Enable this if the project
  329. # contains a lot of classes, structs, unions or interfaces.
  330. ALPHABETICAL_INDEX = NO
  331. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  332. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  333. # in which this list will be split (can be a number in the range [1..20])
  334. COLS_IN_ALPHA_INDEX = 5
  335. # In case all classes in a project start with a common prefix, all
  336. # classes will be put under the same header in the alphabetical index.
  337. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  338. # should be ignored while generating the index headers.
  339. IGNORE_PREFIX =
  340. #---------------------------------------------------------------------------
  341. # configuration options related to the HTML output
  342. #---------------------------------------------------------------------------
  343. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  344. # generate HTML output.
  345. GENERATE_HTML = YES
  346. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  347. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  348. # put in front of it. If left blank `html' will be used as the default path.
  349. HTML_OUTPUT = html
  350. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  351. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  352. # doxygen will generate files with .html extension.
  353. HTML_FILE_EXTENSION = .htm
  354. # The HTML_HEADER tag can be used to specify a personal HTML header for
  355. # each generated HTML page. If it is left blank doxygen will generate a
  356. # standard header.
  357. HTML_HEADER = docs/header.html
  358. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  359. # each generated HTML page. If it is left blank doxygen will generate a
  360. # standard footer.
  361. HTML_FOOTER = docs/footer.html
  362. # The HTML_STYLESHEET tag can be used to specify a user defined cascading
  363. # style sheet that is used by each HTML page. It can be used to
  364. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  365. # will generate a default style sheet
  366. HTML_STYLESHEET = docs/doxygen.css
  367. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  368. # files or namespaces will be aligned in HTML using tables. If set to
  369. # NO a bullet list will be used.
  370. HTML_ALIGN_MEMBERS = YES
  371. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  372. # will be generated that can be used as input for tools like the
  373. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  374. # of the generated HTML documentation.
  375. GENERATE_HTMLHELP = NO
  376. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  377. # be used to specify the file name of the resulting .chm file. You
  378. # can add a path in front of the file if the result should not be
  379. # written to the html output dir.
  380. CHM_FILE =
  381. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  382. # be used to specify the location (absolute path including file name) of
  383. # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
  384. # the html help compiler on the generated index.hhp.
  385. HHC_LOCATION =
  386. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  387. # controls if a separate .chi index file is generated (YES) or that
  388. # it should be included in the master .chm file (NO).
  389. GENERATE_CHI = NO
  390. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  391. # controls whether a binary table of contents is generated (YES) or a
  392. # normal table of contents (NO) in the .chm file.
  393. BINARY_TOC = NO
  394. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  395. # to the contents of the Html help documentation and to the tree view.
  396. TOC_EXPAND = NO
  397. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  398. # top of each HTML page. The value NO (the default) enables the index and
  399. # the value YES disables it.
  400. DISABLE_INDEX = NO
  401. # This tag can be used to set the number of enum values (range [1..20])
  402. # that doxygen will group on one line in the generated HTML documentation.
  403. ENUM_VALUES_PER_LINE = 1
  404. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  405. # generated containing a tree-like index structure (just like the one that
  406. # is generated for HTML Help). For this to work a browser that supports
  407. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla,
  408. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  409. # probably better off using the HTML help feature.
  410. GENERATE_TREEVIEW = NO
  411. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  412. # used to set the initial width (in pixels) of the frame in which the tree
  413. # is shown.
  414. TREEVIEW_WIDTH = 250
  415. #---------------------------------------------------------------------------
  416. # configuration options related to the LaTeX output
  417. #---------------------------------------------------------------------------
  418. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  419. # generate Latex output.
  420. GENERATE_LATEX = NO
  421. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  422. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  423. # put in front of it. If left blank `latex' will be used as the default path.
  424. LATEX_OUTPUT = latex
  425. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  426. # invoked. If left blank `latex' will be used as the default command name.
  427. LATEX_CMD_NAME = latex
  428. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  429. # generate index for LaTeX. If left blank `makeindex' will be used as the
  430. # default command name.
  431. MAKEINDEX_CMD_NAME = makeindex
  432. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  433. # LaTeX documents. This may be useful for small projects and may help to
  434. # save some trees in general.
  435. COMPACT_LATEX = NO
  436. # The PAPER_TYPE tag can be used to set the paper type that is used
  437. # by the printer. Possible values are: a4, a4wide, letter, legal and
  438. # executive. If left blank a4wide will be used.
  439. PAPER_TYPE = a4wide
  440. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  441. # packages that should be included in the LaTeX output.
  442. EXTRA_PACKAGES =
  443. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  444. # the generated latex document. The header should contain everything until
  445. # the first chapter. If it is left blank doxygen will generate a
  446. # standard header. Notice: only use this tag if you know what you are doing!
  447. LATEX_HEADER =
  448. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  449. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  450. # contain links (just like the HTML output) instead of page references
  451. # This makes the output suitable for online browsing using a pdf viewer.
  452. PDF_HYPERLINKS = YES
  453. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  454. # plain latex in the generated Makefile. Set this option to YES to get a
  455. # higher quality PDF documentation.
  456. USE_PDFLATEX = YES
  457. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  458. # command to the generated LaTeX files. This will instruct LaTeX to keep
  459. # running if errors occur, instead of asking the user for help.
  460. # This option is also used when generating formulas in HTML.
  461. LATEX_BATCHMODE = NO
  462. #---------------------------------------------------------------------------
  463. # configuration options related to the RTF output
  464. #---------------------------------------------------------------------------
  465. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  466. # The RTF output is optimised for Word 97 and may not look very pretty with
  467. # other RTF readers or editors.
  468. GENERATE_RTF = NO
  469. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  470. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  471. # put in front of it. If left blank `rtf' will be used as the default path.
  472. RTF_OUTPUT = rtf
  473. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  474. # RTF documents. This may be useful for small projects and may help to
  475. # save some trees in general.
  476. COMPACT_RTF = NO
  477. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  478. # will contain hyperlink fields. The RTF file will
  479. # contain links (just like the HTML output) instead of page references.
  480. # This makes the output suitable for online browsing using WORD or other
  481. # programs which support those fields.
  482. # Note: wordpad (write) and others do not support links.
  483. RTF_HYPERLINKS = NO
  484. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  485. # config file, i.e. a series of assigments. You only have to provide
  486. # replacements, missing definitions are set to their default value.
  487. RTF_STYLESHEET_FILE =
  488. # Set optional variables used in the generation of an rtf document.
  489. # Syntax is similar to doxygen's config file.
  490. RTF_EXTENSIONS_FILE =
  491. #---------------------------------------------------------------------------
  492. # configuration options related to the man page output
  493. #---------------------------------------------------------------------------
  494. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  495. # generate man pages
  496. GENERATE_MAN = NO
  497. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  498. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  499. # put in front of it. If left blank `man' will be used as the default path.
  500. MAN_OUTPUT = man
  501. # The MAN_EXTENSION tag determines the extension that is added to
  502. # the generated man pages (default is the subroutine's section .3)
  503. MAN_EXTENSION = .3
  504. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  505. # then it will generate one additional man file for each entity
  506. # documented in the real man page(s). These additional files
  507. # only source the real man page, but without them the man command
  508. # would be unable to find the correct page. The default is NO.
  509. MAN_LINKS = NO
  510. #---------------------------------------------------------------------------
  511. # configuration options related to the XML output
  512. #---------------------------------------------------------------------------
  513. # If the GENERATE_XML tag is set to YES Doxygen will
  514. # generate an XML file that captures the structure of
  515. # the code including all documentation. Note that this
  516. # feature is still experimental and incomplete at the
  517. # moment.
  518. GENERATE_XML = YES
  519. # The XML_SCHEMA tag can be used to specify an XML schema,
  520. # which can be used by a validating XML parser to check the
  521. # syntax of the XML files.
  522. XML_SCHEMA =
  523. # The XML_DTD tag can be used to specify an XML DTD,
  524. # which can be used by a validating XML parser to check the
  525. # syntax of the XML files.
  526. XML_DTD =
  527. #---------------------------------------------------------------------------
  528. # configuration options for the AutoGen Definitions output
  529. #---------------------------------------------------------------------------
  530. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  531. # generate an AutoGen Definitions (see autogen.sf.net) file
  532. # that captures the structure of the code including all
  533. # documentation. Note that this feature is still experimental
  534. # and incomplete at the moment.
  535. GENERATE_AUTOGEN_DEF = NO
  536. #---------------------------------------------------------------------------
  537. # configuration options related to the Perl module output
  538. #---------------------------------------------------------------------------
  539. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  540. # generate a Perl module file that captures the structure of
  541. # the code including all documentation. Note that this
  542. # feature is still experimental and incomplete at the
  543. # moment.
  544. GENERATE_PERLMOD = NO
  545. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  546. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  547. # to generate PDF and DVI output from the Perl module output.
  548. PERLMOD_LATEX = NO
  549. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  550. # nicely formatted so it can be parsed by a human reader. This is useful
  551. # if you want to understand what is going on. On the other hand, if this
  552. # tag is set to NO the size of the Perl module output will be much smaller
  553. # and Perl will parse it just the same.
  554. PERLMOD_PRETTY = YES
  555. # The names of the make variables in the generated doxyrules.make file
  556. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  557. # This is useful so different doxyrules.make files included by the same
  558. # Makefile don't overwrite each other's variables.
  559. PERLMOD_MAKEVAR_PREFIX =
  560. #---------------------------------------------------------------------------
  561. # Configuration options related to the preprocessor
  562. #---------------------------------------------------------------------------
  563. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  564. # evaluate all C-preprocessor directives found in the sources and include
  565. # files.
  566. ENABLE_PREPROCESSING = YES
  567. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  568. # names in the source code. If set to NO (the default) only conditional
  569. # compilation will be performed. Macro expansion can be done in a controlled
  570. # way by setting EXPAND_ONLY_PREDEF to YES.
  571. MACRO_EXPANSION = YES
  572. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  573. # then the macro expansion is limited to the macros specified with the
  574. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  575. EXPAND_ONLY_PREDEF = NO
  576. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  577. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  578. SEARCH_INCLUDES = YES
  579. # The INCLUDE_PATH tag can be used to specify one or more directories that
  580. # contain include files that are not input files but should be processed by
  581. # the preprocessor.
  582. INCLUDE_PATH =
  583. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  584. # patterns (like *.h and *.hpp) to filter out the header-files in the
  585. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  586. # be used.
  587. INCLUDE_FILE_PATTERNS =
  588. # The PREDEFINED tag can be used to specify one or more macro names that
  589. # are defined before the preprocessor is started (similar to the -D option of
  590. # gcc). The argument of the tag is a list of macros of the form: name
  591. # or name=definition (no spaces). If the definition and the = are
  592. # omitted =1 is assumed.
  593. PREDEFINED = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \
  594. PJ_IDEF(x)=x PJ_INLINE(x)=x \
  595. PJ_DECL_DATA(x)=x \
  596. PJ_DECL_NO_RETURN(x)=x \
  597. PJ_NO_RETURN=x \
  598. PJ_THREAD_FUNC= \
  599. PJ_HAS_HIGH_RES_TIMER=1 \
  600. PJ_LOG_MAX_LEVEL=4 \
  601. PJ_HAS_SEMAPHORE=1 \
  602. PJ_HAS_EVENT_OBJ=1 \
  603. PJ_HAS_TCP=1 \
  604. PJSUA2_THROW=throw \
  605. PJ_BEGIN_DECL= \
  606. PJ_END_DECL= \
  607. PJ_ATTR_MAY_ALIAS= \
  608. DEPRECATED_FOR_TICKET_2229=0
  609. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  610. # this tag can be used to specify a list of macro names that should be expanded.
  611. # The macro definition that is found in the sources will be used.
  612. # Use the PREDEFINED tag if you want to use a different macro definition.
  613. EXPAND_AS_DEFINED =
  614. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  615. # doxygen's preprocessor will remove all function-like macros that are alone
  616. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  617. # function macros are typically used for boiler-plate code, and will confuse the
  618. # parser if not removed.
  619. SKIP_FUNCTION_MACROS = YES
  620. #---------------------------------------------------------------------------
  621. # Configuration::addtions related to external references
  622. #---------------------------------------------------------------------------
  623. # The TAGFILES tag can be used to specify one or more tagfiles.
  624. TAGFILES = ../pjlib/docs/pjlib.tag=../../../pjlib/docs/html ../pjlib-util/docs/pjlib-util.tag=../../../pjlib-util/docs/html ../pjsip/docs/pjsip.tag=../../../pjsip/docs/html ../pjmedia/docs/pjmedia.tag=../../../pjmedia/docs/html
  625. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  626. # a tag file that is based on the input files it reads.
  627. GENERATE_TAGFILE = ../pjnath/docs/pjnath.tag
  628. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  629. # in the class index. If set to NO only the inherited external classes
  630. # will be listed.
  631. ALLEXTERNALS = NO
  632. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  633. # in the modules index. If set to NO, only the current project's groups will
  634. # be listed.
  635. EXTERNAL_GROUPS = NO
  636. # The PERL_PATH should be the absolute path and name of the perl script
  637. # interpreter (i.e. the result of `which perl').
  638. #PERL_PATH = /usr/bin/perl
  639. PERL_PATH = /c/Perl/bin/perl
  640. #---------------------------------------------------------------------------
  641. # Configuration options related to the dot tool
  642. #---------------------------------------------------------------------------
  643. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  644. # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
  645. # super classes. Setting the tag to NO turns the diagrams off. Note that this
  646. # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
  647. # recommended to install and use dot, since it yield more powerful graphs.
  648. CLASS_DIAGRAMS = NO
  649. # If set to YES, the inheritance and collaboration graphs will hide
  650. # inheritance and usage relations if the target is undocumented
  651. # or is not a class.
  652. HIDE_UNDOC_RELATIONS = YES
  653. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  654. # available from the path. This tool is part of Graphviz, a graph visualization
  655. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  656. # have no effect if this option is set to NO (the default)
  657. HAVE_DOT = NO
  658. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  659. # will generate a graph for each documented class showing the direct and
  660. # indirect inheritance relations. Setting this tag to YES will force the
  661. # the CLASS_DIAGRAMS tag to NO.
  662. CLASS_GRAPH = YES
  663. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  664. # will generate a graph for each documented class showing the direct and
  665. # indirect implementation dependencies (inheritance, containment, and
  666. # class references variables) of the class with other documented classes.
  667. COLLABORATION_GRAPH = YES
  668. # If set to YES, the inheritance and collaboration graphs will show the
  669. # relations between templates and their instances.
  670. TEMPLATE_RELATIONS = YES
  671. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  672. # tags are set to YES then doxygen will generate a graph for each documented
  673. # file showing the direct and indirect include dependencies of the file with
  674. # other documented files.
  675. INCLUDE_GRAPH = YES
  676. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  677. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  678. # documented header file showing the documented files that directly or
  679. # indirectly include this file.
  680. INCLUDED_BY_GRAPH = YES
  681. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  682. # will graphical hierarchy of all classes instead of a textual one.
  683. GRAPHICAL_HIERARCHY = YES
  684. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  685. # generated by dot. Possible values are png, jpg, or gif
  686. # If left blank png will be used.
  687. DOT_IMAGE_FORMAT = png
  688. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  689. # found. If left blank, it is assumed the dot tool can be found on the path.
  690. DOT_PATH =
  691. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  692. # contain dot files that are included in the documentation (see the
  693. # \dotfile command).
  694. DOTFILE_DIRS =
  695. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  696. # generate a legend page explaining the meaning of the various boxes and
  697. # arrows in the dot generated graphs.
  698. GENERATE_LEGEND = YES
  699. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  700. # remove the intermedate dot files that are used to generate
  701. # the various graphs.
  702. DOT_CLEANUP = YES
  703. #---------------------------------------------------------------------------
  704. # Configuration::addtions related to the search engine
  705. #---------------------------------------------------------------------------
  706. # The SEARCHENGINE tag specifies whether or not a search engine should be
  707. # used. If set to NO the values of all tags below this one will be ignored.
  708. SEARCHENGINE = NO
  709. # The CGI_NAME tag should be the name of the CGI script that
  710. # starts the search engine (doxysearch) with the correct parameters.
  711. # A script with this name will be generated by doxygen.
  712. #CGI_NAME = search.cgi
  713. # The CGI_URL tag should be the absolute URL to the directory where the
  714. # cgi binaries are located. See the documentation of your http daemon for
  715. # details.
  716. #CGI_URL =
  717. # The DOC_URL tag should be the absolute URL to the directory where the
  718. # documentation is located. If left blank the absolute path to the
  719. # documentation, with file:// prepended to it, will be used.
  720. #DOC_URL =
  721. # The DOC_ABSPATH tag should be the absolute path to the directory where the
  722. # documentation is located. If left blank the directory on the local machine
  723. # will be used.
  724. #DOC_ABSPATH =
  725. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
  726. # is installed.
  727. #BIN_ABSPATH = /usr/local/bin/
  728. # The EXT_DOC_PATHS tag can be used to specify one or more paths to
  729. # documentation generated for other projects. This allows doxysearch to search
  730. # the documentation for these projects as well.
  731. #EXT_DOC_PATHS =