Improve docs for Networking TS
authorJonathan Wakely <jwakely@redhat.com>
Thu, 2 May 2019 15:46:34 +0000 (16:46 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Thu, 2 May 2019 15:46:34 +0000 (16:46 +0100)
* 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
libstdc++-v3/include/experimental/bits/net.h
libstdc++-v3/include/experimental/buffer
libstdc++-v3/include/experimental/executor
libstdc++-v3/include/experimental/internet
libstdc++-v3/include/experimental/io_context
libstdc++-v3/include/experimental/net
libstdc++-v3/include/experimental/netfwd
libstdc++-v3/include/experimental/socket
libstdc++-v3/include/experimental/timer

index f5f6e74ce9223d7e4e80e48c10555e83e43880ce..fa36076116584b6e23afabb3673b722ef71b02e2 100644 (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.
index 60c85a79e66a4bec942c6b007af6de1e2a263e2b..d5ef277b933522106ae82ebece324e99cba7b575 100644 (file)
@@ -48,9 +48,8 @@ namespace net
 inline namespace v1
 {
 
-  /**
-   * @ingroup networking
-   * @{
+  /** @addtogroup networking-ts
+   *  @{
    */
 
   template<typename _CompletionToken, typename _Signature, typename>
index 23b7b65c631124025bd0559ff9e4dedf021704dd..a1d9e02f49c816df6c9a23abe2e0eb1713c17c2c 100644 (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
index 266a2487899aae66bee4dbb813e737bcdb98fb02..ef141e92cd3c1e43a97b88092cd36f09ae84dee5 100644 (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.
index 467bdfda3ed1f2c2eeca4ccca5c44201f191a641..44d757c3a9771aafc6fc9629a3742d4476300977 100644 (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
index 9ffba222bc0c0e31564a19b44eff964a89df8f51..fd6b0f946785ded80fd5beaa9100c09711b521f8 100644 (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;
index bf8de2cf11182111e5567d6d1e10485791209cb5..bc3ae1fd76e46e37c29fc98328126f9eb01800c9 100644 (file)
@@ -24,6 +24,7 @@
 
 /** @file experimental/net
  *  This is a TS C++ Library header.
+ *  @ingroup networking-ts
  */
 
 #ifndef _GLIBCXX_EXPERIMENTAL_NET
index 496756cd85fe75303c7ee99c650a7f0c1fd3f489..f8f4479b6c8fb70466f92254d1a5c0881da45b89 100644 (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;
index e80626528ce5b2f79a4eebdb92d2de763c4bef03..1a1ab8d0fd525bdfa131c667346209eb5efa90d2 100644 (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
index 146d80f726d6945baeb5bf4ce4ba36e3bf8ad231..18f8d484d299dbd84506ac4dc33473ab868040f2 100644 (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>