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