Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libwebsockets / be389bd8f693be333a7a9f59729de36ca51fe78d / . / libwebsockets.dox
blob: 692223652ffa2dac8e8b75717a2464bce465f916 [file] [log] [blame]
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]1# Doxyfile 1.8.11
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = "libwebsockets"
8PROJECT_NUMBER =
9PROJECT_BRIEF = "Lightweight C library for HTML5 websockets"
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]10PROJECT_LOGO = "./test-apps/libwebsockets.org-logo.svg"
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]11OUTPUT_DIRECTORY = "doc"
12CREATE_SUBDIRS = NO
13ALLOW_UNICODE_NAMES = NO
14OUTPUT_LANGUAGE = English
15BRIEF_MEMBER_DESC = YES
16REPEAT_BRIEF = YES
17ABBREVIATE_BRIEF =
18ALWAYS_DETAILED_SEC = NO
19INLINE_INHERITED_MEMB = NO
20FULL_PATH_NAMES = YES
21STRIP_FROM_PATH =
22STRIP_FROM_INC_PATH =
23SHORT_NAMES = NO
24JAVADOC_AUTOBRIEF = NO
25QT_AUTOBRIEF = NO
26MULTILINE_CPP_IS_BRIEF = NO
27INHERIT_DOCS = YES
28SEPARATE_MEMBER_PAGES = NO
29TAB_SIZE = 8
30ALIASES =
31TCL_SUBST =
32OPTIMIZE_OUTPUT_FOR_C = YES
33OPTIMIZE_OUTPUT_JAVA = NO
34OPTIMIZE_FOR_FORTRAN = NO
35OPTIMIZE_OUTPUT_VHDL = NO
36EXTENSION_MAPPING =
37MARKDOWN_SUPPORT = YES
38AUTOLINK_SUPPORT = YES
39BUILTIN_STL_SUPPORT = NO
40CPP_CLI_SUPPORT = NO
41SIP_SUPPORT = NO
42IDL_PROPERTY_SUPPORT = YES
43DISTRIBUTE_GROUP_DOC = NO
44GROUP_NESTED_COMPOUNDS = NO
45SUBGROUPING = YES
46INLINE_GROUPED_CLASSES = NO
47INLINE_SIMPLE_STRUCTS = NO
48TYPEDEF_HIDES_STRUCT = NO
49LOOKUP_CACHE_SIZE = 0
50#---------------------------------------------------------------------------
51# Build related configuration options
52#---------------------------------------------------------------------------
53EXTRACT_ALL = NO
54EXTRACT_PRIVATE = NO
55EXTRACT_PACKAGE = NO
56EXTRACT_STATIC = NO
57EXTRACT_LOCAL_CLASSES = YES
58EXTRACT_LOCAL_METHODS = NO
59EXTRACT_ANON_NSPACES = NO
60HIDE_UNDOC_MEMBERS = NO
61HIDE_UNDOC_CLASSES = NO
62HIDE_FRIEND_COMPOUNDS = NO
63HIDE_IN_BODY_DOCS = NO
64INTERNAL_DOCS = NO
65CASE_SENSE_NAMES = YES
66HIDE_SCOPE_NAMES = NO
67HIDE_COMPOUND_REFERENCE= NO
68SHOW_INCLUDE_FILES = YES
69SHOW_GROUPED_MEMB_INC = YES
70FORCE_LOCAL_INCLUDES = NO
71INLINE_INFO = YES
72SORT_MEMBER_DOCS = YES
73SORT_BRIEF_DOCS = NO
74SORT_MEMBERS_CTORS_1ST = NO
75SORT_GROUP_NAMES = YES
76SORT_BY_SCOPE_NAME = NO
77STRICT_PROTO_MATCHING = YES
78GENERATE_TODOLIST = YES
79GENERATE_TESTLIST = YES
80GENERATE_BUGLIST = YES
81GENERATE_DEPRECATEDLIST= YES
82ENABLED_SECTIONS =
83MAX_INITIALIZER_LINES = 30
84SHOW_USED_FILES = YES
85SHOW_FILES = YES
86SHOW_NAMESPACES = YES
87FILE_VERSION_FILTER =
88LAYOUT_FILE =
89CITE_BIB_FILES =
90#---------------------------------------------------------------------------
91# Configuration options related to warning and progress messages
92#---------------------------------------------------------------------------
93QUIET = NO
94WARNINGS = YES
95WARN_IF_UNDOCUMENTED = NO
96WARN_IF_DOC_ERROR = YES
97WARN_NO_PARAMDOC = NO
98WARN_AS_ERROR = NO
99WARN_FORMAT = "$file:$line: $text"
100WARN_LOGFILE =
101#---------------------------------------------------------------------------
102# Configuration options related to the input files
103#---------------------------------------------------------------------------
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]104INPUT = include/libwebsockets.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]105 include/libwebsockets/lws-adopt.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]106 include/libwebsockets/lws-async-dns.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]107 include/libwebsockets/lws-callbacks.h \
108 include/libwebsockets/lws-cgi.h \
109 include/libwebsockets/lws-client.h \
110 include/libwebsockets/lws-context-vhost.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]111 include/libwebsockets/lws-dbus.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]112 include/libwebsockets/lws-detailed-latency.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]113 include/libwebsockets/lws-diskcache.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]114 include/libwebsockets/lws-dsh.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]115 include/libwebsockets/lws-esp32.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]116 include/libwebsockets/lws-freertos.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]117 include/libwebsockets/lws-fts.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]118 include/libwebsockets/lws-genaes.h \
119 include/libwebsockets/lws-gencrypto.h \
120 include/libwebsockets/lws-genec.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]121 include/libwebsockets/lws-genhash.h \
122 include/libwebsockets/lws-genrsa.h \
123 include/libwebsockets/lws-http.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]124 include/libwebsockets/lws-jose.h \
125 include/libwebsockets/lws-jwe.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]126 include/libwebsockets/lws-jwk.h \
127 include/libwebsockets/lws-jws.h \
128 include/libwebsockets/lws-lejp.h \
129 include/libwebsockets/lws-logs.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]130 include/libwebsockets/lws-lwsac.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]131 include/libwebsockets/lws-misc.h \
132 include/libwebsockets/lws-network-helper.h \
133 include/libwebsockets/lws-plugin-generic-sessions.h \
134 include/libwebsockets/lws-protocols-plugins.h \
135 include/libwebsockets/lws-purify.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]136 include/libwebsockets/lws-retry.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]137 include/libwebsockets/lws-ring.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]138 include/libwebsockets/lws-sequencer.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]139 include/libwebsockets/lws-service.h \
140 include/libwebsockets/lws-sha1-base64.h \
141 include/libwebsockets/lws-spa.h \
142 include/libwebsockets/lws-stats.h \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]143 include/libwebsockets/lws-struct.h \
144 include/libwebsockets/lws-system.h \
145 include/libwebsockets/lws-test-sequencer.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]146 include/libwebsockets/lws-threadpool.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]147 include/libwebsockets/lws-timeout-timer.h \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]148 include/libwebsockets/lws-tokenize.h \
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]149 include/libwebsockets/lws-vfs.h \
150 include/libwebsockets/lws-write.h \
151 include/libwebsockets/lws-writeable.h \
152 include/libwebsockets/lws-ws-close.h \
153 include/libwebsockets/lws-ws-ext.h \
154 include/libwebsockets/lws-ws-state.h \
155 include/libwebsockets/lws-x509.h \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]156 plugins/ssh-base/include/lws-plugin-ssh.h \
157 ./READMEs/mainpage.md \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]158 ./READMEs/README.async-dns.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]159 ./READMEs/README.build.md \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]160 ./READMEs/README.ci.md \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]161 ./READMEs/README.coding.md \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]162 ./READMEs/README.content-security-policy.md \
163 ./READMEs/README.contributing.md \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]164 ./READMEs/README.crypto-apis.md \
165 ./READMEs/README.detailed-latency.md \
Ben Delarre31606052017-11-12 14:37:17 +0800[diff] [blame]166 ./READMEs/README.esp32.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]167 ./READMEs/README.generic-sessions.md \
168 ./READMEs/README.generic-table.md \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]169 ./READMEs/README.h2-long-poll.md \
170 ./READMEs/README.http-fallback.md \
171 ./READMEs/README.lws_dll.md \
172 ./READMEs/README.lws_sequencer.md \
173 ./READMEs/README.lws_struct.md \
174 ./READMEs/README.lws_sul.md \
175 ./READMEs/README.lwsws.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]176 ./READMEs/README-plugin-sshd-base.md \
Andy Greenc027c3d2018-11-21 06:46:23 +0800[diff] [blame]177 ./READMEs/README.plugin-acme.md \
Andy Green6cae9d32019-09-17 09:15:06 +0100[diff] [blame]178 ./READMEs/README.porting.md \
179 ./READMEs/README.problems.md \
180 ./READMEs/README.release-policy.md \
181 ./READMEs/README.test-apps.md \
182 ./READMEs/README.unix-domain-reverse-proxy.md \
183 ./READMEs/README.vulnerability-reporting.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]184 ./doc-assets
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]185INPUT_ENCODING = UTF-8
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]186FILE_PATTERNS = lib/*.c *.md *.png include/*.h
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]187RECURSIVE = NO
188EXCLUDE =
189EXCLUDE_SYMLINKS = NO
190EXCLUDE_PATTERNS =
191EXCLUDE_SYMBOLS =
192EXAMPLE_PATH =
193EXAMPLE_PATTERNS =
194EXAMPLE_RECURSIVE = NO
Andy Green722cc4a2016-06-26 06:29:20 +0800[diff] [blame]195IMAGE_PATH = doc-assets
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]196INPUT_FILTER =
197FILTER_PATTERNS =
198FILTER_SOURCE_FILES = NO
199FILTER_SOURCE_PATTERNS =
200USE_MDFILE_AS_MAINPAGE = mainpage.md
201#---------------------------------------------------------------------------
202# Configuration options related to source browsing
203#---------------------------------------------------------------------------
204SOURCE_BROWSER = NO
205INLINE_SOURCES = YES
206STRIP_CODE_COMMENTS = YES
207REFERENCED_BY_RELATION = NO
208REFERENCES_RELATION = NO
209REFERENCES_LINK_SOURCE = YES
210SOURCE_TOOLTIPS = YES
211USE_HTAGS = NO
212VERBATIM_HEADERS = YES
213#---------------------------------------------------------------------------
214# Configuration options related to the alphabetical class index
215#---------------------------------------------------------------------------
216ALPHABETICAL_INDEX = YES
217COLS_IN_ALPHA_INDEX = 5
218IGNORE_PREFIX =
219#---------------------------------------------------------------------------
220# Configuration options related to the HTML output
221#---------------------------------------------------------------------------
222GENERATE_HTML = YES
223HTML_OUTPUT = html
224HTML_FILE_EXTENSION = .html
225HTML_HEADER =
226HTML_FOOTER =
227HTML_STYLESHEET =
228HTML_EXTRA_STYLESHEET =
229HTML_EXTRA_FILES =
230HTML_COLORSTYLE_HUE = 220
231HTML_COLORSTYLE_SAT = 100
232HTML_COLORSTYLE_GAMMA = 80
233HTML_TIMESTAMP = NO
234HTML_DYNAMIC_SECTIONS = NO
235HTML_INDEX_NUM_ENTRIES = 100
236GENERATE_DOCSET = NO
237DOCSET_FEEDNAME = "Doxygen generated docs"
238DOCSET_BUNDLE_ID = org.doxygen.Project
239DOCSET_PUBLISHER_ID = org.doxygen.Publisher
240DOCSET_PUBLISHER_NAME = Publisher
241GENERATE_HTMLHELP = NO
242CHM_FILE =
243HHC_LOCATION =
244GENERATE_CHI = NO
245CHM_INDEX_ENCODING =
246BINARY_TOC = NO
247TOC_EXPAND = NO
248GENERATE_QHP = NO
249QCH_FILE =
250QHP_NAMESPACE = org.doxygen.Project
251QHP_VIRTUAL_FOLDER = doc
252QHP_CUST_FILTER_NAME =
253QHP_CUST_FILTER_ATTRS =
254QHP_SECT_FILTER_ATTRS =
255QHG_LOCATION =
256GENERATE_ECLIPSEHELP = NO
257ECLIPSE_DOC_ID = org.doxygen.Project
258DISABLE_INDEX = NO
259GENERATE_TREEVIEW = YES
260ENUM_VALUES_PER_LINE = 4
261TREEVIEW_WIDTH = 250
262EXT_LINKS_IN_WINDOW = NO
263FORMULA_FONTSIZE = 10
264FORMULA_TRANSPARENT = YES
265USE_MATHJAX = NO
266MATHJAX_FORMAT = HTML-CSS
267MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
268MATHJAX_EXTENSIONS =
269MATHJAX_CODEFILE =
270SEARCHENGINE = NO
271SERVER_BASED_SEARCH = NO
272EXTERNAL_SEARCH = NO
273SEARCHENGINE_URL =
274SEARCHDATA_FILE = searchdata.xml
275EXTERNAL_SEARCH_ID =
276EXTRA_SEARCH_MAPPINGS =
277#---------------------------------------------------------------------------
278# Configuration options related to the LaTeX output
279#---------------------------------------------------------------------------
Andy Green722cc4a2016-06-26 06:29:20 +0800[diff] [blame]280GENERATE_LATEX = NO
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]281LATEX_OUTPUT = latex
282LATEX_CMD_NAME = latex
283MAKEINDEX_CMD_NAME = makeindex
284COMPACT_LATEX = NO
285PAPER_TYPE = a4
286EXTRA_PACKAGES =
287LATEX_HEADER =
288LATEX_FOOTER =
289LATEX_EXTRA_STYLESHEET =
290LATEX_EXTRA_FILES =
291PDF_HYPERLINKS = YES
292USE_PDFLATEX = YES
293LATEX_BATCHMODE = NO
294LATEX_HIDE_INDICES = NO
295LATEX_SOURCE_CODE = NO
296LATEX_BIB_STYLE = plain
297LATEX_TIMESTAMP = NO
298#---------------------------------------------------------------------------
299# Configuration options related to the RTF output
300#---------------------------------------------------------------------------
301GENERATE_RTF = NO
302RTF_OUTPUT = rtf
303COMPACT_RTF = NO
304RTF_HYPERLINKS = NO
305RTF_STYLESHEET_FILE =
306RTF_EXTENSIONS_FILE =
307RTF_SOURCE_CODE = NO
308#---------------------------------------------------------------------------
309# Configuration options related to the man page output
310#---------------------------------------------------------------------------
311GENERATE_MAN = NO
312MAN_OUTPUT = man
313MAN_EXTENSION = .3
314MAN_SUBDIR =
315MAN_LINKS = NO
316#---------------------------------------------------------------------------
317# Configuration options related to the XML output
318#---------------------------------------------------------------------------
319GENERATE_XML = NO
320XML_OUTPUT = xml
321XML_PROGRAMLISTING = YES
322#---------------------------------------------------------------------------
323# Configuration options related to the DOCBOOK output
324#---------------------------------------------------------------------------
325GENERATE_DOCBOOK = NO
326DOCBOOK_OUTPUT = docbook
327DOCBOOK_PROGRAMLISTING = NO
328#---------------------------------------------------------------------------
329# Configuration options for the AutoGen Definitions output
330#---------------------------------------------------------------------------
331GENERATE_AUTOGEN_DEF = NO
332#---------------------------------------------------------------------------
333# Configuration options related to the Perl module output
334#---------------------------------------------------------------------------
335GENERATE_PERLMOD = NO
336PERLMOD_LATEX = NO
337PERLMOD_PRETTY = YES
338PERLMOD_MAKEVAR_PREFIX =
339#---------------------------------------------------------------------------
340# Configuration options related to the preprocessor
341#---------------------------------------------------------------------------
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]342ENABLE_PREPROCESSING = YES
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]343MACRO_EXPANSION = NO
344EXPAND_ONLY_PREDEF = NO
345SEARCH_INCLUDES = YES
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]346INCLUDE_PATH = ./include
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]347INCLUDE_FILE_PATTERNS =
348PREDEFINED =
349EXPAND_AS_DEFINED =
350SKIP_FUNCTION_MACROS = YES
351#---------------------------------------------------------------------------
352# Configuration options related to external references
353#---------------------------------------------------------------------------
354TAGFILES =
355GENERATE_TAGFILE =
356ALLEXTERNALS = NO
357EXTERNAL_GROUPS = YES
358EXTERNAL_PAGES = YES
359PERL_PATH = /usr/bin/perl
360#---------------------------------------------------------------------------
361# Configuration options related to the dot tool
362#---------------------------------------------------------------------------
363CLASS_DIAGRAMS = YES
364MSCGEN_PATH =
365DIA_PATH =
366HIDE_UNDOC_RELATIONS = YES
367HAVE_DOT = NO
368DOT_NUM_THREADS = 0
369DOT_FONTNAME = Helvetica
370DOT_FONTSIZE = 10
371DOT_FONTPATH =
372CLASS_GRAPH = YES
373COLLABORATION_GRAPH = YES
374GROUP_GRAPHS = YES
375UML_LOOK = NO
376UML_LIMIT_NUM_FIELDS = 10
377TEMPLATE_RELATIONS = NO
378INCLUDE_GRAPH = YES
379INCLUDED_BY_GRAPH = YES
380CALL_GRAPH = NO
381CALLER_GRAPH = NO
382GRAPHICAL_HIERARCHY = YES
383DIRECTORY_GRAPH = YES
384DOT_IMAGE_FORMAT = png
385INTERACTIVE_SVG = NO
386DOT_PATH =
387DOTFILE_DIRS =
388MSCFILE_DIRS =
389DIAFILE_DIRS =
390PLANTUML_JAR_PATH =
391PLANTUML_INCLUDE_PATH =
392DOT_GRAPH_MAX_NODES = 50
393MAX_DOT_GRAPH_DEPTH = 0
394DOT_TRANSPARENT = NO
395DOT_MULTI_TARGETS = NO
396GENERATE_LEGEND = YES
397DOT_CLEANUP = YES