reference.dox 11 KB

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