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