Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libwebsockets / ac032544bf2c09ba8935128b8cbd6a669a1b91df / . / libwebsockets.dox
blob: 4eb5f4c963af96451d1d280c9aab8f2f338643e0 [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 Green4f267c52017-09-22 09:46:58 +0800[diff] [blame]10PROJECT_LOGO = "./test-apps/libwebsockets.org-logo.png"
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 \
105 include/libwebsockets/lws-callbacks.h \
106 include/libwebsockets/lws-cgi.h \
107 include/libwebsockets/lws-client.h \
108 include/libwebsockets/lws-context-vhost.h \
109 include/libwebsockets/lws-esp32.h \
110 include/libwebsockets/lws-genhash.h \
111 include/libwebsockets/lws-genrsa.h \
112 include/libwebsockets/lws-http.h \
113 include/libwebsockets/lws-jwk.h \
114 include/libwebsockets/lws-jws.h \
115 include/libwebsockets/lws-lejp.h \
116 include/libwebsockets/lws-logs.h \
117 include/libwebsockets/lws-misc.h \
118 include/libwebsockets/lws-network-helper.h \
119 include/libwebsockets/lws-plugin-generic-sessions.h \
120 include/libwebsockets/lws-protocols-plugins.h \
121 include/libwebsockets/lws-purify.h \
122 include/libwebsockets/lws-ring.h \
123 include/libwebsockets/lws-service.h \
124 include/libwebsockets/lws-sha1-base64.h \
125 include/libwebsockets/lws-spa.h \
126 include/libwebsockets/lws-stats.h \
127 include/libwebsockets/lws-timeout-timer.h \
128 include/libwebsockets/lws-vfs.h \
129 include/libwebsockets/lws-write.h \
130 include/libwebsockets/lws-writeable.h \
131 include/libwebsockets/lws-ws-close.h \
132 include/libwebsockets/lws-ws-ext.h \
133 include/libwebsockets/lws-ws-state.h \
134 include/libwebsockets/lws-x509.h \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]135 plugins/ssh-base/include/lws-plugin-ssh.h \
136 ./READMEs/mainpage.md \
137 ./READMEs/README.build.md \
138 ./READMEs/README.problems.md \
139 ./READMEs/README.lwsws.md \
140 ./READMEs/README.coding.md \
Ben Delarre31606052017-11-12 14:37:17 +0800[diff] [blame]141 ./READMEs/README.esp32.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]142 ./READMEs/README.generic-sessions.md \
143 ./READMEs/README.generic-table.md \
144 ./READMEs/README.test-apps.md \
Andy Greene67ae242017-10-12 07:36:43 +0800[diff] [blame]145 ./READMEs/README-plugin-sshd-base.md \
146 ./doc-assets
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]147INPUT_ENCODING = UTF-8
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]148FILE_PATTERNS = lib/*.c *.md *.png include/*.h
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]149RECURSIVE = NO
150EXCLUDE =
151EXCLUDE_SYMLINKS = NO
152EXCLUDE_PATTERNS =
153EXCLUDE_SYMBOLS =
154EXAMPLE_PATH =
155EXAMPLE_PATTERNS =
156EXAMPLE_RECURSIVE = NO
Andy Green722cc4a2016-06-26 06:29:20 +0800[diff] [blame]157IMAGE_PATH = doc-assets
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]158INPUT_FILTER =
159FILTER_PATTERNS =
160FILTER_SOURCE_FILES = NO
161FILTER_SOURCE_PATTERNS =
162USE_MDFILE_AS_MAINPAGE = mainpage.md
163#---------------------------------------------------------------------------
164# Configuration options related to source browsing
165#---------------------------------------------------------------------------
166SOURCE_BROWSER = NO
167INLINE_SOURCES = YES
168STRIP_CODE_COMMENTS = YES
169REFERENCED_BY_RELATION = NO
170REFERENCES_RELATION = NO
171REFERENCES_LINK_SOURCE = YES
172SOURCE_TOOLTIPS = YES
173USE_HTAGS = NO
174VERBATIM_HEADERS = YES
175#---------------------------------------------------------------------------
176# Configuration options related to the alphabetical class index
177#---------------------------------------------------------------------------
178ALPHABETICAL_INDEX = YES
179COLS_IN_ALPHA_INDEX = 5
180IGNORE_PREFIX =
181#---------------------------------------------------------------------------
182# Configuration options related to the HTML output
183#---------------------------------------------------------------------------
184GENERATE_HTML = YES
185HTML_OUTPUT = html
186HTML_FILE_EXTENSION = .html
187HTML_HEADER =
188HTML_FOOTER =
189HTML_STYLESHEET =
190HTML_EXTRA_STYLESHEET =
191HTML_EXTRA_FILES =
192HTML_COLORSTYLE_HUE = 220
193HTML_COLORSTYLE_SAT = 100
194HTML_COLORSTYLE_GAMMA = 80
195HTML_TIMESTAMP = NO
196HTML_DYNAMIC_SECTIONS = NO
197HTML_INDEX_NUM_ENTRIES = 100
198GENERATE_DOCSET = NO
199DOCSET_FEEDNAME = "Doxygen generated docs"
200DOCSET_BUNDLE_ID = org.doxygen.Project
201DOCSET_PUBLISHER_ID = org.doxygen.Publisher
202DOCSET_PUBLISHER_NAME = Publisher
203GENERATE_HTMLHELP = NO
204CHM_FILE =
205HHC_LOCATION =
206GENERATE_CHI = NO
207CHM_INDEX_ENCODING =
208BINARY_TOC = NO
209TOC_EXPAND = NO
210GENERATE_QHP = NO
211QCH_FILE =
212QHP_NAMESPACE = org.doxygen.Project
213QHP_VIRTUAL_FOLDER = doc
214QHP_CUST_FILTER_NAME =
215QHP_CUST_FILTER_ATTRS =
216QHP_SECT_FILTER_ATTRS =
217QHG_LOCATION =
218GENERATE_ECLIPSEHELP = NO
219ECLIPSE_DOC_ID = org.doxygen.Project
220DISABLE_INDEX = NO
221GENERATE_TREEVIEW = YES
222ENUM_VALUES_PER_LINE = 4
223TREEVIEW_WIDTH = 250
224EXT_LINKS_IN_WINDOW = NO
225FORMULA_FONTSIZE = 10
226FORMULA_TRANSPARENT = YES
227USE_MATHJAX = NO
228MATHJAX_FORMAT = HTML-CSS
229MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
230MATHJAX_EXTENSIONS =
231MATHJAX_CODEFILE =
232SEARCHENGINE = NO
233SERVER_BASED_SEARCH = NO
234EXTERNAL_SEARCH = NO
235SEARCHENGINE_URL =
236SEARCHDATA_FILE = searchdata.xml
237EXTERNAL_SEARCH_ID =
238EXTRA_SEARCH_MAPPINGS =
239#---------------------------------------------------------------------------
240# Configuration options related to the LaTeX output
241#---------------------------------------------------------------------------
Andy Green722cc4a2016-06-26 06:29:20 +0800[diff] [blame]242GENERATE_LATEX = NO
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]243LATEX_OUTPUT = latex
244LATEX_CMD_NAME = latex
245MAKEINDEX_CMD_NAME = makeindex
246COMPACT_LATEX = NO
247PAPER_TYPE = a4
248EXTRA_PACKAGES =
249LATEX_HEADER =
250LATEX_FOOTER =
251LATEX_EXTRA_STYLESHEET =
252LATEX_EXTRA_FILES =
253PDF_HYPERLINKS = YES
254USE_PDFLATEX = YES
255LATEX_BATCHMODE = NO
256LATEX_HIDE_INDICES = NO
257LATEX_SOURCE_CODE = NO
258LATEX_BIB_STYLE = plain
259LATEX_TIMESTAMP = NO
260#---------------------------------------------------------------------------
261# Configuration options related to the RTF output
262#---------------------------------------------------------------------------
263GENERATE_RTF = NO
264RTF_OUTPUT = rtf
265COMPACT_RTF = NO
266RTF_HYPERLINKS = NO
267RTF_STYLESHEET_FILE =
268RTF_EXTENSIONS_FILE =
269RTF_SOURCE_CODE = NO
270#---------------------------------------------------------------------------
271# Configuration options related to the man page output
272#---------------------------------------------------------------------------
273GENERATE_MAN = NO
274MAN_OUTPUT = man
275MAN_EXTENSION = .3
276MAN_SUBDIR =
277MAN_LINKS = NO
278#---------------------------------------------------------------------------
279# Configuration options related to the XML output
280#---------------------------------------------------------------------------
281GENERATE_XML = NO
282XML_OUTPUT = xml
283XML_PROGRAMLISTING = YES
284#---------------------------------------------------------------------------
285# Configuration options related to the DOCBOOK output
286#---------------------------------------------------------------------------
287GENERATE_DOCBOOK = NO
288DOCBOOK_OUTPUT = docbook
289DOCBOOK_PROGRAMLISTING = NO
290#---------------------------------------------------------------------------
291# Configuration options for the AutoGen Definitions output
292#---------------------------------------------------------------------------
293GENERATE_AUTOGEN_DEF = NO
294#---------------------------------------------------------------------------
295# Configuration options related to the Perl module output
296#---------------------------------------------------------------------------
297GENERATE_PERLMOD = NO
298PERLMOD_LATEX = NO
299PERLMOD_PRETTY = YES
300PERLMOD_MAKEVAR_PREFIX =
301#---------------------------------------------------------------------------
302# Configuration options related to the preprocessor
303#---------------------------------------------------------------------------
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]304ENABLE_PREPROCESSING = YES
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]305MACRO_EXPANSION = NO
306EXPAND_ONLY_PREDEF = NO
307SEARCH_INCLUDES = YES
Andy Greend1f9f0a2018-08-23 09:46:01 +0800[diff] [blame]308INCLUDE_PATH = ./include
Andy Green014481e2016-06-20 17:05:31 +0800[diff] [blame]309INCLUDE_FILE_PATTERNS =
310PREDEFINED =
311EXPAND_AS_DEFINED =
312SKIP_FUNCTION_MACROS = YES
313#---------------------------------------------------------------------------
314# Configuration options related to external references
315#---------------------------------------------------------------------------
316TAGFILES =
317GENERATE_TAGFILE =
318ALLEXTERNALS = NO
319EXTERNAL_GROUPS = YES
320EXTERNAL_PAGES = YES
321PERL_PATH = /usr/bin/perl
322#---------------------------------------------------------------------------
323# Configuration options related to the dot tool
324#---------------------------------------------------------------------------
325CLASS_DIAGRAMS = YES
326MSCGEN_PATH =
327DIA_PATH =
328HIDE_UNDOC_RELATIONS = YES
329HAVE_DOT = NO
330DOT_NUM_THREADS = 0
331DOT_FONTNAME = Helvetica
332DOT_FONTSIZE = 10
333DOT_FONTPATH =
334CLASS_GRAPH = YES
335COLLABORATION_GRAPH = YES
336GROUP_GRAPHS = YES
337UML_LOOK = NO
338UML_LIMIT_NUM_FIELDS = 10
339TEMPLATE_RELATIONS = NO
340INCLUDE_GRAPH = YES
341INCLUDED_BY_GRAPH = YES
342CALL_GRAPH = NO
343CALLER_GRAPH = NO
344GRAPHICAL_HIERARCHY = YES
345DIRECTORY_GRAPH = YES
346DOT_IMAGE_FORMAT = png
347INTERACTIVE_SVG = NO
348DOT_PATH =
349DOTFILE_DIRS =
350MSCFILE_DIRS =
351DIAFILE_DIRS =
352PLANTUML_JAR_PATH =
353PLANTUML_INCLUDE_PATH =
354DOT_GRAPH_MAX_NODES = 50
355MAX_DOT_GRAPH_DEPTH = 0
356DOT_TRANSPARENT = NO
357DOT_MULTI_TARGETS = NO
358GENERATE_LEGEND = YES
359DOT_CLEANUP = YES