[S] Change in libosmo-netif[master]: docs: Use \defgroup and avoid repeated boilerplate text

laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/36291?usp=email ) Change subject: docs: Use \defgroup and avoid repeated boilerplate text ...................................................................... docs: Use \defgroup and avoid repeated boilerplate text Change-Id: I1196c3b035f495c5dbaa4d47ce3f79a08d0727f2 --- M include/osmocom/netif/stream.h M src/stream.c M src/stream_cli.c M src/stream_srv.c 4 files changed, 20 insertions(+), 17 deletions(-) Approvals: pespin: Looks good to me, but someone else must approve fixeria: Looks good to me, approved Jenkins Builder: Verified diff --git a/include/osmocom/netif/stream.h b/include/osmocom/netif/stream.h index fe4dd77..96633d6 100644 --- a/include/osmocom/netif/stream.h +++ b/include/osmocom/netif/stream.h @@ -6,8 +6,15 @@ #include <osmocom/core/msgb.h> -/*! \addtogroup stream +/*! \defgroup stream Osmocom Stream Server/Client * @{ + * + * This code is intended to abstract any use of stream-type sockets, + * such as TCP and SCTP. It offers both server and client side + * implementations, fully integrated with the libosmocore select loop + * abstraction. + * + * \file stream.h */ /*! \brief Access SCTP flags from the msgb control buffer */ diff --git a/src/stream.c b/src/stream.c index f4755e0..60a7623 100644 --- a/src/stream.c +++ b/src/stream.c @@ -52,13 +52,8 @@ #include <osmocom/netif/sctp.h> -/*! \addtogroup stream Osmocom Stream Socket +/*! \addtogroup stream * @{ - * - * This code is intended to abstract any use of stream-type sockets, - * such as TCP and SCTP. It offers both server and client side - * implementations, fully integrated with the libosmocore select loop - * abstraction. */ /*! \file stream.c diff --git a/src/stream_cli.c b/src/stream_cli.c index 46ddc89..9c3f65a 100644 --- a/src/stream_cli.c +++ b/src/stream_cli.c @@ -52,12 +52,8 @@ #include <osmocom/netif/sctp.h> -/*! \addtogroup stream Osmocom Stream Socket (client side) +/*! \addtogroup stream * @{ - * - * This code is intended to abstract any use of stream-type sockets, - * such as TCP and SCTP. It offers client side implementation, - * fully integrated with the libosmocore select loop abstraction. */ /*! \file stream_cli.c diff --git a/src/stream_srv.c b/src/stream_srv.c index da49bad..58ed7ef 100644 --- a/src/stream_srv.c +++ b/src/stream_srv.c @@ -53,12 +53,8 @@ #include <osmocom/netif/sctp.h> -/*! \addtogroup stream Osmocom Stream Socket (server side) +/*! \addtogroup stream * @{ - * - * This code is intended to abstract any use of stream-type sockets, - * such as TCP and SCTP. It offers server side implementation, - * fully integrated with the libosmocore select loop abstraction. */ /*! \file stream_srv.c -- To view, visit https://gerrit.osmocom.org/c/libosmo-netif/+/36291?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: libosmo-netif Gerrit-Branch: master Gerrit-Change-Id: I1196c3b035f495c5dbaa4d47ce3f79a08d0727f2 Gerrit-Change-Number: 36291 Gerrit-PatchSet: 3 Gerrit-Owner: laforge &lt;laforge(a)osmocom.org&gt; Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria &lt;vyanitskiy(a)sysmocom.de&gt; Gerrit-Reviewer: laforge &lt;laforge(a)osmocom.org&gt; Gerrit-Reviewer: pespin &lt;pespin(a)sysmocom.de&gt; Gerrit-MessageType: merged