diff mbox series

Improve API docs Filesystem TS and Networking TS

Message ID 20190507232231.GB2599@redhat.com
State New
Headers show
Series Improve API docs Filesystem TS and Networking TS | expand

Commit Message

Jonathan Wakely May 7, 2019, 11:22 p.m. UTC 
More Doxygenation.

Tested powerpc64le-linux. Committed to trunk.
diff mbox series

Patch

commit 4fc9ce4407954cf6601e80685c30bb3b7318f025
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Tue May 7 23:58:33 2019 +0100

    Improve API docs for Filesystem TS and Networking TS
    
            * include/experimental/bits/fs_path.h: Improve docs.
            * include/experimental/bits/net.h: Fix wrong header name in comment.
            Do not document implementation details.
            * include/experimental/netfwd: Fix doxygen grouping.

diff --git a/libstdc++-v3/include/experimental/bits/fs_path.h b/libstdc++-v3/include/experimental/bits/fs_path.h
index fafc9930a5b..f81f33ca161 100644
--- a/libstdc++-v3/include/experimental/bits/fs_path.h
+++ b/libstdc++-v3/include/experimental/bits/fs_path.h
@@ -514,8 +514,10 @@  _GLIBCXX_BEGIN_NAMESPACE_CXX11
 
   /// @relates std::experimental::filesystem::path @{
 
+  /// Swap overload for paths
   inline void swap(path& __lhs, path& __rhs) noexcept { __lhs.swap(__rhs); }
 
+  /// Compute a hash value for a path
   size_t hash_value(const path& __p) noexcept;
 
   /// Compare paths
diff --git a/libstdc++-v3/include/experimental/bits/net.h b/libstdc++-v3/include/experimental/bits/net.h
index d5ef277b933..1d637fb9b83 100644
--- a/libstdc++-v3/include/experimental/bits/net.h
+++ b/libstdc++-v3/include/experimental/bits/net.h
@@ -24,7 +24,7 @@ 
 
 /** @file experimental/bits/net.h
  *  This is an internal header file, included by other library headers.
- *  Do not attempt to use it directly. @headername{experimental/networking}
+ *  Do not attempt to use it directly. @headername{experimental/net}
  */
 
 #ifndef _GLIBCXX_EXPERIMENTAL_NET_H
@@ -55,6 +55,8 @@  inline namespace v1
   template<typename _CompletionToken, typename _Signature, typename>
     class async_result;
 
+  /// @cond undocumented
+
   // A type denoted by DEDUCED in the TS.
   template<typename _CompletionToken, typename _Signature>
     using __deduced_t = typename
@@ -67,25 +69,27 @@  inline namespace v1
       is_constructible<_Tp, _Tp&>, is_constructible<_Tp, const _Tp&&>
       >::type;
 
-    struct __throw_on_error
+  struct __throw_on_error
+  {
+    explicit
+    __throw_on_error(const char* __msg) : _M_msg(__msg) { }
+
+    ~__throw_on_error() noexcept(false)
     {
-      explicit
-      __throw_on_error(const char* __msg) : _M_msg(__msg) { }
+      if (_M_ec)
+	_GLIBCXX_THROW_OR_ABORT(system_error(_M_ec, _M_msg));
+    }
 
-      ~__throw_on_error() noexcept(false)
-      {
-	if (_M_ec)
-	  _GLIBCXX_THROW_OR_ABORT(system_error(_M_ec, _M_msg));
-      }
+    __throw_on_error(const __throw_on_error&) = delete;
+    __throw_on_error& operator=(const __throw_on_error&) = delete;
 
-      __throw_on_error(const __throw_on_error&) = delete;
-      __throw_on_error& operator=(const __throw_on_error&) = delete;
+    operator error_code&() noexcept { return _M_ec; }
 
-      operator error_code&() noexcept { return _M_ec; }
+    const char* _M_msg;
+    error_code _M_ec;
+  };
 
-      const char* _M_msg;
-      error_code _M_ec;
-    };
+  /// @endcond
 
   // Base class for types meeting IntegerSocketOption requirements.
   template<typename _Tp>
diff --git a/libstdc++-v3/include/experimental/netfwd b/libstdc++-v3/include/experimental/netfwd
index f8f4479b6c8..6a7ac4ae281 100644
--- a/libstdc++-v3/include/experimental/netfwd
+++ b/libstdc++-v3/include/experimental/netfwd
@@ -96,7 +96,7 @@  inline namespace v1
 namespace ip
 {
   /**
-   * @ingroup networking-ts
+   * @addtogroup networking-ts
    * @{
    */
     class address;