From 93c849d6d45ca92a4aed6848065229e49ec026a3 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Wed, 25 Oct 2017 17:08:26 -0700 Subject: [PATCH] Update doc links --- CHANGELOG.md | 6 ++++ doc/qbk/00_main.qbk | 44 +++++++++++------------ doc/qbk/03_core/1_asio.qbk | 17 ++++----- doc/qbk/03_core/5_composed.qbk | 10 +++--- doc/qbk/04_http/09_custom_body.qbk | 2 +- doc/qbk/08_design/3_websocket_zaphoyd.qbk | 4 +-- 6 files changed, 42 insertions(+), 41 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d32d0bb..ff34c4c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +Version 128: + +* Update doc links + +-------------------------------------------------------------------------------- + Version 127: * Add BOOST_BEAST_NO_POSIX_FADVISE diff --git a/doc/qbk/00_main.qbk b/doc/qbk/00_main.qbk index 943585ec..cd1bbb1c 100644 --- a/doc/qbk/00_main.qbk +++ b/doc/qbk/00_main.qbk @@ -34,30 +34,30 @@ [def __rfc6455__ [@https://tools.ietf.org/html/rfc6455 rfc6455]] [def __rfc7230__ [@https://tools.ietf.org/html/rfc7230 rfc7230]] -[def __Asio__ [@http://www.boost.org/doc/html/boost_asio.html Boost.Asio]] +[def __Asio__ [@boost:/doc/html/boost_asio.html Boost.Asio]] +[def __async_initfn__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html initiating function]] -[def __asio_handler_invoke__ [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]] -[def __asio_handler_allocate__ [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]] -[def __io_context__ [@http://www.boost.org/doc/html/boost_asio/reference/io_context.html `io_context`]] -[def __socket__ [@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`]] -[def __ssl_stream__ [@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`]] -[def __streambuf__ [@http://www.boost.org/doc/html/boost_asio/reference/streambuf.html `boost::asio::streambuf`]] -[def __use_future__ [@http://www.boost.org/doc/html/boost_asio/reference/use_future_t.html `boost::asio::use_future`]] -[def __void_or_deduced__ [@http://www.boost.org/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]] -[def __yield_context__ [@http://www.boost.org/doc/html/boost_asio/reference/yield_context.html `boost::asio::yield_context`]] +[def __asio_handler_invoke__ [@boost:/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`]] +[def __asio_handler_allocate__ [@boost:/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`]] +[def __io_context__ [@boost:/doc/html/boost_asio/reference/io_context.html `boost::asio::io_context`]] +[def __executor_work_guard__ [@boost:/doc/html/boost_asio/reference/executor_work_guard.html `boost::asio::executor_work_guard`]] +[def __socket__ [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`]] +[def __ssl_stream__ [@boost:/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`]] +[def __streambuf__ [@boost:/doc/html/boost_asio/reference/streambuf.html `boost::asio::streambuf`]] +[def __use_future__ [@boost:/doc/html/boost_asio/reference/use_future_t.html `boost::asio::use_future`]] +[def __void_or_deduced__ [@boost:/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function ['void-or-deduced]]] +[def __yield_context__ [@boost:/doc/html/boost_asio/reference/yield_context.html `boost::asio::yield_context`]] -[def __AsyncReadStream__ [@http://www.boost.org/doc/html/boost_asio/reference/AsyncReadStream.html [*AsyncReadStream]]] -[def __AsyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]] -[def __CompletionHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]] -[def __ConstBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]] -[def __Handler__ [@http://www.boost.org/doc/html/boost_asio/reference/Handler.html [*Handler]]] -[def __MutableBufferSequence__ [@http://www.boost.org/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]] -[def __ReadHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/ReadHandler.html [*ReadHandler]]] -[def __SyncReadStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]] -[def __SyncWriteStream__ [@http://www.boost.org/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]] -[def __WriteHandler__ [@http://www.boost.org/doc/html/boost_asio/reference/WriteHandler.html [*WriteHandler]]] - -[def __async_initfn__ [@http://www.boost.org/doc/html/boost_asio/reference/asynchronous_operations.html initiating function]] +[def __AsyncReadStream__ [@boost:/doc/html/boost_asio/reference/AsyncReadStream.html [*AsyncReadStream]]] +[def __AsyncWriteStream__ [@boost:/doc/html/boost_asio/reference/AsyncWriteStream.html [*AsyncWriteStream]]] +[def __CompletionHandler__ [@boost:/doc/html/boost_asio/reference/CompletionHandler.html [*CompletionHandler]]] +[def __ConstBufferSequence__ [@boost:/doc/html/boost_asio/reference/ConstBufferSequence.html [*ConstBufferSequence]]] +[def __Handler__ [@boost:/doc/html/boost_asio/reference/Handler.html [*Handler]]] +[def __MutableBufferSequence__ [@boost:/doc/html/boost_asio/reference/MutableBufferSequence.html [*MutableBufferSequence]]] +[def __ReadHandler__ [@boost:/doc/html/boost_asio/reference/ReadHandler.html [*ReadHandler]]] +[def __SyncReadStream__ [@boost:/doc/html/boost_asio/reference/SyncReadStream.html [*SyncReadStream]]] +[def __SyncWriteStream__ [@boost:/doc/html/boost_asio/reference/SyncWriteStream.html [*SyncWriteStream]]] +[def __WriteHandler__ [@boost:/doc/html/boost_asio/reference/WriteHandler.html [*WriteHandler]]] [def __AsyncStream__ [link beast.concepts.streams.AsyncStream [*AsyncStream]]] [def __Body__ [link beast.concepts.Body [*Body]]] diff --git a/doc/qbk/03_core/1_asio.qbk b/doc/qbk/03_core/1_asio.qbk index 5a58ce4a..5a18e41b 100644 --- a/doc/qbk/03_core/1_asio.qbk +++ b/doc/qbk/03_core/1_asio.qbk @@ -30,26 +30,23 @@ special meaning: [table Global Variables [[Name][Description]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/io_context.html [*`ioc`]] + [@boost:/doc/html/boost_asio/reference/io_context.html [*`ioc`]] ][ - A variable of type - [@http://www.boost.org/doc/html/boost_asio/reference/io_context.html `boost::asio::io_context`] - which is running on one separate thread, and upon which an - [@http://www.boost.org/doc/html/boost_asio/reference/executor_work.html `boost::asio::executor_work`] - object has been constructed. + A variable of type __io_context__ which is running on one separate thread, + and upon which an __executor_work_guard__ object has been constructed. ]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html [*`sock`]] + [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html [*`sock`]] ][ A variable of type - [@http://www.boost.org/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`] + [@boost:/doc/html/boost_asio/reference/ip__tcp/socket.html `boost::asio::ip::tcp::socket`] which has already been connected to a remote host. ]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html [*`ssl_sock`]] + [@boost:/doc/html/boost_asio/reference/ssl__stream.html [*`ssl_sock`]] ][ A variable of type - [@http://www.boost.org/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`] + [@boost:/doc/html/boost_asio/reference/ssl__stream.html `boost::asio::ssl::stream`] which is already connected and has handshaked with a remote host. ]] [[ diff --git a/doc/qbk/03_core/5_composed.qbk b/doc/qbk/03_core/5_composed.qbk index 85965f7e..8780a67e 100644 --- a/doc/qbk/03_core/5_composed.qbk +++ b/doc/qbk/03_core/5_composed.qbk @@ -120,28 +120,28 @@ declaration and definition of the "handler hooks". There are four hooks: [table Handler Hooks [[Name][Description]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`] + [@boost:/doc/html/boost_asio/reference/asio_handler_invoke.html `asio_handler_invoke`] ][ Default invoke function for handlers. This hooking function ensures that the invoked method used for the final handler is accessible at each intermediate step. ]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`] + [@boost:/doc/html/boost_asio/reference/asio_handler_allocate.html `asio_handler_allocate`] ][ Default allocation function for handlers. Implement `asio_handler_allocate` and `asio_handler_deallocate` for your own handlers to provide custom allocation for temporary objects. ]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_deallocate.html `asio_handler_deallocate`] + [@boost:/doc/html/boost_asio/reference/asio_handler_deallocate.html `asio_handler_deallocate`] ][ Default deallocation function for handlers. Implement `asio_handler_allocate` and `asio_handler_deallocate` for your own handlers to provide custom allocation for temporary objects. ]] [[ - [@http://www.boost.org/doc/html/boost_asio/reference/asio_handler_is_continuation.html `asio_handler_is_continuation`] + [@boost:/doc/html/boost_asio/reference/asio_handler_is_continuation.html `asio_handler_is_continuation`] ][ Default continuation function for handlers. Implement `asio_handler_is_continuation` for your own handlers to indicate when @@ -185,7 +185,7 @@ composed operations: * For operations which complete immediately (i.e. without calling an intermediate initiating function), forgetting to use - [@http://www.boost.org/doc/html/boost_asio/reference/post.html `boost::asio::post`] + [@boost:/doc/html/boost_asio/reference/post.html `boost::asio::post`] to invoke the final handler. This breaks the following initiating function guarantee: ['Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from diff --git a/doc/qbk/04_http/09_custom_body.qbk b/doc/qbk/04_http/09_custom_body.qbk index 80a91a8e..8995fe40 100644 --- a/doc/qbk/04_http/09_custom_body.qbk +++ b/doc/qbk/04_http/09_custom_body.qbk @@ -73,7 +73,7 @@ something that is not a container for body octets, such as a [@http://www.boost.org/libs/filesystem/doc/reference.html#class-path `boost::filesystem::path`]. Or, a more structured container may be chosen. This declares a body's value type as a JSON tree structure produced from a -[@http://www.boost.org/doc/html/property_tree/parsers.html#property_tree.parsers.json_parser `json_parser`]: +[@boost:/doc/html/property_tree/parsers.html#property_tree.parsers.json_parser `json_parser`]: ``` #include #include diff --git a/doc/qbk/08_design/3_websocket_zaphoyd.qbk b/doc/qbk/08_design/3_websocket_zaphoyd.qbk index 945380cd..bfa1119a 100644 --- a/doc/qbk/08_design/3_websocket_zaphoyd.qbk +++ b/doc/qbk/08_design/3_websocket_zaphoyd.qbk @@ -281,9 +281,7 @@ notified when messages or frames have completed sending. Beast doesn't allocate or make copies of buffers when sending data. The caller's buffers are sent in-place. You can use any object meeting the -requirements of -[@http://www.boost.org/doc/html/boost_asio/reference/ConstBufferSequence.html ConstBufferSequence], -permitting efficient scatter-gather I/O. +requirements of __ConstBufferSequence, permitting efficient scatter-gather I/O. The [*ConstBufferSequence] interface allows callers to send data from memory-mapped regions (not possible in websocketpp). Callers can also