From 3084625d39d4d353f55c3aed6959bce6ec2a4a79 Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Thu, 2 May 2019 16:46:34 +0100 Subject: [PATCH] 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 --- libstdc++-v3/ChangeLog | 10 ++++++++++ libstdc++-v3/include/experimental/bits/net.h | 5 ++--- libstdc++-v3/include/experimental/buffer | 6 +++--- libstdc++-v3/include/experimental/executor | 6 +++--- libstdc++-v3/include/experimental/internet | 9 +++++---- libstdc++-v3/include/experimental/io_context | 8 ++++---- libstdc++-v3/include/experimental/net | 1 + libstdc++-v3/include/experimental/netfwd | 9 ++++++--- libstdc++-v3/include/experimental/socket | 6 +++--- libstdc++-v3/include/experimental/timer | 6 +++--- 10 files changed, 40 insertions(+), 26 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index f5f6e74ce92..fa360761165 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,15 @@ 2019-05-02 Jonathan Wakely + * 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. diff --git a/libstdc++-v3/include/experimental/bits/net.h b/libstdc++-v3/include/experimental/bits/net.h index 60c85a79e66..d5ef277b933 100644 --- a/libstdc++-v3/include/experimental/bits/net.h +++ b/libstdc++-v3/include/experimental/bits/net.h @@ -48,9 +48,8 @@ namespace net inline namespace v1 { - /** - * @ingroup networking - * @{ + /** @addtogroup networking-ts + * @{ */ template diff --git a/libstdc++-v3/include/experimental/buffer b/libstdc++-v3/include/experimental/buffer index 23b7b65c631..a1d9e02f49c 100644 --- a/libstdc++-v3/include/experimental/buffer +++ b/libstdc++-v3/include/experimental/buffer @@ -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 diff --git a/libstdc++-v3/include/experimental/executor b/libstdc++-v3/include/experimental/executor index 266a2487899..ef141e92cd3 100644 --- a/libstdc++-v3/include/experimental/executor +++ b/libstdc++-v3/include/experimental/executor @@ -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. diff --git a/libstdc++-v3/include/experimental/internet b/libstdc++-v3/include/experimental/internet index 467bdfda3ed..44d757c3a97 100644 --- a/libstdc++-v3/include/experimental/internet +++ b/libstdc++-v3/include/experimental/internet @@ -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_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 diff --git a/libstdc++-v3/include/experimental/io_context b/libstdc++-v3/include/experimental/io_context index 9ffba222bc0..fd6b0f94678 100644 --- a/libstdc++-v3/include/experimental/io_context +++ b/libstdc++-v3/include/experimental/io_context @@ -22,8 +22,9 @@ // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see // . -/** @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; diff --git a/libstdc++-v3/include/experimental/net b/libstdc++-v3/include/experimental/net index bf8de2cf111..bc3ae1fd76e 100644 --- a/libstdc++-v3/include/experimental/net +++ b/libstdc++-v3/include/experimental/net @@ -24,6 +24,7 @@ /** @file experimental/net * This is a TS C++ Library header. + * @ingroup networking-ts */ #ifndef _GLIBCXX_EXPERIMENTAL_NET diff --git a/libstdc++-v3/include/experimental/netfwd b/libstdc++-v3/include/experimental/netfwd index 496756cd85f..f8f4479b6c8 100644 --- a/libstdc++-v3/include/experimental/netfwd +++ b/libstdc++-v3/include/experimental/netfwd @@ -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; diff --git a/libstdc++-v3/include/experimental/socket b/libstdc++-v3/include/experimental/socket index e80626528ce..1a1ab8d0fd5 100644 --- a/libstdc++-v3/include/experimental/socket +++ b/libstdc++-v3/include/experimental/socket @@ -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 diff --git a/libstdc++-v3/include/experimental/timer b/libstdc++-v3/include/experimental/timer index 146d80f726d..18f8d484d29 100644 --- a/libstdc++-v3/include/experimental/timer +++ b/libstdc++-v3/include/experimental/timer @@ -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 -- 2.30.2