libs/asio/doc/reference.dox

   1 # Doxyfile 1.4.5
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "Boost.Asio Reference"
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = .
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 USE_WINDOWS_ENCODING   = NO
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       =
  15 ALWAYS_DETAILED_SEC    = YES
  16 INLINE_INHERITED_MEMB  = YES
  17 FULL_PATH_NAMES        = YES
  18 STRIP_FROM_PATH        = ./../../../
  19 STRIP_FROM_INC_PATH    =
  20 SHORT_NAMES            = NO
  21 JAVADOC_AUTOBRIEF      = NO
  22 MULTILINE_CPP_IS_BRIEF = YES
  23 DETAILS_AT_TOP         = YES
  24 INHERIT_DOCS           = NO
  25 SEPARATE_MEMBER_PAGES  = NO
  26 TAB_SIZE               = 2
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = NO
  29 OPTIMIZE_OUTPUT_JAVA   = NO
  30 BUILTIN_STL_SUPPORT    = NO
  31 DISTRIBUTE_GROUP_DOC   = NO
  32 SUBGROUPING            = YES
  33 #---------------------------------------------------------------------------
  34 # Build related configuration options
  35 #---------------------------------------------------------------------------
  36 EXTRACT_ALL            = YES
  37 EXTRACT_PRIVATE        = YES
  38 EXTRACT_STATIC         = YES
  39 EXTRACT_LOCAL_CLASSES  = NO
  40 EXTRACT_LOCAL_METHODS  = NO
  41 HIDE_UNDOC_MEMBERS     = YES
  42 HIDE_UNDOC_CLASSES     = YES
  43 HIDE_FRIEND_COMPOUNDS  = NO
  44 HIDE_IN_BODY_DOCS      = NO
  45 INTERNAL_DOCS          = NO
  46 CASE_SENSE_NAMES       = YES
  47 HIDE_SCOPE_NAMES       = NO
  48 SHOW_INCLUDE_FILES     = NO
  49 INLINE_INFO            = NO
  50 SORT_MEMBER_DOCS       = NO
  51 SORT_BRIEF_DOCS        = NO
  52 SORT_BY_SCOPE_NAME     = NO
  53 GENERATE_TODOLIST      = NO
  54 GENERATE_TESTLIST      = NO
  55 GENERATE_BUGLIST       = NO
  56 GENERATE_DEPRECATEDLIST= NO
  57 ENABLED_SECTIONS       =
  58 MAX_INITIALIZER_LINES  = 30
  59 SHOW_USED_FILES        = NO
  60 SHOW_DIRECTORIES       = NO
  61 FILE_VERSION_FILTER    =
  62 #---------------------------------------------------------------------------
  63 # configuration options related to warning and progress messages
  64 #---------------------------------------------------------------------------
  65 QUIET                  = NO
  66 WARNINGS               = YES
  67 WARN_IF_UNDOCUMENTED   = YES
  68 WARN_IF_DOC_ERROR      = YES
  69 WARN_NO_PARAMDOC       = NO
  70 WARN_FORMAT            = "$file:$line: $text"
  71 WARN_LOGFILE           =
  72 #---------------------------------------------------------------------------
  73 # configuration options related to the input files
  74 #---------------------------------------------------------------------------
  75 INPUT                  = ./../../../boost/asio.hpp \
  76                          ./../../../boost/asio \
  77                          ./../../../boost/asio/generic \
  78                          ./../../../boost/asio/impl \
  79                          ./../../../boost/asio/ip \
  80                          ./../../../boost/asio/local \
  81                          ./../../../boost/asio/posix \
  82                          ./../../../boost/asio/ssl \
  83                          ./../../../boost/asio/windows \
  84                          ./noncopyable_dox.txt \
  85                          ./std_exception_dox.txt
  86 FILE_PATTERNS          =
  87 RECURSIVE              = NO
  88 EXCLUDE                =
  89 EXCLUDE_SYMLINKS       = NO
  90 EXCLUDE_PATTERNS       =
  91 EXAMPLE_PATH           =
  92 EXAMPLE_PATTERNS       =
  93 EXAMPLE_RECURSIVE      = YES
  94 IMAGE_PATH             =
  95 INPUT_FILTER           =
  96 FILTER_PATTERNS        =
  97 FILTER_SOURCE_FILES    = NO
  98 #---------------------------------------------------------------------------
  99 # configuration options related to source browsing
 100 #---------------------------------------------------------------------------
 101 SOURCE_BROWSER         = NO
 102 INLINE_SOURCES         = NO
 103 STRIP_CODE_COMMENTS    = YES
 104 REFERENCED_BY_RELATION = NO
 105 REFERENCES_RELATION    = NO
 106 USE_HTAGS              = NO
 107 VERBATIM_HEADERS       = NO
 108 #---------------------------------------------------------------------------
 109 # configuration options related to the alphabetical class index
 110 #---------------------------------------------------------------------------
 111 ALPHABETICAL_INDEX     = YES
 112 COLS_IN_ALPHA_INDEX    = 1
 113 IGNORE_PREFIX          =
 114 #---------------------------------------------------------------------------
 115 # configuration options related to the HTML output
 116 #---------------------------------------------------------------------------
 117 GENERATE_HTML          = NO
 118 HTML_OUTPUT            = .
 119 HTML_FILE_EXTENSION    = .html
 120 HTML_HEADER            =
 121 HTML_FOOTER            =
 122 HTML_STYLESHEET        =
 123 HTML_ALIGN_MEMBERS     = YES
 124 GENERATE_HTMLHELP      = NO
 125 CHM_FILE               =
 126 HHC_LOCATION           =
 127 GENERATE_CHI           = NO
 128 BINARY_TOC             = NO
 129 TOC_EXPAND             = NO
 130 DISABLE_INDEX          = YES
 131 ENUM_VALUES_PER_LINE   = 1
 132 GENERATE_TREEVIEW      = NO
 133 TREEVIEW_WIDTH         = 250
 134 #---------------------------------------------------------------------------
 135 # configuration options related to the LaTeX output
 136 #---------------------------------------------------------------------------
 137 GENERATE_LATEX         = NO
 138 LATEX_OUTPUT           = latex
 139 LATEX_CMD_NAME         = latex
 140 MAKEINDEX_CMD_NAME     = makeindex
 141 COMPACT_LATEX          = NO
 142 PAPER_TYPE             = a4wide
 143 EXTRA_PACKAGES         =
 144 LATEX_HEADER           =
 145 PDF_HYPERLINKS         = NO
 146 USE_PDFLATEX           = NO
 147 LATEX_BATCHMODE        = NO
 148 LATEX_HIDE_INDICES     = NO
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the RTF output
 151 #---------------------------------------------------------------------------
 152 GENERATE_RTF           = NO
 153 RTF_OUTPUT             = rtf
 154 COMPACT_RTF            = NO
 155 RTF_HYPERLINKS         = NO
 156 RTF_STYLESHEET_FILE    =
 157 RTF_EXTENSIONS_FILE    =
 158 #---------------------------------------------------------------------------
 159 # configuration options related to the man page output
 160 #---------------------------------------------------------------------------
 161 GENERATE_MAN           = NO
 162 MAN_OUTPUT             = man
 163 MAN_EXTENSION          = .3
 164 MAN_LINKS              = NO
 165 #---------------------------------------------------------------------------
 166 # configuration options related to the XML output
 167 #---------------------------------------------------------------------------
 168 GENERATE_XML           = YES
 169 XML_OUTPUT             = xml
 170 XML_SCHEMA             =
 171 XML_DTD                =
 172 XML_PROGRAMLISTING     = NO
 173 #---------------------------------------------------------------------------
 174 # configuration options for the AutoGen Definitions output
 175 #---------------------------------------------------------------------------
 176 GENERATE_AUTOGEN_DEF   = NO
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the Perl module output
 179 #---------------------------------------------------------------------------
 180 GENERATE_PERLMOD       = NO
 181 PERLMOD_LATEX          = NO
 182 PERLMOD_PRETTY         = YES
 183 PERLMOD_MAKEVAR_PREFIX =
 184 #---------------------------------------------------------------------------
 185 # Configuration options related to the preprocessor
 186 #---------------------------------------------------------------------------
 187 ENABLE_PREPROCESSING   = YES
 188 MACRO_EXPANSION        = YES
 189 EXPAND_ONLY_PREDEF     = YES
 190 SEARCH_INCLUDES        = YES
 191 INCLUDE_PATH           =
 192 INCLUDE_FILE_PATTERNS  =
 193 PREDEFINED             = GENERATING_DOCUMENTATION \
 194                          BOOST_ASIO_SOCKET_ERROR(e)=implementation_defined \
 195                          BOOST_ASIO_NETDB_ERROR(e)=implementation_defined \
 196                          BOOST_ASIO_EOF_ERROR(e)=implementation_defined \
 197                          BOOST_ASIO_OS_ERROR(e1,e2)=implementation_defined \
 198                          BOOST_ASIO_MOVE_ARG(a)=a&& \
 199                          BOOST_ASIO_NONDEDUCED_MOVE_ARG(a)=a& \
 200                          BOOST_ASIO_DECL= \
 201                          BOOST_ASIO_CONSTEXPR=constexpr \
 202                          BOOST_ASIO_NOEXCEPT=noexcept \
 203                          BOOST_ASIO_COMPLETION_SIGNATURE=typename \
 204                          BOOST_ASIO_COMPLETION_HANDLER_FOR(s)=typename \
 205                          BOOST_ASIO_COMPLETION_TOKEN_FOR(s)=typename \
 206                          BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=void_or_deduced \
 207                          BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(t,a)=void_or_deduced \
 208                          BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(e)==default_token \
 209                          BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(e)==default_token \
 210                          BOOST_ASIO_SVC_TPARAM= \
 211                          BOOST_ASIO_SVC_TPARAM_DEF1()= \
 212                          BOOST_ASIO_SVC_TPARAM_DEF2()= \
 213                          BOOST_ASIO_SVC_TARG= \
 214                          BOOST_ASIO_SVC_TPARAM1= \
 215                          BOOST_ASIO_SVC_TPARAM1_DEF1()= \
 216                          BOOST_ASIO_SVC_TPARAM1_DEF2()= \
 217                          BOOST_ASIO_SVC_TARG1= \
 218                          BOOST_ASIO_SVC_T=asio::detail::service \
 219                          BOOST_ASIO_SVC_T1=asio::detail::service \
 220                          BOOST_ASIO_CONST_BUFFER=const_buffer \
 221                          BOOST_ASIO_MUTABLE_BUFFER=mutable_buffer \
 222                          BOOST_ASIO_SYNC_OP_VOID=void \
 223                          BOOST_ASIO_STRING_VIEW_PARAM=string_view \
 224                          BOOST_ASIO_UNUSED_VARIABLE=
 225 EXPAND_AS_DEFINED      =
 226 SKIP_FUNCTION_MACROS   = YES
 227 #---------------------------------------------------------------------------
 228 # Configuration::additions related to external references
 229 #---------------------------------------------------------------------------
 230 TAGFILES               =
 231 GENERATE_TAGFILE       = reference.tags
 232 ALLEXTERNALS           = NO
 233 EXTERNAL_GROUPS        = YES
 234 PERL_PATH              = /usr/bin/perl
 235 #---------------------------------------------------------------------------
 236 # Configuration options related to the dot tool
 237 #---------------------------------------------------------------------------
 238 CLASS_DIAGRAMS         = NO
 239 HIDE_UNDOC_RELATIONS   = YES
 240 HAVE_DOT               = YES
 241 CLASS_GRAPH            = YES
 242 COLLABORATION_GRAPH    = NO
 243 GROUP_GRAPHS           = NO
 244 UML_LOOK               = NO
 245 TEMPLATE_RELATIONS     = YES
 246 INCLUDE_GRAPH          = NO
 247 INCLUDED_BY_GRAPH      = NO
 248 CALL_GRAPH             = NO
 249 GRAPHICAL_HIERARCHY    = NO
 250 DIRECTORY_GRAPH        = NO
 251 DOT_IMAGE_FORMAT       = png
 252 DOT_PATH               =
 253 DOTFILE_DIRS           =
 254 MAX_DOT_GRAPH_WIDTH    = 640
 255 MAX_DOT_GRAPH_HEIGHT   = 640
 256 MAX_DOT_GRAPH_DEPTH    = 0
 257 DOT_TRANSPARENT        = NO
 258 DOT_MULTI_TARGETS      = NO
 259 GENERATE_LEGEND        = NO
 260 DOT_CLEANUP            = YES
 261 #---------------------------------------------------------------------------
 262 # Configuration::additions related to the search engine
 263 #---------------------------------------------------------------------------
 264 SEARCHENGINE           = NO