From 4105c654633e8231cf098b4eb0e43a70226f313b Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Mon, 10 Oct 2016 18:38:13 -0400 Subject: [PATCH] Update docs for docca --- doc/Jamfile.v2 | 12 +- doc/{master.qbk => main.qbk} | 0 doc/makeqbk.sh | 7 +- doc/overview.qbk | 2 +- doc/quickref.xml | 160 +-- doc/reference.xsl | 1777 +--------------------------------- doc/source.dox | 4 +- doc/websocket.qbk | 14 +- 8 files changed, 107 insertions(+), 1869 deletions(-) rename doc/{master.qbk => main.qbk} (100%) diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index 8e78d6cd89..7511cbde3e 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -17,13 +17,13 @@ using doxygen ; import quickbook ; -path-constant here : . ; +path-constant out : . ; install stylesheets : $(broot)/doc/src/boostbook.css : - $(here)/html + $(out)/html ; explicit stylesheets ; @@ -35,7 +35,7 @@ install images images/body.png images/message.png : - $(here)/html/images + $(out)/html/images ; explicit images ; @@ -44,7 +44,7 @@ install callouts : [ glob $(broot)/doc/src/images/callouts/*.png ] : - $(here)/html/images/callouts + $(out)/html/images/callouts ; explicit callout ; @@ -58,14 +58,14 @@ install examples ../examples/ssl/*.hpp ] : - $(here)/html/examples + $(out)/html/examples ; explicit examples ; xml doc : - master.qbk + main.qbk : temp $(broot)/tools/boostbook/dtd diff --git a/doc/master.qbk b/doc/main.qbk similarity index 100% rename from doc/master.qbk rename to doc/main.qbk diff --git a/doc/makeqbk.sh b/doc/makeqbk.sh index ee5a7655a3..c55c0c355e 100755 --- a/doc/makeqbk.sh +++ b/doc/makeqbk.sh @@ -5,9 +5,8 @@ # Distributed under the Boost Software License, Version 1.0. (See accompanying # file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -mkdir -p ../bin/doc/xml +mkdir -p temp doxygen source.dox -cd ../bin/doc/xml +cd temp xsltproc combine.xslt index.xml > all.xml -cd ../../../doc -xsltproc reference.xsl ../bin/doc/xml/all.xml > reference.qbk +xsltproc ../reference.xsl all.xml > ../reference.qbk diff --git a/doc/overview.qbk b/doc/overview.qbk index 351f0ccd91..94cbdf3bd9 100644 --- a/doc/overview.qbk +++ b/doc/overview.qbk @@ -94,7 +94,7 @@ to Boost.Asio. The implementation also uses handler allocation hooks operations. There is no need for inheritance or virtual members in a -[link beast.ref.websocket__stream `websocket::stream`]. +[link beast.ref.beast__websocket__stream `websocket::stream`]. All operations are templated and transparent to the compiler, allowing for maximum inlining and optimization. diff --git a/doc/quickref.xml b/doc/quickref.xml index 2b070f6ba3..b527f050ba 100644 --- a/doc/quickref.xml +++ b/doc/quickref.xml @@ -29,46 +29,46 @@ Classes - basic_dynabuf_body - basic_headers - basic_parser_v1 - empty_body - headers - message - message_v1 - resume_context - streambuf_body - string_body + basic_dynabuf_body + basic_headers + basic_parser_v1 + empty_body + headers + message + message_v1 + resume_context + streambuf_body + string_body Options - body_max_size - headers_max_size - skip_body + body_max_size + headers_max_size + skip_body Type Traits - is_Body - is_Parser - is_ReadableBody - is_WritableBody + is_Body + is_Parser + is_ReadableBody + is_WritableBody Functions - async_parse - async_read - async_write - parse - prepare - read - swap - write + async_parse + async_read + async_write + parse + prepare + read + swap + write Constants - connection + connection Concepts @@ -83,35 +83,35 @@ Classes - close_reason - ping_data - stream - reason_string - teardown_tag + close_reason + ping_data + stream + reason_string + teardown_tag Options - auto_fragment_size - decorate - keep_alive - mask_buffer_size - message_type - pong_callback - read_buffer_size - read_message_max + auto_fragment_size + decorate + keep_alive + mask_buffer_size + message_type + pong_callback + read_buffer_size + read_message_max Functions - async_teardown - teardown + async_teardown + teardown Constants - close_code - error - opcode + close_code + error + opcode @@ -134,52 +134,52 @@ Classes - async_completion - basic_streambuf - buffers_adapter - consuming_buffers - dynabuf_readstream - errc - error_category - error_code - error_condition - handler_alloc - prepared_buffers - static_streambuf - static_streambuf_n - static_string - streambuf - system_error + async_completion + basic_streambuf + buffers_adapter + consuming_buffers + dynabuf_readstream + errc + error_category + error_code + error_condition + handler_alloc + prepared_buffers + static_streambuf + static_streambuf_n + static_string + streambuf + system_error Functions - bind_handler - buffer_cat - consumed_buffers - prepare_buffer - prepare_buffers - to_string + bind_handler + buffer_cat + consumed_buffers + prepare_buffer + prepare_buffers + to_string - write + write Type Traits - is_AsyncReadStream - is_AsyncWriteStream - is_AsyncStream - is_BufferSequence - is_CompletionHandler - is_ConstBufferSequence - is_DynamicBuffer - is_MutableBufferSequence - is_SyncReadStream - is_SyncStream - is_SyncWriteStream + is_AsyncReadStream + is_AsyncWriteStream + is_AsyncStream + is_BufferSequence + is_CompletionHandler + is_ConstBufferSequence + is_DynamicBuffer + is_MutableBufferSequence + is_SyncReadStream + is_SyncStream + is_SyncWriteStream @@ -208,8 +208,8 @@ - doc_debug - nested_doc_debug + doc_debug + nested_doc_debug diff --git a/doc/reference.xsl b/doc/reference.xsl index fa9703bc09..d94a79b7d3 100644 --- a/doc/reference.xsl +++ b/doc/reference.xsl @@ -1,1774 +1,13 @@ - - - - - - - - - - - - - - -[/ - Copyright (c) 2013-2016 Vinnie Falco (vinnie dot falco at gmail dot com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * - - - - & - - - - &... - - - - && - - - - &&... - - - - - - - - - - - - - - - - - - - - - - - - - - - ``['implementation-defined]`` - - - __void_or_deduced__ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [heading - - ] - - - - - [@ - - - - ] - - - - - - - - - - - - - `` - - - - - - `` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ` - - ` - - - - ` - - ` - - - - * - - - - - - - -[*] - -['] - - - - - [heading Parameters] - - - [heading Exceptions] - - - [variablelist - - ] - - - - [[ - - ][ - - ]] - - - - - - - - [heading Return Value] - - - - [heading See Also] - - - - [heading Remarks] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \_ - - - - - - - - - - - - - - - - - \[ - - - - - - - \] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [link beast.ref. - - ` - - `] - - - [role red |1| - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [link beast.ref. - - - - - - - - - ` - - `] - - - [link beast.ref. - - ` - - `] - - - [role red - - ] - - - - - [role red - - ] - - - - - - - - - [role red |3| - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [link beast.ref. - - - - - - - - - ` - - `] - - - [link beast.ref. - - ` - - `] - - - [role red - - ] - - - - - [role red - - ] - - - - - - - - - - [heading Requirements] - ['Header: ][^ - - ] - - - ['Convenience header: ][^beast/core.hpp] - - - ['Convenience header: ][^beast/http.hpp] - - - ['Convenience header: ][^beast/websocket.hpp] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - ] - - ``` - - - - - - : - - - - - - public - - - - - - , - - - - ``` - - - - - - - - - - - - - -[endsect] - - - - - - - [heading Types] - [table [[Name][Description]] - - - [ - - - [[link beast.ref. - - . - - [* - - ]]] [ - - - - ] - - - - - - - - - - - - - - - - - - - [[link beast.ref. - - [* - - ]]] [ - - ] - - - ] - - ] - - - [heading Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Protected Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Private Member Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Data Members] - [table [[Name][Description]] - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Protected Data Members] - [table [[Name][Description]] - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Private Data Members] - [table [[Name][Description]] - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - ] ] - - ] - - - [heading Friends] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link beast.ref. - . - [* - - ]]] [ - - - - - - - - ] ] - - - ] - - - [heading Related Functions] - [table [[Name][Description]] - - - - - - - - - - - - - - - - - - - - - - - - - [ - [[link beast.ref.. - [*]]] - [ - - - - - - - - - ] - ] - - - - ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - :: - - ] - [indexterm2 - - .. - - ] - - ``` - - - - - ``` - - ``` - - - - explicit - friend - static - virtual - - - - - - - - - - ``[link beast.ref. - - . - - .overload - - - - ]``( - - ) - - const - - ; - - ``` - - - - - [section: - - - - - overload - - - - - :: - - - ( - - of - - overloads) - - ] - - - - ['Inherited from - - - - .] - - - - [indexterm2 - - .. - - ] - - - - - - - - - - - - - - - - - - ``` - - ``` - - - ``` - - ``` - - - - - - - - - - - [endsect] [endsect] - - - [endsect] - - - - - - - - - ``` using - - = - - - - - - - - - ; ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ``` - - static - - - - - - - - - ; ``` - - - - - - - ``` - enum - - ``` - - - - [indexterm2 - - .. - - ] - - - [heading Values] - [variablelist - - [[ - - ] [ - - ]] - - ] - - - - - - - - - - - - - - - - - - - - - - - static - virtual - - - - - - ( - - ) - const - ; - - - - - - template< - - > - - - - - - - - - class ``[link beast.ref.streams.AsyncStream [*AsyncStream]]`` - - - class __AsyncReadStream__ - - - class __AsyncWriteStream__ - - - class ``[link beast.ref.Body [*Body]]`` - - - class ``[link beast.ref.BufferSequence [*BufferSequence]]`` - - - - ``[link beast.ref.BufferSequence [*BufferSequence]]`` - - - class __CompletionHandler__ - - - class __ConstBufferSequence__ - - - class ``[link beast.ref.DynamicBuffer [*DynamicBuffer]]`` - - - class __MutableBufferSequence__ - - - class ``[link beast.ref.Parser [*Parser]]`` - - - class ``[link beast.ref.streams.Stream [*Stream]]`` - - - class ``[link beast.ref.streams.SyncStream [*SyncStream]]`` - - - class __SyncReadStream__ - - - class __SyncWriteStream__ - - - - - - - - - - - - - - - - - - - - - - - = - - - - , - - - - - - - - - (& - - ) - - - - - - - - - - - - - - = - - - - , - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [section: - - - - ] - [indexterm1 - - ] - - - - - - - - - - - ``` - - - - - - - - - - - - ``[link beast.ref. - - .overload - - - - ]``( - - ); - - ``` - - - - - - - - - [section: - - - - [section: - overload - - - - - - ( - - of - - overloads) - - ] - - [indexterm1 - - ] - - - - - - - - - - - - - - - - - - ``` - - ``` - - - - - - - - - - - [endsect] [endsect] - - - [endsect] - - - + + + + + + + + diff --git a/doc/source.dox b/doc/source.dox index 240c61de69..3a35206bfe 100644 --- a/doc/source.dox +++ b/doc/source.dox @@ -16,7 +16,7 @@ ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = NO -STRIP_FROM_PATH = +STRIP_FROM_PATH = ../include/ STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES @@ -253,7 +253,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML = YES -XML_OUTPUT = ../bin/doc/xml +XML_OUTPUT = temp/ XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- diff --git a/doc/websocket.qbk b/doc/websocket.qbk index 057c919b86..189ef5449d 100644 --- a/doc/websocket.qbk +++ b/doc/websocket.qbk @@ -49,7 +49,7 @@ The WebSocket protocol is described fully in [section:creation Creation] The interface to Beast's WebSocket implementation is a single template -class [link beast.ref.websocket__stream `beast::websocket::stream`] which +class [link beast.ref.beast__websocket__stream `beast::websocket::stream`] which wraps a "next layer" object. The next layer object must meet the requirements of [link beast.ref.streams.SyncStream [*`SyncReadStream`]] if synchronous operations are performed, or @@ -156,7 +156,7 @@ for websocket, and the other side sends an appropriate HTTP response indicating that the request was accepted and that the connection has been upgraded. The HTTP Upgrade request must include the Host HTTP field, and the URI of the resource to request. -[link beast.ref.websocket__stream.handshake `handshake`] is used to send the +[link beast.ref.beast__websocket__stream.handshake `handshake`] is used to send the request with the required host and resource strings. ``` beast::websocket::stream ws{ios}; @@ -165,7 +165,7 @@ request with the required host and resource strings. ws.handshake("ws.example.com:80", "/cgi-bin/bitcoin-prices"); ``` -The [link beast.ref.websocket__stream `stream`] automatically +The [link beast.ref.beast__websocket__stream `stream`] automatically handles receiving and processing the HTTP response to the handshake request. The call to handshake is successful if a HTTP response is received with the 101 "Switching Protocols" status code. On failure, an error is returned or an @@ -236,7 +236,7 @@ void echo(beast::websocket::stream& ws) ``` [important - Calls to [link beast.ref.websocket__stream.set_option `set_option`] + Calls to [link beast.ref.beast__websocket__stream.set_option `set_option`] must be made from the same implicit or explicit strand as that used to perform other operations. ] @@ -314,7 +314,7 @@ gives callers control over the size of these frames: The WebSocket protocol defines a procedure and control message for initiating a close of the session. Handling of close initiated by the remote end of the connection is performed automatically. To manually initiate a close, use -[link beast.ref.websocket__stream.close `close`]: +[link beast.ref.beast__websocket__stream.close `close`]: ``` ws.close(); ``` @@ -329,7 +329,7 @@ error, a read operation is required. ] [section:pongs Pong messages] To receive pong control frames, callers may register a "pong callback" using -[link beast.ref.websocket__stream.set_option `set_option`]. The object provided +[link beast.ref.beast__websocket__stream.set_option `set_option`]. The object provided with this option should be callable with the following signature: ``` void on_pong(ping_data const& payload); @@ -417,7 +417,7 @@ use or require threads. [section:threads Thread Safety] -Like a regular asio socket, a [link beast.ref.websocket__stream `stream`] is +Like a regular asio socket, a [link beast.ref.beast__websocket__stream `stream`] is not thread safe. Callers are responsible for synchronizing operations on the socket using an implicit or explicit strand, as per the Asio documentation. The asynchronous interface supports one active read and one active write