libwebsockets.dox

   1 # Doxyfile 1.8.11
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "libwebsockets"
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          = "Lightweight C library for HTML5 websockets"
  10 PROJECT_LOGO           = "./test-apps/libwebsockets.org-logo.svg"
  11 OUTPUT_DIRECTORY       = "doc"
  12 CREATE_SUBDIRS         = NO
  13 ALLOW_UNICODE_NAMES    = NO
  14 OUTPUT_LANGUAGE        = English
  15 BRIEF_MEMBER_DESC      = YES
  16 REPEAT_BRIEF           = YES
  17 ABBREVIATE_BRIEF       =
  18 ALWAYS_DETAILED_SEC    = NO
  19 INLINE_INHERITED_MEMB  = NO
  20 FULL_PATH_NAMES        = YES
  21 STRIP_FROM_PATH        =
  22 STRIP_FROM_INC_PATH    =
  23 SHORT_NAMES            = NO
  24 JAVADOC_AUTOBRIEF      = NO
  25 QT_AUTOBRIEF           = NO
  26 MULTILINE_CPP_IS_BRIEF = NO
  27 INHERIT_DOCS           = YES
  28 SEPARATE_MEMBER_PAGES  = NO
  29 TAB_SIZE               = 8
  30 ALIASES                =
  31 OPTIMIZE_OUTPUT_FOR_C  = YES
  32 OPTIMIZE_OUTPUT_JAVA   = NO
  33 OPTIMIZE_FOR_FORTRAN   = NO
  34 OPTIMIZE_OUTPUT_VHDL   = NO
  35 EXTENSION_MAPPING      =
  36 MARKDOWN_SUPPORT       = YES
  37 AUTOLINK_SUPPORT       = YES
  38 BUILTIN_STL_SUPPORT    = NO
  39 CPP_CLI_SUPPORT        = NO
  40 SIP_SUPPORT            = NO
  41 IDL_PROPERTY_SUPPORT   = YES
  42 DISTRIBUTE_GROUP_DOC   = NO
  43 GROUP_NESTED_COMPOUNDS = NO
  44 SUBGROUPING            = YES
  45 INLINE_GROUPED_CLASSES = NO
  46 INLINE_SIMPLE_STRUCTS  = NO
  47 TYPEDEF_HIDES_STRUCT   = NO
  48 LOOKUP_CACHE_SIZE      = 0
  49 #---------------------------------------------------------------------------
  50 # Build related configuration options
  51 #---------------------------------------------------------------------------
  52 EXTRACT_ALL            = NO
  53 EXTRACT_PRIVATE        = NO
  54 EXTRACT_PACKAGE        = NO
  55 EXTRACT_STATIC         = NO
  56 EXTRACT_LOCAL_CLASSES  = YES
  57 EXTRACT_LOCAL_METHODS  = NO
  58 EXTRACT_ANON_NSPACES   = NO
  59 HIDE_UNDOC_MEMBERS     = NO
  60 HIDE_UNDOC_CLASSES     = NO
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = NO
  63 INTERNAL_DOCS          = NO
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 HIDE_COMPOUND_REFERENCE= NO
  67 SHOW_INCLUDE_FILES     = YES
  68 SHOW_GROUPED_MEMB_INC  = YES
  69 FORCE_LOCAL_INCLUDES   = NO
  70 INLINE_INFO            = YES
  71 SORT_MEMBER_DOCS       = YES
  72 SORT_BRIEF_DOCS        = NO
  73 SORT_MEMBERS_CTORS_1ST = NO
  74 SORT_GROUP_NAMES       = YES
  75 SORT_BY_SCOPE_NAME     = NO
  76 STRICT_PROTO_MATCHING  = YES
  77 GENERATE_TODOLIST      = YES
  78 GENERATE_TESTLIST      = YES
  79 GENERATE_BUGLIST       = YES
  80 GENERATE_DEPRECATEDLIST= YES
  81 ENABLED_SECTIONS       =
  82 MAX_INITIALIZER_LINES  = 30
  83 SHOW_USED_FILES        = YES
  84 SHOW_FILES             = YES
  85 SHOW_NAMESPACES        = YES
  86 FILE_VERSION_FILTER    =
  87 LAYOUT_FILE            =
  88 CITE_BIB_FILES         =
  89 #---------------------------------------------------------------------------
  90 # Configuration options related to warning and progress messages
  91 #---------------------------------------------------------------------------
  92 QUIET                  = NO
  93 WARNINGS               = YES
  94 WARN_IF_UNDOCUMENTED   = NO
  95 WARN_IF_DOC_ERROR      = YES
  96 WARN_NO_PARAMDOC       = NO
  97 WARN_AS_ERROR          = NO
  98 WARN_FORMAT            = "$file:$line: $text"
  99 WARN_LOGFILE           =
 100 #---------------------------------------------------------------------------
 101 # Configuration options related to the input files
 102 #---------------------------------------------------------------------------
 103 INPUT                  = 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
 201 INPUT_ENCODING         = UTF-8
 202 FILE_PATTERNS          = lib/*.c *.md *.png include/*.h
 203 RECURSIVE              = NO
 204 EXCLUDE                =
 205 EXCLUDE_SYMLINKS       = NO
 206 EXCLUDE_PATTERNS       =
 207 EXCLUDE_SYMBOLS        =
 208 EXAMPLE_PATH           =
 209 EXAMPLE_PATTERNS       =
 210 EXAMPLE_RECURSIVE      = NO
 211 IMAGE_PATH             = doc-assets
 212 INPUT_FILTER           =
 213 FILTER_PATTERNS        =
 214 FILTER_SOURCE_FILES    = NO
 215 FILTER_SOURCE_PATTERNS =
 216 USE_MDFILE_AS_MAINPAGE = mainpage.md
 217 #---------------------------------------------------------------------------
 218 # Configuration options related to source browsing
 219 #---------------------------------------------------------------------------
 220 SOURCE_BROWSER         = NO
 221 INLINE_SOURCES         = YES
 222 STRIP_CODE_COMMENTS    = YES
 223 REFERENCED_BY_RELATION = NO
 224 REFERENCES_RELATION    = NO
 225 REFERENCES_LINK_SOURCE = YES
 226 SOURCE_TOOLTIPS        = YES
 227 USE_HTAGS              = NO
 228 VERBATIM_HEADERS       = YES
 229 #---------------------------------------------------------------------------
 230 # Configuration options related to the alphabetical class index
 231 #---------------------------------------------------------------------------
 232 ALPHABETICAL_INDEX     = YES
 233 COLS_IN_ALPHA_INDEX    = 5
 234 IGNORE_PREFIX          =
 235 #---------------------------------------------------------------------------
 236 # Configuration options related to the HTML output
 237 #---------------------------------------------------------------------------
 238 GENERATE_HTML          = YES
 239 HTML_OUTPUT            = html
 240 HTML_FILE_EXTENSION    = .html
 241 HTML_HEADER            =
 242 HTML_FOOTER            =
 243 HTML_STYLESHEET        =
 244 HTML_EXTRA_STYLESHEET  = scripts/dox-extra.css
 245 HTML_EXTRA_FILES       =
 246 HTML_COLORSTYLE_HUE    = 220
 247 HTML_COLORSTYLE_SAT    = 100
 248 HTML_COLORSTYLE_GAMMA  = 80
 249 HTML_TIMESTAMP         = NO
 250 HTML_DYNAMIC_SECTIONS  = NO
 251 HTML_INDEX_NUM_ENTRIES = 100
 252 GENERATE_DOCSET        = NO
 253 DOCSET_FEEDNAME        = "Doxygen generated docs"
 254 DOCSET_BUNDLE_ID       = org.doxygen.Project
 255 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 256 DOCSET_PUBLISHER_NAME  = Publisher
 257 GENERATE_HTMLHELP      = NO
 258 CHM_FILE               =
 259 HHC_LOCATION           =
 260 GENERATE_CHI           = NO
 261 CHM_INDEX_ENCODING     =
 262 BINARY_TOC             = NO
 263 TOC_EXPAND             = NO
 264 GENERATE_QHP           = NO
 265 QCH_FILE               =
 266 QHP_NAMESPACE          = org.doxygen.Project
 267 QHP_VIRTUAL_FOLDER     = doc
 268 QHP_CUST_FILTER_NAME   =
 269 QHP_CUST_FILTER_ATTRS  =
 270 QHP_SECT_FILTER_ATTRS  =
 271 QHG_LOCATION           =
 272 GENERATE_ECLIPSEHELP   = NO
 273 ECLIPSE_DOC_ID         = org.doxygen.Project
 274 DISABLE_INDEX          = NO
 275 GENERATE_TREEVIEW      = YES
 276 ENUM_VALUES_PER_LINE   = 4
 277 TREEVIEW_WIDTH         = 250
 278 EXT_LINKS_IN_WINDOW    = NO
 279 FORMULA_FONTSIZE       = 10
 280 FORMULA_TRANSPARENT    = YES
 281 USE_MATHJAX            = NO
 282 MATHJAX_FORMAT         = HTML-CSS
 283 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 284 MATHJAX_EXTENSIONS     =
 285 MATHJAX_CODEFILE       =
 286 SEARCHENGINE           = NO
 287 SERVER_BASED_SEARCH    = NO
 288 EXTERNAL_SEARCH        = NO
 289 SEARCHENGINE_URL       =
 290 SEARCHDATA_FILE        = searchdata.xml
 291 EXTERNAL_SEARCH_ID     =
 292 EXTRA_SEARCH_MAPPINGS  =
 293 #---------------------------------------------------------------------------
 294 # Configuration options related to the LaTeX output
 295 #---------------------------------------------------------------------------
 296 GENERATE_LATEX         = NO
 297 LATEX_OUTPUT           = latex
 298 LATEX_CMD_NAME         = latex
 299 MAKEINDEX_CMD_NAME     = makeindex
 300 COMPACT_LATEX          = NO
 301 PAPER_TYPE             = a4
 302 EXTRA_PACKAGES         =
 303 LATEX_HEADER           =
 304 LATEX_FOOTER           =
 305 LATEX_EXTRA_STYLESHEET =
 306 LATEX_EXTRA_FILES      =
 307 PDF_HYPERLINKS         = YES
 308 USE_PDFLATEX           = YES
 309 LATEX_BATCHMODE        = NO
 310 LATEX_HIDE_INDICES     = NO
 311 LATEX_SOURCE_CODE      = NO
 312 LATEX_BIB_STYLE        = plain
 313 LATEX_TIMESTAMP        = NO
 314 #---------------------------------------------------------------------------
 315 # Configuration options related to the RTF output
 316 #---------------------------------------------------------------------------
 317 GENERATE_RTF           = NO
 318 RTF_OUTPUT             = rtf
 319 COMPACT_RTF            = NO
 320 RTF_HYPERLINKS         = NO
 321 RTF_STYLESHEET_FILE    =
 322 RTF_EXTENSIONS_FILE    =
 323 RTF_SOURCE_CODE        = NO
 324 #---------------------------------------------------------------------------
 325 # Configuration options related to the man page output
 326 #---------------------------------------------------------------------------
 327 GENERATE_MAN           = NO
 328 MAN_OUTPUT             = man
 329 MAN_EXTENSION          = .3
 330 MAN_SUBDIR             =
 331 MAN_LINKS              = NO
 332 #---------------------------------------------------------------------------
 333 # Configuration options related to the XML output
 334 #---------------------------------------------------------------------------
 335 GENERATE_XML           = NO
 336 XML_OUTPUT             = xml
 337 XML_PROGRAMLISTING     = YES
 338 #---------------------------------------------------------------------------
 339 # Configuration options related to the DOCBOOK output
 340 #---------------------------------------------------------------------------
 341 GENERATE_DOCBOOK       = NO
 342 DOCBOOK_OUTPUT         = docbook
 343 DOCBOOK_PROGRAMLISTING = NO
 344 #---------------------------------------------------------------------------
 345 # Configuration options for the AutoGen Definitions output
 346 #---------------------------------------------------------------------------
 347 GENERATE_AUTOGEN_DEF   = NO
 348 #---------------------------------------------------------------------------
 349 # Configuration options related to the Perl module output
 350 #---------------------------------------------------------------------------
 351 GENERATE_PERLMOD       = NO
 352 PERLMOD_LATEX          = NO
 353 PERLMOD_PRETTY         = YES
 354 PERLMOD_MAKEVAR_PREFIX =
 355 #---------------------------------------------------------------------------
 356 # Configuration options related to the preprocessor
 357 #---------------------------------------------------------------------------
 358 ENABLE_PREPROCESSING   = YES
 359 MACRO_EXPANSION        = NO
 360 EXPAND_ONLY_PREDEF     = NO
 361 SEARCH_INCLUDES        = YES
 362 INCLUDE_PATH           = ./include
 363 INCLUDE_FILE_PATTERNS  =
 364 PREDEFINED             =
 365 EXPAND_AS_DEFINED      =
 366 SKIP_FUNCTION_MACROS   = YES
 367 #---------------------------------------------------------------------------
 368 # Configuration options related to external references
 369 #---------------------------------------------------------------------------
 370 TAGFILES               =
 371 GENERATE_TAGFILE       =
 372 ALLEXTERNALS           = NO
 373 EXTERNAL_GROUPS        = YES
 374 EXTERNAL_PAGES         = YES
 375 #---------------------------------------------------------------------------
 376 # Configuration options related to the dot tool
 377 #---------------------------------------------------------------------------
 378 CLASS_DIAGRAMS         = YES
 379 DIA_PATH               =
 380 HIDE_UNDOC_RELATIONS   = YES
 381 HAVE_DOT               = NO
 382 DOT_NUM_THREADS        = 0
 383 DOT_FONTNAME           = Helvetica
 384 DOT_FONTSIZE           = 10
 385 DOT_FONTPATH           =
 386 CLASS_GRAPH            = YES
 387 COLLABORATION_GRAPH    = YES
 388 GROUP_GRAPHS           = YES
 389 UML_LOOK               = NO
 390 UML_LIMIT_NUM_FIELDS   = 10
 391 TEMPLATE_RELATIONS     = NO
 392 INCLUDE_GRAPH          = YES
 393 INCLUDED_BY_GRAPH      = YES
 394 CALL_GRAPH             = NO
 395 CALLER_GRAPH           = NO
 396 GRAPHICAL_HIERARCHY    = YES
 397 DIRECTORY_GRAPH        = YES
 398 DOT_IMAGE_FORMAT       = png
 399 INTERACTIVE_SVG        = NO
 400 DOT_PATH               =
 401 DOTFILE_DIRS           =
 402 MSCFILE_DIRS           =
 403 DIAFILE_DIRS           =
 404 PLANTUML_JAR_PATH      =
 405 PLANTUML_INCLUDE_PATH  =
 406 DOT_GRAPH_MAX_NODES    = 50
 407 MAX_DOT_GRAPH_DEPTH    = 0
 408 DOT_TRANSPARENT        = NO
 409 DOT_MULTI_TARGETS      = NO
 410 GENERATE_LEGEND        = YES
 411 DOT_CLEANUP            = YES