libs/asio/doc/tutorial.dox

   1 # Doxyfile 1.4.5
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "Boost.Asio Tutorial"
   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  = NO
  17 FULL_PATH_NAMES        = YES
  18 STRIP_FROM_PATH        = ./../../../
  19 STRIP_FROM_INC_PATH    =
  20 SHORT_NAMES            = YES
  21 JAVADOC_AUTOBRIEF      = NO
  22 MULTILINE_CPP_IS_BRIEF = YES
  23 DETAILS_AT_TOP         = YES
  24 INHERIT_DOCS           = YES
  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            = NO
  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                  = ./../example/cpp03/tutorial/index_dox.txt \
  76                          ./../example/cpp03/tutorial/timer_dox.txt \
  77                          ./../example/cpp03/tutorial/daytime_dox.txt
  78 FILE_PATTERNS          =
  79 RECURSIVE              = NO
  80 EXCLUDE                =
  81 EXCLUDE_SYMLINKS       = NO
  82 EXCLUDE_PATTERNS       =
  83 EXAMPLE_PATH           = ./../example
  84 EXAMPLE_PATTERNS       =
  85 EXAMPLE_RECURSIVE      = YES
  86 IMAGE_PATH             =
  87 INPUT_FILTER           =
  88 FILTER_PATTERNS        =
  89 FILTER_SOURCE_FILES    = NO
  90 #---------------------------------------------------------------------------
  91 # configuration options related to source browsing
  92 #---------------------------------------------------------------------------
  93 SOURCE_BROWSER         = NO
  94 INLINE_SOURCES         = NO
  95 STRIP_CODE_COMMENTS    = YES
  96 REFERENCED_BY_RELATION = NO
  97 REFERENCES_RELATION    = NO
  98 USE_HTAGS              = NO
  99 VERBATIM_HEADERS       = NO
 100 #---------------------------------------------------------------------------
 101 # configuration options related to the alphabetical class index
 102 #---------------------------------------------------------------------------
 103 ALPHABETICAL_INDEX     = YES
 104 COLS_IN_ALPHA_INDEX    = 1
 105 IGNORE_PREFIX          =
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the HTML output
 108 #---------------------------------------------------------------------------
 109 GENERATE_HTML          = NO
 110 HTML_OUTPUT            = .
 111 HTML_FILE_EXTENSION    = .html
 112 HTML_HEADER            =
 113 HTML_FOOTER            =
 114 HTML_STYLESHEET        =
 115 HTML_ALIGN_MEMBERS     = YES
 116 GENERATE_HTMLHELP      = NO
 117 CHM_FILE               =
 118 HHC_LOCATION           =
 119 GENERATE_CHI           = NO
 120 BINARY_TOC             = NO
 121 TOC_EXPAND             = NO
 122 DISABLE_INDEX          = YES
 123 ENUM_VALUES_PER_LINE   = 1
 124 GENERATE_TREEVIEW      = NO
 125 TREEVIEW_WIDTH         = 250
 126 #---------------------------------------------------------------------------
 127 # configuration options related to the LaTeX output
 128 #---------------------------------------------------------------------------
 129 GENERATE_LATEX         = NO
 130 LATEX_OUTPUT           = latex
 131 LATEX_CMD_NAME         = latex
 132 MAKEINDEX_CMD_NAME     = makeindex
 133 COMPACT_LATEX          = NO
 134 PAPER_TYPE             = a4wide
 135 EXTRA_PACKAGES         =
 136 LATEX_HEADER           =
 137 PDF_HYPERLINKS         = NO
 138 USE_PDFLATEX           = NO
 139 LATEX_BATCHMODE        = NO
 140 LATEX_HIDE_INDICES     = NO
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the RTF output
 143 #---------------------------------------------------------------------------
 144 GENERATE_RTF           = NO
 145 RTF_OUTPUT             = rtf
 146 COMPACT_RTF            = NO
 147 RTF_HYPERLINKS         = NO
 148 RTF_STYLESHEET_FILE    =
 149 RTF_EXTENSIONS_FILE    =
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the man page output
 152 #---------------------------------------------------------------------------
 153 GENERATE_MAN           = NO
 154 MAN_OUTPUT             = man
 155 MAN_EXTENSION          = .3
 156 MAN_LINKS              = NO
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the XML output
 159 #---------------------------------------------------------------------------
 160 GENERATE_XML           = YES
 161 XML_OUTPUT             = xml
 162 XML_SCHEMA             =
 163 XML_DTD                =
 164 XML_PROGRAMLISTING     = YES
 165 #---------------------------------------------------------------------------
 166 # configuration options for the AutoGen Definitions output
 167 #---------------------------------------------------------------------------
 168 GENERATE_AUTOGEN_DEF   = NO
 169 #---------------------------------------------------------------------------
 170 # configuration options related to the Perl module output
 171 #---------------------------------------------------------------------------
 172 GENERATE_PERLMOD       = NO
 173 PERLMOD_LATEX          = NO
 174 PERLMOD_PRETTY         = YES
 175 PERLMOD_MAKEVAR_PREFIX =
 176 #---------------------------------------------------------------------------
 177 # Configuration options related to the preprocessor
 178 #---------------------------------------------------------------------------
 179 ENABLE_PREPROCESSING   = YES
 180 MACRO_EXPANSION        = NO
 181 EXPAND_ONLY_PREDEF     = NO
 182 SEARCH_INCLUDES        = YES
 183 INCLUDE_PATH           =
 184 INCLUDE_FILE_PATTERNS  =
 185 PREDEFINED             = GENERATING_DOCUMENTATION
 186 EXPAND_AS_DEFINED      =
 187 SKIP_FUNCTION_MACROS   = YES
 188 #---------------------------------------------------------------------------
 189 # Configuration::additions related to external references
 190 #---------------------------------------------------------------------------
 191 TAGFILES               = reference.tags
 192 GENERATE_TAGFILE       =
 193 ALLEXTERNALS           = NO
 194 EXTERNAL_GROUPS        = YES
 195 PERL_PATH              = /usr/bin/perl
 196 #---------------------------------------------------------------------------
 197 # Configuration options related to the dot tool
 198 #---------------------------------------------------------------------------
 199 CLASS_DIAGRAMS         = YES
 200 HIDE_UNDOC_RELATIONS   = YES
 201 HAVE_DOT               = YES
 202 CLASS_GRAPH            = YES
 203 COLLABORATION_GRAPH    = YES
 204 GROUP_GRAPHS           = YES
 205 UML_LOOK               = YES
 206 TEMPLATE_RELATIONS     = YES
 207 INCLUDE_GRAPH          = NO
 208 INCLUDED_BY_GRAPH      = NO
 209 CALL_GRAPH             = NO
 210 GRAPHICAL_HIERARCHY    = NO
 211 DIRECTORY_GRAPH        = YES
 212 DOT_IMAGE_FORMAT       = png
 213 DOT_PATH               =
 214 DOTFILE_DIRS           =
 215 MAX_DOT_GRAPH_WIDTH    = 1024
 216 MAX_DOT_GRAPH_HEIGHT   = 1024
 217 MAX_DOT_GRAPH_DEPTH    = 0
 218 DOT_TRANSPARENT        = NO
 219 DOT_MULTI_TARGETS      = NO
 220 GENERATE_LEGEND        = NO
 221 DOT_CLEANUP            = YES
 222 #---------------------------------------------------------------------------
 223 # Configuration::additions related to the search engine
 224 #---------------------------------------------------------------------------
 225 SEARCHENGINE           = NO