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-esp32.h \
 113                          include/libwebsockets/lws-fts.h \
 114                          include/libwebsockets/lws-genhash.h \
 115                          include/libwebsockets/lws-genrsa.h \
 116                          include/libwebsockets/lws-http.h \
 117                          include/libwebsockets/lws-jwk.h \
 118                          include/libwebsockets/lws-jws.h \
 119                          include/libwebsockets/lws-lejp.h \
 120                          include/libwebsockets/lws-logs.h \
 121                          include/libwebsockets/lws-lwsac.h \
 122                          include/libwebsockets/lws-misc.h \
 123                          include/libwebsockets/lws-network-helper.h \
 124                          include/libwebsockets/lws-plugin-generic-sessions.h \
 125                          include/libwebsockets/lws-protocols-plugins.h \
 126                          include/libwebsockets/lws-purify.h \
 127                          include/libwebsockets/lws-ring.h \
 128                          include/libwebsockets/lws-service.h \
 129                          include/libwebsockets/lws-sha1-base64.h \
 130                          include/libwebsockets/lws-spa.h \
 131                          include/libwebsockets/lws-stats.h \
 132                          include/libwebsockets/lws-threadpool.h \
 133                          include/libwebsockets/lws-timeout-timer.h \
 134                          include/libwebsockets/lws-tokenize.h \
 135                          include/libwebsockets/lws-vfs.h \
 136                          include/libwebsockets/lws-write.h \
 137                          include/libwebsockets/lws-writeable.h \
 138                          include/libwebsockets/lws-ws-close.h \
 139                          include/libwebsockets/lws-ws-ext.h \
 140                          include/libwebsockets/lws-ws-state.h \
 141                          include/libwebsockets/lws-x509.h \
 142                          plugins/ssh-base/include/lws-plugin-ssh.h \
 143                          ./READMEs/mainpage.md \
 144                          ./READMEs/README.build.md \
 145                          ./READMEs/README.ci.md \
 146                          ./READMEs/README.content-security-policy.md \
 147                          ./READMEs/README.contributing.md \
 148                          ./READMEs/README.http-fallback.md \
 149                          ./READMEs/README.release-policy.md \
 150                          ./READMEs/README.unix-domain-reverse-proxy.md \
 151                          ./READMEs/README.vulnerability-reporting.md \
 152                          ./READMEs/README.problems.md \
 153                          ./READMEs/README.lwsws.md \
 154                          ./READMEs/README.coding.md \
 155                          ./READMEs/README.esp32.md \
 156                          ./READMEs/README.generic-sessions.md \
 157                          ./READMEs/README.generic-table.md \
 158                          ./READMEs/README.test-apps.md \
 159                          ./READMEs/README-plugin-sshd-base.md \
 160                          ./READMEs/README.plugin-acme.md \
 161                          ./doc-assets
 162 INPUT_ENCODING         = UTF-8
 163 FILE_PATTERNS          = lib/*.c *.md *.png include/*.h
 164 RECURSIVE              = NO
 165 EXCLUDE                =
 166 EXCLUDE_SYMLINKS       = NO
 167 EXCLUDE_PATTERNS       =
 168 EXCLUDE_SYMBOLS        =
 169 EXAMPLE_PATH           =
 170 EXAMPLE_PATTERNS       =
 171 EXAMPLE_RECURSIVE      = NO
 172 IMAGE_PATH             = doc-assets
 173 INPUT_FILTER           =
 174 FILTER_PATTERNS        =
 175 FILTER_SOURCE_FILES    = NO
 176 FILTER_SOURCE_PATTERNS =
 177 USE_MDFILE_AS_MAINPAGE = mainpage.md
 178 #---------------------------------------------------------------------------
 179 # Configuration options related to source browsing
 180 #---------------------------------------------------------------------------
 181 SOURCE_BROWSER         = NO
 182 INLINE_SOURCES         = YES
 183 STRIP_CODE_COMMENTS    = YES
 184 REFERENCED_BY_RELATION = NO
 185 REFERENCES_RELATION    = NO
 186 REFERENCES_LINK_SOURCE = YES
 187 SOURCE_TOOLTIPS        = YES
 188 USE_HTAGS              = NO
 189 VERBATIM_HEADERS       = YES
 190 #---------------------------------------------------------------------------
 191 # Configuration options related to the alphabetical class index
 192 #---------------------------------------------------------------------------
 193 ALPHABETICAL_INDEX     = YES
 194 COLS_IN_ALPHA_INDEX    = 5
 195 IGNORE_PREFIX          =
 196 #---------------------------------------------------------------------------
 197 # Configuration options related to the HTML output
 198 #---------------------------------------------------------------------------
 199 GENERATE_HTML          = YES
 200 HTML_OUTPUT            = html
 201 HTML_FILE_EXTENSION    = .html
 202 HTML_HEADER            =
 203 HTML_FOOTER            =
 204 HTML_STYLESHEET        =
 205 HTML_EXTRA_STYLESHEET  =
 206 HTML_EXTRA_FILES       =
 207 HTML_COLORSTYLE_HUE    = 220
 208 HTML_COLORSTYLE_SAT    = 100
 209 HTML_COLORSTYLE_GAMMA  = 80
 210 HTML_TIMESTAMP         = NO
 211 HTML_DYNAMIC_SECTIONS  = NO
 212 HTML_INDEX_NUM_ENTRIES = 100
 213 GENERATE_DOCSET        = NO
 214 DOCSET_FEEDNAME        = "Doxygen generated docs"
 215 DOCSET_BUNDLE_ID       = org.doxygen.Project
 216 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 217 DOCSET_PUBLISHER_NAME  = Publisher
 218 GENERATE_HTMLHELP      = NO
 219 CHM_FILE               =
 220 HHC_LOCATION           =
 221 GENERATE_CHI           = NO
 222 CHM_INDEX_ENCODING     =
 223 BINARY_TOC             = NO
 224 TOC_EXPAND             = NO
 225 GENERATE_QHP           = NO
 226 QCH_FILE               =
 227 QHP_NAMESPACE          = org.doxygen.Project
 228 QHP_VIRTUAL_FOLDER     = doc
 229 QHP_CUST_FILTER_NAME   =
 230 QHP_CUST_FILTER_ATTRS  =
 231 QHP_SECT_FILTER_ATTRS  =
 232 QHG_LOCATION           =
 233 GENERATE_ECLIPSEHELP   = NO
 234 ECLIPSE_DOC_ID         = org.doxygen.Project
 235 DISABLE_INDEX          = NO
 236 GENERATE_TREEVIEW      = YES
 237 ENUM_VALUES_PER_LINE   = 4
 238 TREEVIEW_WIDTH         = 250
 239 EXT_LINKS_IN_WINDOW    = NO
 240 FORMULA_FONTSIZE       = 10
 241 FORMULA_TRANSPARENT    = YES
 242 USE_MATHJAX            = NO
 243 MATHJAX_FORMAT         = HTML-CSS
 244 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 245 MATHJAX_EXTENSIONS     =
 246 MATHJAX_CODEFILE       =
 247 SEARCHENGINE           = NO
 248 SERVER_BASED_SEARCH    = NO
 249 EXTERNAL_SEARCH        = NO
 250 SEARCHENGINE_URL       =
 251 SEARCHDATA_FILE        = searchdata.xml
 252 EXTERNAL_SEARCH_ID     =
 253 EXTRA_SEARCH_MAPPINGS  =
 254 #---------------------------------------------------------------------------
 255 # Configuration options related to the LaTeX output
 256 #---------------------------------------------------------------------------
 257 GENERATE_LATEX         = NO
 258 LATEX_OUTPUT           = latex
 259 LATEX_CMD_NAME         = latex
 260 MAKEINDEX_CMD_NAME     = makeindex
 261 COMPACT_LATEX          = NO
 262 PAPER_TYPE             = a4
 263 EXTRA_PACKAGES         =
 264 LATEX_HEADER           =
 265 LATEX_FOOTER           =
 266 LATEX_EXTRA_STYLESHEET =
 267 LATEX_EXTRA_FILES      =
 268 PDF_HYPERLINKS         = YES
 269 USE_PDFLATEX           = YES
 270 LATEX_BATCHMODE        = NO
 271 LATEX_HIDE_INDICES     = NO
 272 LATEX_SOURCE_CODE      = NO
 273 LATEX_BIB_STYLE        = plain
 274 LATEX_TIMESTAMP        = NO
 275 #---------------------------------------------------------------------------
 276 # Configuration options related to the RTF output
 277 #---------------------------------------------------------------------------
 278 GENERATE_RTF           = NO
 279 RTF_OUTPUT             = rtf
 280 COMPACT_RTF            = NO
 281 RTF_HYPERLINKS         = NO
 282 RTF_STYLESHEET_FILE    =
 283 RTF_EXTENSIONS_FILE    =
 284 RTF_SOURCE_CODE        = NO
 285 #---------------------------------------------------------------------------
 286 # Configuration options related to the man page output
 287 #---------------------------------------------------------------------------
 288 GENERATE_MAN           = NO
 289 MAN_OUTPUT             = man
 290 MAN_EXTENSION          = .3
 291 MAN_SUBDIR             =
 292 MAN_LINKS              = NO
 293 #---------------------------------------------------------------------------
 294 # Configuration options related to the XML output
 295 #---------------------------------------------------------------------------
 296 GENERATE_XML           = NO
 297 XML_OUTPUT             = xml
 298 XML_PROGRAMLISTING     = YES
 299 #---------------------------------------------------------------------------
 300 # Configuration options related to the DOCBOOK output
 301 #---------------------------------------------------------------------------
 302 GENERATE_DOCBOOK       = NO
 303 DOCBOOK_OUTPUT         = docbook
 304 DOCBOOK_PROGRAMLISTING = NO
 305 #---------------------------------------------------------------------------
 306 # Configuration options for the AutoGen Definitions output
 307 #---------------------------------------------------------------------------
 308 GENERATE_AUTOGEN_DEF   = NO
 309 #---------------------------------------------------------------------------
 310 # Configuration options related to the Perl module output
 311 #---------------------------------------------------------------------------
 312 GENERATE_PERLMOD       = NO
 313 PERLMOD_LATEX          = NO
 314 PERLMOD_PRETTY         = YES
 315 PERLMOD_MAKEVAR_PREFIX =
 316 #---------------------------------------------------------------------------
 317 # Configuration options related to the preprocessor
 318 #---------------------------------------------------------------------------
 319 ENABLE_PREPROCESSING   = YES
 320 MACRO_EXPANSION        = NO
 321 EXPAND_ONLY_PREDEF     = NO
 322 SEARCH_INCLUDES        = YES
 323 INCLUDE_PATH           = ./include
 324 INCLUDE_FILE_PATTERNS  =
 325 PREDEFINED             =
 326 EXPAND_AS_DEFINED      =
 327 SKIP_FUNCTION_MACROS   = YES
 328 #---------------------------------------------------------------------------
 329 # Configuration options related to external references
 330 #---------------------------------------------------------------------------
 331 TAGFILES               =
 332 GENERATE_TAGFILE       =
 333 ALLEXTERNALS           = NO
 334 EXTERNAL_GROUPS        = YES
 335 EXTERNAL_PAGES         = YES
 336 PERL_PATH              = /usr/bin/perl
 337 #---------------------------------------------------------------------------
 338 # Configuration options related to the dot tool
 339 #---------------------------------------------------------------------------
 340 CLASS_DIAGRAMS         = YES
 341 MSCGEN_PATH            =
 342 DIA_PATH               =
 343 HIDE_UNDOC_RELATIONS   = YES
 344 HAVE_DOT               = NO
 345 DOT_NUM_THREADS        = 0
 346 DOT_FONTNAME           = Helvetica
 347 DOT_FONTSIZE           = 10
 348 DOT_FONTPATH           =
 349 CLASS_GRAPH            = YES
 350 COLLABORATION_GRAPH    = YES
 351 GROUP_GRAPHS           = YES
 352 UML_LOOK               = NO
 353 UML_LIMIT_NUM_FIELDS   = 10
 354 TEMPLATE_RELATIONS     = NO
 355 INCLUDE_GRAPH          = YES
 356 INCLUDED_BY_GRAPH      = YES
 357 CALL_GRAPH             = NO
 358 CALLER_GRAPH           = NO
 359 GRAPHICAL_HIERARCHY    = YES
 360 DIRECTORY_GRAPH        = YES
 361 DOT_IMAGE_FORMAT       = png
 362 INTERACTIVE_SVG        = NO
 363 DOT_PATH               =
 364 DOTFILE_DIRS           =
 365 MSCFILE_DIRS           =
 366 DIAFILE_DIRS           =
 367 PLANTUML_JAR_PATH      =
 368 PLANTUML_INCLUDE_PATH  =
 369 DOT_GRAPH_MAX_NODES    = 50
 370 MAX_DOT_GRAPH_DEPTH    = 0
 371 DOT_TRANSPARENT        = NO
 372 DOT_MULTI_TARGETS      = NO
 373 GENERATE_LEGEND        = YES
 374 DOT_CLEANUP            = YES