libwebsockets.dox 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. # Doxyfile 1.8.11
  2. #---------------------------------------------------------------------------
  3. # Project related configuration options
  4. #---------------------------------------------------------------------------
  5. DOXYFILE_ENCODING = UTF-8
  6. PROJECT_NAME = "libwebsockets"
  7. PROJECT_NUMBER =
  8. PROJECT_BRIEF = "Lightweight C library for HTML5 websockets"
  9. PROJECT_LOGO = "./test-server/libwebsockets.org-logo.png"
  10. OUTPUT_DIRECTORY = "doc"
  11. CREATE_SUBDIRS = NO
  12. ALLOW_UNICODE_NAMES = NO
  13. OUTPUT_LANGUAGE = English
  14. BRIEF_MEMBER_DESC = YES
  15. REPEAT_BRIEF = YES
  16. ABBREVIATE_BRIEF =
  17. ALWAYS_DETAILED_SEC = NO
  18. INLINE_INHERITED_MEMB = NO
  19. FULL_PATH_NAMES = YES
  20. STRIP_FROM_PATH =
  21. STRIP_FROM_INC_PATH =
  22. SHORT_NAMES = NO
  23. JAVADOC_AUTOBRIEF = NO
  24. QT_AUTOBRIEF = NO
  25. MULTILINE_CPP_IS_BRIEF = NO
  26. INHERIT_DOCS = YES
  27. SEPARATE_MEMBER_PAGES = NO
  28. TAB_SIZE = 8
  29. ALIASES =
  30. TCL_SUBST =
  31. OPTIMIZE_OUTPUT_FOR_C = YES
  32. OPTIMIZE_OUTPUT_JAVA = NO
  33. OPTIMIZE_FOR_FORTRAN = NO
  34. OPTIMIZE_OUTPUT_VHDL = NO
  35. EXTENSION_MAPPING =
  36. MARKDOWN_SUPPORT = YES
  37. AUTOLINK_SUPPORT = YES
  38. BUILTIN_STL_SUPPORT = NO
  39. CPP_CLI_SUPPORT = NO
  40. SIP_SUPPORT = NO
  41. IDL_PROPERTY_SUPPORT = YES
  42. DISTRIBUTE_GROUP_DOC = NO
  43. GROUP_NESTED_COMPOUNDS = NO
  44. SUBGROUPING = YES
  45. INLINE_GROUPED_CLASSES = NO
  46. INLINE_SIMPLE_STRUCTS = NO
  47. TYPEDEF_HIDES_STRUCT = NO
  48. LOOKUP_CACHE_SIZE = 0
  49. #---------------------------------------------------------------------------
  50. # Build related configuration options
  51. #---------------------------------------------------------------------------
  52. EXTRACT_ALL = NO
  53. EXTRACT_PRIVATE = NO
  54. EXTRACT_PACKAGE = NO
  55. EXTRACT_STATIC = NO
  56. EXTRACT_LOCAL_CLASSES = YES
  57. EXTRACT_LOCAL_METHODS = NO
  58. EXTRACT_ANON_NSPACES = NO
  59. HIDE_UNDOC_MEMBERS = NO
  60. HIDE_UNDOC_CLASSES = NO
  61. HIDE_FRIEND_COMPOUNDS = NO
  62. HIDE_IN_BODY_DOCS = NO
  63. INTERNAL_DOCS = NO
  64. CASE_SENSE_NAMES = YES
  65. HIDE_SCOPE_NAMES = NO
  66. HIDE_COMPOUND_REFERENCE= NO
  67. SHOW_INCLUDE_FILES = YES
  68. SHOW_GROUPED_MEMB_INC = YES
  69. FORCE_LOCAL_INCLUDES = NO
  70. INLINE_INFO = YES
  71. SORT_MEMBER_DOCS = YES
  72. SORT_BRIEF_DOCS = NO
  73. SORT_MEMBERS_CTORS_1ST = NO
  74. SORT_GROUP_NAMES = YES
  75. SORT_BY_SCOPE_NAME = NO
  76. STRICT_PROTO_MATCHING = YES
  77. GENERATE_TODOLIST = YES
  78. GENERATE_TESTLIST = YES
  79. GENERATE_BUGLIST = YES
  80. GENERATE_DEPRECATEDLIST= YES
  81. ENABLED_SECTIONS =
  82. MAX_INITIALIZER_LINES = 30
  83. SHOW_USED_FILES = YES
  84. SHOW_FILES = YES
  85. SHOW_NAMESPACES = YES
  86. FILE_VERSION_FILTER =
  87. LAYOUT_FILE =
  88. CITE_BIB_FILES =
  89. #---------------------------------------------------------------------------
  90. # Configuration options related to warning and progress messages
  91. #---------------------------------------------------------------------------
  92. QUIET = NO
  93. WARNINGS = YES
  94. WARN_IF_UNDOCUMENTED = NO
  95. WARN_IF_DOC_ERROR = YES
  96. WARN_NO_PARAMDOC = NO
  97. WARN_AS_ERROR = NO
  98. WARN_FORMAT = "$file:$line: $text"
  99. WARN_LOGFILE =
  100. #---------------------------------------------------------------------------
  101. # Configuration options related to the input files
  102. #---------------------------------------------------------------------------
  103. INPUT = lib/libwebsockets.h mainpage.md README.build.md README.problems.md README.lwsws.md README.coding.md README.generic-sessions.md README.generic-table.md README.test-apps.md doc-assets
  104. INPUT_ENCODING = UTF-8
  105. FILE_PATTERNS = lib/*.c *.md *.png
  106. RECURSIVE = NO
  107. EXCLUDE =
  108. EXCLUDE_SYMLINKS = NO
  109. EXCLUDE_PATTERNS =
  110. EXCLUDE_SYMBOLS =
  111. EXAMPLE_PATH =
  112. EXAMPLE_PATTERNS =
  113. EXAMPLE_RECURSIVE = NO
  114. IMAGE_PATH = doc-assets
  115. INPUT_FILTER =
  116. FILTER_PATTERNS =
  117. FILTER_SOURCE_FILES = NO
  118. FILTER_SOURCE_PATTERNS =
  119. USE_MDFILE_AS_MAINPAGE = mainpage.md
  120. #---------------------------------------------------------------------------
  121. # Configuration options related to source browsing
  122. #---------------------------------------------------------------------------
  123. SOURCE_BROWSER = NO
  124. INLINE_SOURCES = YES
  125. STRIP_CODE_COMMENTS = YES
  126. REFERENCED_BY_RELATION = NO
  127. REFERENCES_RELATION = NO
  128. REFERENCES_LINK_SOURCE = YES
  129. SOURCE_TOOLTIPS = YES
  130. USE_HTAGS = NO
  131. VERBATIM_HEADERS = YES
  132. #---------------------------------------------------------------------------
  133. # Configuration options related to the alphabetical class index
  134. #---------------------------------------------------------------------------
  135. ALPHABETICAL_INDEX = YES
  136. COLS_IN_ALPHA_INDEX = 5
  137. IGNORE_PREFIX =
  138. #---------------------------------------------------------------------------
  139. # Configuration options related to the HTML output
  140. #---------------------------------------------------------------------------
  141. GENERATE_HTML = YES
  142. HTML_OUTPUT = html
  143. HTML_FILE_EXTENSION = .html
  144. HTML_HEADER =
  145. HTML_FOOTER =
  146. HTML_STYLESHEET =
  147. HTML_EXTRA_STYLESHEET =
  148. HTML_EXTRA_FILES =
  149. HTML_COLORSTYLE_HUE = 220
  150. HTML_COLORSTYLE_SAT = 100
  151. HTML_COLORSTYLE_GAMMA = 80
  152. HTML_TIMESTAMP = NO
  153. HTML_DYNAMIC_SECTIONS = NO
  154. HTML_INDEX_NUM_ENTRIES = 100
  155. GENERATE_DOCSET = NO
  156. DOCSET_FEEDNAME = "Doxygen generated docs"
  157. DOCSET_BUNDLE_ID = org.doxygen.Project
  158. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  159. DOCSET_PUBLISHER_NAME = Publisher
  160. GENERATE_HTMLHELP = NO
  161. CHM_FILE =
  162. HHC_LOCATION =
  163. GENERATE_CHI = NO
  164. CHM_INDEX_ENCODING =
  165. BINARY_TOC = NO
  166. TOC_EXPAND = NO
  167. GENERATE_QHP = NO
  168. QCH_FILE =
  169. QHP_NAMESPACE = org.doxygen.Project
  170. QHP_VIRTUAL_FOLDER = doc
  171. QHP_CUST_FILTER_NAME =
  172. QHP_CUST_FILTER_ATTRS =
  173. QHP_SECT_FILTER_ATTRS =
  174. QHG_LOCATION =
  175. GENERATE_ECLIPSEHELP = NO
  176. ECLIPSE_DOC_ID = org.doxygen.Project
  177. DISABLE_INDEX = NO
  178. GENERATE_TREEVIEW = YES
  179. ENUM_VALUES_PER_LINE = 4
  180. TREEVIEW_WIDTH = 250
  181. EXT_LINKS_IN_WINDOW = NO
  182. FORMULA_FONTSIZE = 10
  183. FORMULA_TRANSPARENT = YES
  184. USE_MATHJAX = NO
  185. MATHJAX_FORMAT = HTML-CSS
  186. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  187. MATHJAX_EXTENSIONS =
  188. MATHJAX_CODEFILE =
  189. SEARCHENGINE = NO
  190. SERVER_BASED_SEARCH = NO
  191. EXTERNAL_SEARCH = NO
  192. SEARCHENGINE_URL =
  193. SEARCHDATA_FILE = searchdata.xml
  194. EXTERNAL_SEARCH_ID =
  195. EXTRA_SEARCH_MAPPINGS =
  196. #---------------------------------------------------------------------------
  197. # Configuration options related to the LaTeX output
  198. #---------------------------------------------------------------------------
  199. GENERATE_LATEX = NO
  200. LATEX_OUTPUT = latex
  201. LATEX_CMD_NAME = latex
  202. MAKEINDEX_CMD_NAME = makeindex
  203. COMPACT_LATEX = NO
  204. PAPER_TYPE = a4
  205. EXTRA_PACKAGES =
  206. LATEX_HEADER =
  207. LATEX_FOOTER =
  208. LATEX_EXTRA_STYLESHEET =
  209. LATEX_EXTRA_FILES =
  210. PDF_HYPERLINKS = YES
  211. USE_PDFLATEX = YES
  212. LATEX_BATCHMODE = NO
  213. LATEX_HIDE_INDICES = NO
  214. LATEX_SOURCE_CODE = NO
  215. LATEX_BIB_STYLE = plain
  216. LATEX_TIMESTAMP = NO
  217. #---------------------------------------------------------------------------
  218. # Configuration options related to the RTF output
  219. #---------------------------------------------------------------------------
  220. GENERATE_RTF = NO
  221. RTF_OUTPUT = rtf
  222. COMPACT_RTF = NO
  223. RTF_HYPERLINKS = NO
  224. RTF_STYLESHEET_FILE =
  225. RTF_EXTENSIONS_FILE =
  226. RTF_SOURCE_CODE = NO
  227. #---------------------------------------------------------------------------
  228. # Configuration options related to the man page output
  229. #---------------------------------------------------------------------------
  230. GENERATE_MAN = NO
  231. MAN_OUTPUT = man
  232. MAN_EXTENSION = .3
  233. MAN_SUBDIR =
  234. MAN_LINKS = NO
  235. #---------------------------------------------------------------------------
  236. # Configuration options related to the XML output
  237. #---------------------------------------------------------------------------
  238. GENERATE_XML = NO
  239. XML_OUTPUT = xml
  240. XML_PROGRAMLISTING = YES
  241. #---------------------------------------------------------------------------
  242. # Configuration options related to the DOCBOOK output
  243. #---------------------------------------------------------------------------
  244. GENERATE_DOCBOOK = NO
  245. DOCBOOK_OUTPUT = docbook
  246. DOCBOOK_PROGRAMLISTING = NO
  247. #---------------------------------------------------------------------------
  248. # Configuration options for the AutoGen Definitions output
  249. #---------------------------------------------------------------------------
  250. GENERATE_AUTOGEN_DEF = NO
  251. #---------------------------------------------------------------------------
  252. # Configuration options related to the Perl module output
  253. #---------------------------------------------------------------------------
  254. GENERATE_PERLMOD = NO
  255. PERLMOD_LATEX = NO
  256. PERLMOD_PRETTY = YES
  257. PERLMOD_MAKEVAR_PREFIX =
  258. #---------------------------------------------------------------------------
  259. # Configuration options related to the preprocessor
  260. #---------------------------------------------------------------------------
  261. ENABLE_PREPROCESSING = NO
  262. MACRO_EXPANSION = NO
  263. EXPAND_ONLY_PREDEF = NO
  264. SEARCH_INCLUDES = YES
  265. INCLUDE_PATH =
  266. INCLUDE_FILE_PATTERNS =
  267. PREDEFINED =
  268. EXPAND_AS_DEFINED =
  269. SKIP_FUNCTION_MACROS = YES
  270. #---------------------------------------------------------------------------
  271. # Configuration options related to external references
  272. #---------------------------------------------------------------------------
  273. TAGFILES =
  274. GENERATE_TAGFILE =
  275. ALLEXTERNALS = NO
  276. EXTERNAL_GROUPS = YES
  277. EXTERNAL_PAGES = YES
  278. PERL_PATH = /usr/bin/perl
  279. #---------------------------------------------------------------------------
  280. # Configuration options related to the dot tool
  281. #---------------------------------------------------------------------------
  282. CLASS_DIAGRAMS = YES
  283. MSCGEN_PATH =
  284. DIA_PATH =
  285. HIDE_UNDOC_RELATIONS = YES
  286. HAVE_DOT = NO
  287. DOT_NUM_THREADS = 0
  288. DOT_FONTNAME = Helvetica
  289. DOT_FONTSIZE = 10
  290. DOT_FONTPATH =
  291. CLASS_GRAPH = YES
  292. COLLABORATION_GRAPH = YES
  293. GROUP_GRAPHS = YES
  294. UML_LOOK = NO
  295. UML_LIMIT_NUM_FIELDS = 10
  296. TEMPLATE_RELATIONS = NO
  297. INCLUDE_GRAPH = YES
  298. INCLUDED_BY_GRAPH = YES
  299. CALL_GRAPH = NO
  300. CALLER_GRAPH = NO
  301. GRAPHICAL_HIERARCHY = YES
  302. DIRECTORY_GRAPH = YES
  303. DOT_IMAGE_FORMAT = png
  304. INTERACTIVE_SVG = NO
  305. DOT_PATH =
  306. DOTFILE_DIRS =
  307. MSCFILE_DIRS =
  308. DIAFILE_DIRS =
  309. PLANTUML_JAR_PATH =
  310. PLANTUML_INCLUDE_PATH =
  311. DOT_GRAPH_MAX_NODES = 50
  312. MAX_DOT_GRAPH_DEPTH = 0
  313. DOT_TRANSPARENT = NO
  314. DOT_MULTI_TARGETS = NO
  315. GENERATE_LEGEND = YES
  316. DOT_CLEANUP = YES