[PATCH] libosmo-netif[master]: some more Doxygen header text for datagram, osmux and stream...

[Harald Welte]

Review at  https://gerrit.osmocom.org/4454

some more Doxygen header text for datagram, osmux and stream module

Change-Id: Ied83e6b117a420d734a88e3aff925a874c3dd520
---
M src/datagram.c
M src/osmux.c
M src/stream.c
3 files changed, 19 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmo-netif refs/changes/54/4454/1

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

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ied83e6b117a420d734a88e3aff925a874c3dd520
Gerrit-PatchSet: 1
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>