[MERGED] libosmo-netif[master]: doc: Add Doxygen group for OSMUX related functions

[Harald Welte]

Harald Welte has submitted this change and it was merged.

Change subject: doc: Add Doxygen group for OSMUX related functions
......................................................................


doc: Add Doxygen group for OSMUX related functions

Change-Id: I87e08bd84236ae5d5c057bca96d122e568a6b52a
---
M include/osmocom/netif/osmux.h
M src/osmux.c
2 files changed, 21 insertions(+), 0 deletions(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/include/osmocom/netif/osmux.h b/include/osmocom/netif/osmux.h
index 83bb2e1..1d93aa0 100644
--- a/include/osmocom/netif/osmux.h
+++ b/include/osmocom/netif/osmux.h
@@ -3,6 +3,14 @@
 
 #include <osmocom/core/endian.h>
 
+/*! \addtogroup osmux
+ *  @{
+ */
+
+/*! \file osmux.h
+ *  Osmocom multiplex protocol helpers
+ */
+
 /* OSmux header:
  *
  *	ft (3 bits):		0=signalling, 1=voice, 2=dummy
@@ -95,4 +103,6 @@
 
 void osmux_tx_sched(struct llist_head *list, void (*tx_cb)(struct msgb *msg, void *data), void *data);
 
+/*! @} */
+
 #endif
diff --git a/src/osmux.c b/src/osmux.c
index 913d68f..5655269 100644
--- a/src/osmux.c
+++ b/src/osmux.c
@@ -23,6 +23,15 @@
 
 #include <arpa/inet.h>
 
+/*! \addtogroup osmux Osmocom Multiplex Protocol
+ *  @{
+ */
+
+/*! \file osmux.c
+ *  \brief Osmocom multiplex protocol helpers
+ */
+
+
 /* This allows you to debug timing reconstruction in the output path */
 #if 0
 #define DEBUG_TIMING		0
@@ -921,3 +930,5 @@
 
 	return offset;
 }
+
+/*! @} */

-- 
To view, visit https://gerrit.osmocom.org/2249
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I87e08bd84236ae5d5c057bca96d122e568a6b52a
Gerrit-PatchSet: 1
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder