3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
7 PROJECT_NAME = "libwebsockets"
9 PROJECT_BRIEF = "Lightweight C library for HTML5 websockets"
10 PROJECT_LOGO = "./test-server/libwebsockets.org-logo.png"
11 OUTPUT_DIRECTORY = "doc"
13 ALLOW_UNICODE_NAMES = NO
14 OUTPUT_LANGUAGE = English
15 BRIEF_MEMBER_DESC = YES
18 ALWAYS_DETAILED_SEC = NO
19 INLINE_INHERITED_MEMB = NO
24 JAVADOC_AUTOBRIEF = NO
26 MULTILINE_CPP_IS_BRIEF = NO
28 SEPARATE_MEMBER_PAGES = NO
32 OPTIMIZE_OUTPUT_FOR_C = YES
33 OPTIMIZE_OUTPUT_JAVA = NO
34 OPTIMIZE_FOR_FORTRAN = NO
35 OPTIMIZE_OUTPUT_VHDL = NO
37 MARKDOWN_SUPPORT = YES
38 AUTOLINK_SUPPORT = YES
39 BUILTIN_STL_SUPPORT = NO
42 IDL_PROPERTY_SUPPORT = YES
43 DISTRIBUTE_GROUP_DOC = NO
44 GROUP_NESTED_COMPOUNDS = NO
46 INLINE_GROUPED_CLASSES = NO
47 INLINE_SIMPLE_STRUCTS = NO
48 TYPEDEF_HIDES_STRUCT = NO
50 #---------------------------------------------------------------------------
51 # Build related configuration options
52 #---------------------------------------------------------------------------
57 EXTRACT_LOCAL_CLASSES = YES
58 EXTRACT_LOCAL_METHODS = NO
59 EXTRACT_ANON_NSPACES = NO
60 HIDE_UNDOC_MEMBERS = NO
61 HIDE_UNDOC_CLASSES = NO
62 HIDE_FRIEND_COMPOUNDS = NO
63 HIDE_IN_BODY_DOCS = NO
65 CASE_SENSE_NAMES = YES
67 HIDE_COMPOUND_REFERENCE= NO
68 SHOW_INCLUDE_FILES = YES
69 SHOW_GROUPED_MEMB_INC = YES
70 FORCE_LOCAL_INCLUDES = NO
72 SORT_MEMBER_DOCS = YES
74 SORT_MEMBERS_CTORS_1ST = NO
75 SORT_GROUP_NAMES = YES
76 SORT_BY_SCOPE_NAME = NO
77 STRICT_PROTO_MATCHING = YES
78 GENERATE_TODOLIST = YES
79 GENERATE_TESTLIST = YES
80 GENERATE_BUGLIST = YES
81 GENERATE_DEPRECATEDLIST= YES
83 MAX_INITIALIZER_LINES = 30
90 #---------------------------------------------------------------------------
91 # Configuration options related to warning and progress messages
92 #---------------------------------------------------------------------------
95 WARN_IF_UNDOCUMENTED = NO
96 WARN_IF_DOC_ERROR = YES
99 WARN_FORMAT = "$file:$line: $text"
101 #---------------------------------------------------------------------------
102 # Configuration options related to the input files
103 #---------------------------------------------------------------------------
104 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
105 INPUT_ENCODING = UTF-8
106 FILE_PATTERNS = lib/*.c *.md *.png
109 EXCLUDE_SYMLINKS = NO
114 EXAMPLE_RECURSIVE = NO
115 IMAGE_PATH = doc-assets
118 FILTER_SOURCE_FILES = NO
119 FILTER_SOURCE_PATTERNS =
120 USE_MDFILE_AS_MAINPAGE = mainpage.md
121 #---------------------------------------------------------------------------
122 # Configuration options related to source browsing
123 #---------------------------------------------------------------------------
126 STRIP_CODE_COMMENTS = YES
127 REFERENCED_BY_RELATION = NO
128 REFERENCES_RELATION = NO
129 REFERENCES_LINK_SOURCE = YES
130 SOURCE_TOOLTIPS = YES
132 VERBATIM_HEADERS = YES
133 #---------------------------------------------------------------------------
134 # Configuration options related to the alphabetical class index
135 #---------------------------------------------------------------------------
136 ALPHABETICAL_INDEX = YES
137 COLS_IN_ALPHA_INDEX = 5
139 #---------------------------------------------------------------------------
140 # Configuration options related to the HTML output
141 #---------------------------------------------------------------------------
144 HTML_FILE_EXTENSION = .html
148 HTML_EXTRA_STYLESHEET =
150 HTML_COLORSTYLE_HUE = 220
151 HTML_COLORSTYLE_SAT = 100
152 HTML_COLORSTYLE_GAMMA = 80
154 HTML_DYNAMIC_SECTIONS = NO
155 HTML_INDEX_NUM_ENTRIES = 100
157 DOCSET_FEEDNAME = "Doxygen generated docs"
158 DOCSET_BUNDLE_ID = org.doxygen.Project
159 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
160 DOCSET_PUBLISHER_NAME = Publisher
161 GENERATE_HTMLHELP = NO
170 QHP_NAMESPACE = org.doxygen.Project
171 QHP_VIRTUAL_FOLDER = doc
172 QHP_CUST_FILTER_NAME =
173 QHP_CUST_FILTER_ATTRS =
174 QHP_SECT_FILTER_ATTRS =
176 GENERATE_ECLIPSEHELP = NO
177 ECLIPSE_DOC_ID = org.doxygen.Project
179 GENERATE_TREEVIEW = YES
180 ENUM_VALUES_PER_LINE = 4
182 EXT_LINKS_IN_WINDOW = NO
183 FORMULA_FONTSIZE = 10
184 FORMULA_TRANSPARENT = YES
186 MATHJAX_FORMAT = HTML-CSS
187 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
191 SERVER_BASED_SEARCH = NO
194 SEARCHDATA_FILE = searchdata.xml
196 EXTRA_SEARCH_MAPPINGS =
197 #---------------------------------------------------------------------------
198 # Configuration options related to the LaTeX output
199 #---------------------------------------------------------------------------
202 LATEX_CMD_NAME = latex
203 MAKEINDEX_CMD_NAME = makeindex
209 LATEX_EXTRA_STYLESHEET =
214 LATEX_HIDE_INDICES = NO
215 LATEX_SOURCE_CODE = NO
216 LATEX_BIB_STYLE = plain
218 #---------------------------------------------------------------------------
219 # Configuration options related to the RTF output
220 #---------------------------------------------------------------------------
225 RTF_STYLESHEET_FILE =
226 RTF_EXTENSIONS_FILE =
228 #---------------------------------------------------------------------------
229 # Configuration options related to the man page output
230 #---------------------------------------------------------------------------
236 #---------------------------------------------------------------------------
237 # Configuration options related to the XML output
238 #---------------------------------------------------------------------------
241 XML_PROGRAMLISTING = YES
242 #---------------------------------------------------------------------------
243 # Configuration options related to the DOCBOOK output
244 #---------------------------------------------------------------------------
245 GENERATE_DOCBOOK = NO
246 DOCBOOK_OUTPUT = docbook
247 DOCBOOK_PROGRAMLISTING = NO
248 #---------------------------------------------------------------------------
249 # Configuration options for the AutoGen Definitions output
250 #---------------------------------------------------------------------------
251 GENERATE_AUTOGEN_DEF = NO
252 #---------------------------------------------------------------------------
253 # Configuration options related to the Perl module output
254 #---------------------------------------------------------------------------
255 GENERATE_PERLMOD = NO
258 PERLMOD_MAKEVAR_PREFIX =
259 #---------------------------------------------------------------------------
260 # Configuration options related to the preprocessor
261 #---------------------------------------------------------------------------
262 ENABLE_PREPROCESSING = NO
264 EXPAND_ONLY_PREDEF = NO
265 SEARCH_INCLUDES = YES
267 INCLUDE_FILE_PATTERNS =
270 SKIP_FUNCTION_MACROS = YES
271 #---------------------------------------------------------------------------
272 # Configuration options related to external references
273 #---------------------------------------------------------------------------
277 EXTERNAL_GROUPS = YES
279 PERL_PATH = /usr/bin/perl
280 #---------------------------------------------------------------------------
281 # Configuration options related to the dot tool
282 #---------------------------------------------------------------------------
286 HIDE_UNDOC_RELATIONS = YES
289 DOT_FONTNAME = Helvetica
293 COLLABORATION_GRAPH = YES
296 UML_LIMIT_NUM_FIELDS = 10
297 TEMPLATE_RELATIONS = NO
299 INCLUDED_BY_GRAPH = YES
302 GRAPHICAL_HIERARCHY = YES
303 DIRECTORY_GRAPH = YES
304 DOT_IMAGE_FORMAT = png
311 PLANTUML_INCLUDE_PATH =
312 DOT_GRAPH_MAX_NODES = 50
313 MAX_DOT_GRAPH_DEPTH = 0
315 DOT_MULTI_TARGETS = NO
316 GENERATE_LEGEND = YES