laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/36300?usp=email )
(
2 is the latest approved patch-set. No files were changed between the latest approved patch-set and the submitted one. )Change subject: docs: Improve/clean-up doxygen for datagram.[ch] ......................................................................
docs: Improve/clean-up doxygen for datagram.[ch]
* make sure datagram.h is part of the group * don't expose private #defines from C files to API documentation
Change-Id: I64a9ee3306bcc01ba785da476aea581ce31150bd --- M include/osmocom/netif/datagram.h M src/datagram.c 2 files changed, 30 insertions(+), 10 deletions(-)
Approvals: fixeria: Looks good to me, approved Jenkins Builder: Verified pespin: Looks good to me, but someone else must approve
diff --git a/include/osmocom/netif/datagram.h b/include/osmocom/netif/datagram.h index a0ff7b4..a9bc588 100644 --- a/include/osmocom/netif/datagram.h +++ b/include/osmocom/netif/datagram.h @@ -1,6 +1,19 @@ #ifndef _OSMO_DGRAM_H_ #define _OSMO_DGRAM_H_
+/*! \defgroup datagram Osmocom Datagram Socket + * @{ + * + * This code is intended to abstract any use of datagram type sockets, + * such as UDP. It offers both transmitter and receiver side + * implementations, fully integrated with the libosmocore select loop + * abstraction. + */ + +/*! \file datagram.h + * \brief Osmocom datagram socket helpers + */ + struct osmo_dgram_tx;
struct osmo_dgram_tx *osmo_dgram_tx_create(void *ctx); diff --git a/src/datagram.c b/src/datagram.c index afae3e7..9df0630 100644 --- a/src/datagram.c +++ b/src/datagram.c @@ -41,13 +41,12 @@
#include <osmocom/netif/datagram.h>
-/*! \addtogroup datagram Osmocom Datagram Socket +#define OSMO_DGRAM_CLI_F_RECONF (1 << 0) + +#define OSMO_DGRAM_RX_F_RECONF (1 << 0) + +/*! \addtogroup datagram * @{ - * - * This code is intended to abstract any use of datagram type sockets, - * such as UDP. It offers both transmitter and receiver side - * implementations, fully integrated with the libosmocore select loop - * abstraction. */
/*! \file datagram.c @@ -59,8 +58,6 @@ * Client side. */
-#define OSMO_DGRAM_CLI_F_RECONF (1 << 0) - struct osmo_dgram_tx { struct osmo_fd ofd; struct llist_head tx_queue; @@ -243,8 +240,6 @@ * Server side. */
-#define OSMO_DGRAM_RX_F_RECONF (1 << 0) - struct osmo_dgram_rx { struct osmo_fd ofd; char *addr;
-
laforge