aboutsummaryrefslogtreecommitdiffstats
path: root/src/osmux.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-27 19:57:37 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-27 19:57:37 +0200
commit61b5b65debf407bb89da9df2b329d650f9526b29 (patch)
treeb61db5f6d12299429f8b011256b0cc63c2e03c26 /src/osmux.c
parentd8f2b38eb96592567398c69bafdb9b3ecb82432e (diff)
some more Doxygen header text for datagram, osmux and stream module
Diffstat (limited to 'src/osmux.c')
-rw-r--r--src/osmux.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/osmux.c b/src/osmux.c
index 7beb705..70e220d 100644
--- a/src/osmux.c
+++ b/src/osmux.c
@@ -25,6 +25,15 @@
/*! \addtogroup osmux Osmocom Multiplex Protocol
* @{
+ *
+ * This code implements a variety of utility functions related to the
+ * OSMUX user-plane multiplexing protocol, an efficient alternative to
+ * plain UDP/RTP streams for voice transport in back-haul of cellular
+ * networks.
+ *
+ * For information about the OSMUX protocol design, please see the
+ * OSMUX reference manual at
+ * http://ftp.osmocom.org/docs/latest/osmux-reference.pdf
*/
/*! \file osmux.c