diff options
| author | Harald Welte <laforge@gnumonks.org> | 2017-04-08 20:00:47 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2017-04-08 20:13:14 +0200 |
| commit | edad98b4a004a3a7e9d1ff99dfe86dbf042dfef3 (patch) | |
| tree | 944899329ea76423eba7aad4b671a2a9ca106328 | |
| parent | d0f9bd600c10615d9dbb6701001d491122a29aef (diff) | |
doc: Add Doxygen group for OSMUX related functions
Change-Id: I87e08bd84236ae5d5c057bca96d122e568a6b52a
| -rw-r--r-- | include/osmocom/netif/osmux.h | 10 | ||||
| -rw-r--r-- | src/osmux.c | 11 |
2 files changed, 21 insertions, 0 deletions
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 @@ struct osmux_hdr *osmux_xfrm_output_pull(struct msgb *msg); 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 @@ int osmux_snprintf(char *buf, size_t size, struct msgb *msg) return offset; } + +/*! @} */ |