aboutsummaryrefslogtreecommitdiffstats
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
parentd8f2b38eb96592567398c69bafdb9b3ecb82432e (diff)
some more Doxygen header text for datagram, osmux and stream module
-rw-r--r--src/datagram.c5
-rw-r--r--src/osmux.c9
-rw-r--r--src/stream.c5
3 files changed, 19 insertions, 0 deletions
diff --git a/src/datagram.c b/src/datagram.c
index ea31cd1..89643b8 100644
--- a/src/datagram.c
+++ b/src/datagram.c
@@ -23,6 +23,11 @@
/*! \addtogroup 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.c
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
diff --git a/src/stream.c b/src/stream.c
index a80d842..1abe657 100644
--- a/src/stream.c
+++ b/src/stream.c
@@ -30,6 +30,11 @@
/*! \addtogroup stream Osmocom Stream Socket
* @{
+ *
+ * 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