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