Commit 3084625d by Jonathan Wakely Committed by Jonathan Wakely

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
parent 1ababc8b
2019-05-02 Jonathan Wakely <jwakely@redhat.com> 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 * doc/doxygen/doxygroups.cc: Move description of experimental group
here. here.
* include/experimental/algorithm: Add to libfund-ts doc group. * include/experimental/algorithm: Add to libfund-ts doc group.
......
...@@ -48,9 +48,8 @@ namespace net ...@@ -48,9 +48,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
template<typename _CompletionToken, typename _Signature, typename> template<typename _CompletionToken, typename _Signature, typename>
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/buffer /** @file experimental/buffer
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_BUFFER #ifndef _GLIBCXX_EXPERIMENTAL_BUFFER
...@@ -51,9 +52,8 @@ namespace net ...@@ -51,9 +52,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
enum class stream_errc { // TODO decide values enum class stream_errc { // TODO decide values
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/executor /** @file experimental/executor
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_EXECUTOR #ifndef _GLIBCXX_EXPERIMENTAL_EXECUTOR
...@@ -57,9 +58,8 @@ namespace net ...@@ -57,9 +58,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
/// Customization point for asynchronous operations. /// Customization point for asynchronous operations.
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/internet /** @file experimental/internet
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_INTERNET #ifndef _GLIBCXX_EXPERIMENTAL_INTERNET
...@@ -69,9 +70,8 @@ inline namespace v1 ...@@ -69,9 +70,8 @@ inline namespace v1
namespace ip namespace ip
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
#ifdef _GLIBCXX_HAVE_NETDB_H #ifdef _GLIBCXX_HAVE_NETDB_H
...@@ -1111,13 +1111,14 @@ namespace ip ...@@ -1111,13 +1111,14 @@ namespace ip
typedef basic_address_range<address_v6> address_v6_range; typedef basic_address_range<address_v6> address_v6_range;
// @}
bool bool
operator==(const network_v4& __a, const network_v4& __b) noexcept; operator==(const network_v4& __a, const network_v4& __b) noexcept;
bool bool
operator==(const network_v6& __a, const network_v6& __b) noexcept; operator==(const network_v6& __a, const network_v6& __b) noexcept;
// @}
/// An IPv4 network address. /// An IPv4 network address.
class network_v4 class network_v4
......
...@@ -22,8 +22,9 @@ ...@@ -22,8 +22,9 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
/** @file experimental/io_service /** @file experimental/io_context
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_IO_SERVICE #ifndef _GLIBCXX_EXPERIMENTAL_IO_SERVICE
...@@ -61,9 +62,8 @@ namespace net ...@@ -61,9 +62,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
class __socket_impl; class __socket_impl;
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/net /** @file experimental/net
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_NET #ifndef _GLIBCXX_EXPERIMENTAL_NET
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/netfwd /** @file experimental/netfwd
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_NETFWD #ifndef _GLIBCXX_EXPERIMENTAL_NETFWD
...@@ -48,8 +49,10 @@ namespace net ...@@ -48,8 +49,10 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @defgroup networking-ts Networking TS
* @ingroup networking * @ingroup experimental
*
* ISO/IEC TS 19216:2018 C++ Extensions for Networking
* @{ * @{
*/ */
...@@ -93,7 +96,7 @@ inline namespace v1 ...@@ -93,7 +96,7 @@ inline namespace v1
namespace ip namespace ip
{ {
/** /**
* @ingroup networking * @ingroup networking-ts
* @{ * @{
*/ */
class address; class address;
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/socket /** @file experimental/socket
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_SOCKET #ifndef _GLIBCXX_EXPERIMENTAL_SOCKET
...@@ -69,9 +70,8 @@ namespace net ...@@ -69,9 +70,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
enum class socket_errc { // TODO decide values enum class socket_errc { // TODO decide values
......
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
/** @file experimental/timer /** @file experimental/timer
* This is a TS C++ Library header. * This is a TS C++ Library header.
* @ingroup networking-ts
*/ */
#ifndef _GLIBCXX_EXPERIMENTAL_TIMER #ifndef _GLIBCXX_EXPERIMENTAL_TIMER
...@@ -50,9 +51,8 @@ namespace net ...@@ -50,9 +51,8 @@ namespace net
inline namespace v1 inline namespace v1
{ {
/** /** @addtogroup networking-ts
* @ingroup networking * @{
* @{
*/ */
template<typename _Clock> template<typename _Clock>
......
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