Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / beast / doc / source.dox
1 #---------------------------------------------------------------------------
2 # Configuration options related to the input files
3 #---------------------------------------------------------------------------
4 #INPUT = $(LIB_DIR)/include/boost/beast/_experimental/http/icy_stream.hpp
5
6 INPUT = \
7         $(LIB_DIR)/include/boost/beast/ \
8         $(LIB_DIR)/include/boost/beast/_experimental/http \
9         $(LIB_DIR)/include/boost/beast/_experimental/test \
10         $(LIB_DIR)/include/boost/beast/core \
11         $(LIB_DIR)/include/boost/beast/http \
12         $(LIB_DIR)/include/boost/beast/ssl \
13         $(LIB_DIR)/include/boost/beast/websocket \
14         $(LIB_DIR)/include/boost/beast/zlib
15
16 ALIASES               += esafe="@par Exception Safety"
17
18 INPUT_ENCODING         = UTF-8
19 FILE_PATTERNS          =
20 RECURSIVE              = NO
21 EXCLUDE                =
22 EXCLUDE_SYMLINKS       = NO
23 EXCLUDE_PATTERNS       =
24 EXCLUDE_SYMBOLS        =
25 EXAMPLE_PATH           =
26 EXAMPLE_PATTERNS       =
27 EXAMPLE_RECURSIVE      = NO
28 IMAGE_PATH             =
29 INPUT_FILTER           =
30 FILTER_PATTERNS        =
31 FILTER_SOURCE_FILES    = NO
32 FILTER_SOURCE_PATTERNS =
33 USE_MDFILE_AS_MAINPAGE =
34
35 #---------------------------------------------------------------------------
36 # Configuration options related to the preprocessor
37 #---------------------------------------------------------------------------
38 ENABLE_PREPROCESSING   = YES
39 MACRO_EXPANSION        = YES
40 EXPAND_ONLY_PREDEF     = YES
41 SEARCH_INCLUDES        = YES
42 INCLUDE_PATH           = ../
43 INCLUDE_FILE_PATTERNS  =
44
45 PREDEFINED             = \
46                         BOOST_BEAST_DOXYGEN \
47                         BOOST_BEAST_USE_POSIX_FILE=1 \
48                         BOOST_BEAST_USE_WIN32_FILE=1 \
49                         BOOST_BEAST_SPLIT_COMPILATION=1 \
50                         "BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__" \
51                         "BOOST_BEAST_ASYNC_RESULT2(t)=__deduced__" \
52                         "BOOST_BEAST_ASYNC_TPARAM1=class" \
53                         "BOOST_BEAST_ASYNC_TPARAM2=class" \
54                         "BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__" \
55                         "BOOST_ASIO_COMPLETION_TOKEN_FOR(sig)=class" \
56                         GENERATING_DOCUMENTATION \
57                         BOOST_BEAST_DECL
58
59 EXPAND_AS_DEFINED      =
60 SKIP_FUNCTION_MACROS   = YES
61
62 #---------------------------------------------------------------------------
63 # Project related configuration options
64 #---------------------------------------------------------------------------
65 DOXYFILE_ENCODING      = UTF-8
66 PROJECT_NAME           = "Beast"
67 PROJECT_NUMBER         =
68 PROJECT_BRIEF          = C++ Networking Library
69 PROJECT_LOGO           =
70 OUTPUT_DIRECTORY       =
71 CREATE_SUBDIRS         = NO
72 #####ALLOW_UNICODE_NAMES    = NO
73 OUTPUT_LANGUAGE        = English
74 BRIEF_MEMBER_DESC      = YES
75 REPEAT_BRIEF           = YES
76 ABBREVIATE_BRIEF       =
77 ALWAYS_DETAILED_SEC    = NO
78 INLINE_INHERITED_MEMB  = YES
79 FULL_PATH_NAMES        = YES
80 #STRIP_FROM_PATH        = $(LIB_DIR)/include # Requires doxygen 1.8.7+
81 STRIP_FROM_INC_PATH    =
82 SHORT_NAMES            = NO
83 JAVADOC_AUTOBRIEF      = YES
84 QT_AUTOBRIEF           = NO
85 MULTILINE_CPP_IS_BRIEF = NO
86 INHERIT_DOCS           = YES
87 SEPARATE_MEMBER_PAGES  = NO
88 TAB_SIZE               = 4
89 TCL_SUBST              =
90 OPTIMIZE_OUTPUT_FOR_C  = NO
91 OPTIMIZE_OUTPUT_JAVA   = NO
92 OPTIMIZE_FOR_FORTRAN   = NO
93 OPTIMIZE_OUTPUT_VHDL   = NO
94 EXTENSION_MAPPING      =
95 MARKDOWN_SUPPORT       = YES
96 AUTOLINK_SUPPORT       = YES
97 BUILTIN_STL_SUPPORT    = NO
98 CPP_CLI_SUPPORT        = NO
99 SIP_SUPPORT            = NO
100 IDL_PROPERTY_SUPPORT   = YES
101 DISTRIBUTE_GROUP_DOC   = YES
102 #####GROUP_NESTED_COMPOUNDS = NO
103 SUBGROUPING            = YES
104 INLINE_GROUPED_CLASSES = NO
105 INLINE_SIMPLE_STRUCTS  = NO
106 TYPEDEF_HIDES_STRUCT   = NO
107 LOOKUP_CACHE_SIZE      = 0
108
109 #---------------------------------------------------------------------------
110 # Build related configuration options
111 #---------------------------------------------------------------------------
112 EXTRACT_ALL            = YES
113 EXTRACT_PRIVATE        = YES
114 EXTRACT_PACKAGE        = NO
115 EXTRACT_STATIC         = NO
116 EXTRACT_LOCAL_CLASSES  = NO
117 EXTRACT_LOCAL_METHODS  = NO
118 EXTRACT_ANON_NSPACES   = NO
119 HIDE_UNDOC_MEMBERS     = NO
120 HIDE_UNDOC_CLASSES     = NO
121 HIDE_FRIEND_COMPOUNDS  = NO
122 HIDE_IN_BODY_DOCS      = NO
123 INTERNAL_DOCS          = NO
124 CASE_SENSE_NAMES       = YES
125 HIDE_SCOPE_NAMES       = NO
126 #####HIDE_COMPOUND_REFERENCE= NO
127 SHOW_INCLUDE_FILES     = NO
128 SHOW_GROUPED_MEMB_INC  = NO
129 FORCE_LOCAL_INCLUDES   = NO
130 INLINE_INFO            = NO
131 SORT_MEMBER_DOCS       = NO
132 SORT_BRIEF_DOCS        = NO
133 SORT_MEMBERS_CTORS_1ST = YES
134 SORT_GROUP_NAMES       = NO
135 SORT_BY_SCOPE_NAME     = NO
136 STRICT_PROTO_MATCHING  = NO
137 GENERATE_TODOLIST      = NO
138 GENERATE_TESTLIST      = NO
139 GENERATE_BUGLIST       = NO
140 GENERATE_DEPRECATEDLIST= NO
141 ENABLED_SECTIONS       =
142 MAX_INITIALIZER_LINES  = 30
143 SHOW_USED_FILES        = NO
144 SHOW_FILES             = NO
145 SHOW_NAMESPACES        = NO
146 FILE_VERSION_FILTER    =
147 LAYOUT_FILE            =
148 CITE_BIB_FILES         =
149
150 #---------------------------------------------------------------------------
151 # Configuration options related to warning and progress messages
152 #---------------------------------------------------------------------------
153 QUIET                  = NO
154 WARNINGS               = YES
155 WARN_IF_UNDOCUMENTED   = YES
156 WARN_IF_DOC_ERROR      = YES
157 WARN_NO_PARAMDOC       = NO
158 #####WARN_AS_ERROR          = NO
159 WARN_FORMAT            = "$file:$line: $text"
160 WARN_LOGFILE           =
161
162 #---------------------------------------------------------------------------
163 # Configuration options related to source browsing
164 #---------------------------------------------------------------------------
165 SOURCE_BROWSER         = NO
166 INLINE_SOURCES         = NO
167 STRIP_CODE_COMMENTS    = YES
168 REFERENCED_BY_RELATION = NO
169 REFERENCES_RELATION    = NO
170 REFERENCES_LINK_SOURCE = YES
171 SOURCE_TOOLTIPS        = YES
172 USE_HTAGS              = NO
173 VERBATIM_HEADERS       = YES
174 CLANG_ASSISTED_PARSING = NO
175 CLANG_OPTIONS          =
176
177 #---------------------------------------------------------------------------
178 # Configuration options related to the alphabetical class index
179 #---------------------------------------------------------------------------
180 ALPHABETICAL_INDEX     = YES
181 COLS_IN_ALPHA_INDEX    = 5
182 IGNORE_PREFIX          =
183
184 #---------------------------------------------------------------------------
185 # Configuration options related to the HTML output
186 #---------------------------------------------------------------------------
187 GENERATE_HTML          = NO
188 HTML_OUTPUT            = dhtm
189 HTML_FILE_EXTENSION    = .html
190 HTML_HEADER            =
191 HTML_FOOTER            =
192 HTML_STYLESHEET        =
193 HTML_EXTRA_STYLESHEET  =
194 HTML_EXTRA_FILES       =
195 HTML_COLORSTYLE_HUE    = 220
196 HTML_COLORSTYLE_SAT    = 100
197 HTML_COLORSTYLE_GAMMA  = 80
198 HTML_TIMESTAMP         = NO
199 HTML_DYNAMIC_SECTIONS  = NO
200 HTML_INDEX_NUM_ENTRIES = 100
201 GENERATE_DOCSET        = NO
202 DOCSET_FEEDNAME        = "Doxygen generated docs"
203 DOCSET_BUNDLE_ID       = org.doxygen.Project
204 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
205 DOCSET_PUBLISHER_NAME  = Publisher
206 GENERATE_HTMLHELP      = NO
207 CHM_FILE               =
208 HHC_LOCATION           =
209 GENERATE_CHI           = NO
210 CHM_INDEX_ENCODING     =
211 BINARY_TOC             = NO
212 TOC_EXPAND             = NO
213 GENERATE_QHP           = NO
214 QCH_FILE               =
215 QHP_NAMESPACE          = org.doxygen.Project
216 QHP_VIRTUAL_FOLDER     = doc
217 QHP_CUST_FILTER_NAME   =
218 QHP_CUST_FILTER_ATTRS  =
219 QHP_SECT_FILTER_ATTRS  =
220 QHG_LOCATION           =
221 GENERATE_ECLIPSEHELP   = NO
222 ECLIPSE_DOC_ID         = org.doxygen.Project
223 DISABLE_INDEX          = NO
224 GENERATE_TREEVIEW      = NO
225 ENUM_VALUES_PER_LINE   = 4
226 TREEVIEW_WIDTH         = 250
227 EXT_LINKS_IN_WINDOW    = NO
228 FORMULA_FONTSIZE       = 10
229 FORMULA_TRANSPARENT    = YES
230 USE_MATHJAX            = NO
231 MATHJAX_FORMAT         = HTML-CSS
232 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
233 MATHJAX_EXTENSIONS     =
234 MATHJAX_CODEFILE       =
235 SEARCHENGINE           = YES
236 SERVER_BASED_SEARCH    = NO
237 EXTERNAL_SEARCH        = NO
238 SEARCHENGINE_URL       =
239 SEARCHDATA_FILE        = searchdata.xml
240 EXTERNAL_SEARCH_ID     =
241 EXTRA_SEARCH_MAPPINGS  =
242
243 GENERATE_LATEX         = NO
244 GENERATE_RTF           = NO
245 GENERATE_MAN           = NO
246 GENERATE_DOCBOOK       = NO
247 GENERATE_AUTOGEN_DEF   = NO
248 GENERATE_PERLMOD       = NO
249 CLASS_DIAGRAMS         = NO
250 HAVE_DOT               = NO
251
252 #---------------------------------------------------------------------------
253 # Configuration options related to the XML output
254 #---------------------------------------------------------------------------
255 GENERATE_XML           = YES
256 XML_OUTPUT             = $(XML_OUTPUT)
257 XML_PROGRAMLISTING     = YES
258
259 #---------------------------------------------------------------------------
260 # Configuration options related to external references
261 #---------------------------------------------------------------------------
262 TAGFILES               =
263 GENERATE_TAGFILE       =
264 ALLEXTERNALS           = NO
265 EXTERNAL_GROUPS        = YES
266 EXTERNAL_PAGES         = YES
267 PERL_PATH              = /usr/bin/perl