Commit 041aa6ab by Jonathan Wakely Committed by Jonathan Wakely

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.

From-SVN: r270990
parent 0e7bd559
2019-05-08 Jonathan Wakely <jwakely@redhat.com>
* 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.
2019-05-07 Jonathan Wakely <jwakely@redhat.com> 2019-05-07 Jonathan Wakely <jwakely@redhat.com>
* include/bits/stl_pair.h: Improve docs. * include/bits/stl_pair.h: Improve docs.
......
...@@ -514,8 +514,10 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11 ...@@ -514,8 +514,10 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
/// @relates std::experimental::filesystem::path @{ /// @relates std::experimental::filesystem::path @{
/// Swap overload for paths
inline void swap(path& __lhs, path& __rhs) noexcept { __lhs.swap(__rhs); } 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; size_t hash_value(const path& __p) noexcept;
/// Compare paths /// Compare paths
......
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
/** @file experimental/bits/net.h /** @file experimental/bits/net.h
* This is an internal header file, included by other library headers. * 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 #ifndef _GLIBCXX_EXPERIMENTAL_NET_H
...@@ -55,6 +55,8 @@ inline namespace v1 ...@@ -55,6 +55,8 @@ inline namespace v1
template<typename _CompletionToken, typename _Signature, typename> template<typename _CompletionToken, typename _Signature, typename>
class async_result; class async_result;
/// @cond undocumented
// A type denoted by DEDUCED in the TS. // A type denoted by DEDUCED in the TS.
template<typename _CompletionToken, typename _Signature> template<typename _CompletionToken, typename _Signature>
using __deduced_t = typename using __deduced_t = typename
...@@ -67,25 +69,27 @@ inline namespace v1 ...@@ -67,25 +69,27 @@ inline namespace v1
is_constructible<_Tp, _Tp&>, is_constructible<_Tp, const _Tp&&> is_constructible<_Tp, _Tp&>, is_constructible<_Tp, const _Tp&&>
>::type; >::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 if (_M_ec)
__throw_on_error(const char* __msg) : _M_msg(__msg) { } _GLIBCXX_THROW_OR_ABORT(system_error(_M_ec, _M_msg));
}
~__throw_on_error() noexcept(false) __throw_on_error(const __throw_on_error&) = delete;
{ __throw_on_error& operator=(const __throw_on_error&) = delete;
if (_M_ec)
_GLIBCXX_THROW_OR_ABORT(system_error(_M_ec, _M_msg));
}
__throw_on_error(const __throw_on_error&) = delete; operator error_code&() noexcept { return _M_ec; }
__throw_on_error& operator=(const __throw_on_error&) = delete;
operator error_code&() noexcept { return _M_ec; } const char* _M_msg;
error_code _M_ec;
};
const char* _M_msg; /// @endcond
error_code _M_ec;
};
// Base class for types meeting IntegerSocketOption requirements. // Base class for types meeting IntegerSocketOption requirements.
template<typename _Tp> template<typename _Tp>
......
...@@ -96,7 +96,7 @@ inline namespace v1 ...@@ -96,7 +96,7 @@ inline namespace v1
namespace ip namespace ip
{ {
/** /**
* @ingroup networking-ts * @addtogroup networking-ts
* @{ * @{
*/ */
class address; class address;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment