docs: Use \defgroup and avoid repeated boilerplate text
Change-Id: I1196c3b035f495c5dbaa4d47ce3f79a08d0727f2
This commit is contained in:
parent
67cc594ff8
commit
472354b693
|
@ -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 */
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue