Improve docs for Networking TS

* include/experimental/bits/net.h: Fix/improve doxygen markup.
	* include/experimental/buffer: Likewise.
	* include/experimental/executor: Likewise.
	* include/experimental/internet: Likewise.
	* include/experimental/io_context: Likewise.
	* include/experimental/net: Likewise.
	* include/experimental/netfwd: Likewise.
	* include/experimental/socket: Likewise.
	* include/experimental/timer: Likewise.

From-SVN: r270810
This commit is contained in:
Jonathan Wakely 2019-05-02 16:46:34 +01:00 committed by Jonathan Wakely
parent 1ababc8bd5
commit 3084625d39
10 changed files with 40 additions and 26 deletions

View File

@ -1,5 +1,15 @@
2019-05-02 Jonathan Wakely <jwakely@redhat.com>
* include/experimental/bits/net.h: Fix/improve doxygen markup.
* include/experimental/buffer: Likewise.
* include/experimental/executor: Likewise.
* include/experimental/internet: Likewise.
* include/experimental/io_context: Likewise.
* include/experimental/net: Likewise.
* include/experimental/netfwd: Likewise.
* include/experimental/socket: Likewise.
* include/experimental/timer: Likewise.
* doc/doxygen/doxygroups.cc: Move description of experimental group
here.
* include/experimental/algorithm: Add to libfund-ts doc group.

View File

@ -48,9 +48,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
template<typename _CompletionToken, typename _Signature, typename>

View File

@ -24,6 +24,7 @@
/** @file experimental/buffer
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_BUFFER
@ -51,9 +52,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
enum class stream_errc { // TODO decide values

View File

@ -24,6 +24,7 @@
/** @file experimental/executor
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_EXECUTOR
@ -57,9 +58,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
/// Customization point for asynchronous operations.

View File

@ -24,6 +24,7 @@
/** @file experimental/internet
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_INTERNET
@ -69,9 +70,8 @@ inline namespace v1
namespace ip
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
#ifdef _GLIBCXX_HAVE_NETDB_H
@ -1111,13 +1111,14 @@ namespace ip
typedef basic_address_range<address_v6> address_v6_range;
// @}
bool
operator==(const network_v4& __a, const network_v4& __b) noexcept;
bool
operator==(const network_v6& __a, const network_v6& __b) noexcept;
// @}
/// An IPv4 network address.
class network_v4

View File

@ -22,8 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
/** @file experimental/io_service
/** @file experimental/io_context
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_IO_SERVICE
@ -61,9 +62,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
class __socket_impl;

View File

@ -24,6 +24,7 @@
/** @file experimental/net
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_NET

View File

@ -24,6 +24,7 @@
/** @file experimental/netfwd
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_NETFWD
@ -48,8 +49,10 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
/** @defgroup networking-ts Networking TS
* @ingroup experimental
*
* ISO/IEC TS 19216:2018 C++ Extensions for Networking
* @{
*/
@ -93,7 +96,7 @@ inline namespace v1
namespace ip
{
/**
* @ingroup networking
* @ingroup networking-ts
* @{
*/
class address;

View File

@ -24,6 +24,7 @@
/** @file experimental/socket
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_SOCKET
@ -69,9 +70,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
enum class socket_errc { // TODO decide values

View File

@ -24,6 +24,7 @@
/** @file experimental/timer
* This is a TS C++ Library header.
* @ingroup networking-ts
*/
#ifndef _GLIBCXX_EXPERIMENTAL_TIMER
@ -50,9 +51,8 @@ namespace net
inline namespace v1
{
/**
* @ingroup networking
* @{
/** @addtogroup networking-ts
* @{
*/
template<typename _Clock>