Add doxygen documentation to libosmocoding
This adds the minimum amount of API documentation that we should have on
all our code, particularly new code merged into a library.
Change-Id: I526804f64313867913574e50e5b9e9205ad3aa74
diff --git a/src/coding/gsm0503_mapping.c b/src/coding/gsm0503_mapping.c
index 4dd3076..82c049c 100644
--- a/src/coding/gsm0503_mapping.c
+++ b/src/coding/gsm0503_mapping.c
@@ -25,6 +25,17 @@
#include <osmocom/core/bits.h>
#include <osmocom/coding/gsm0503_mapping.h>
+/*! \addtogroup mapping
+ * @{
+ *
+ * \brief GSM TS 05.03 burst mapping
+ *
+ * This module contains burst mapping routines as specified in 3GPP TS
+ * 05.03 / 45.003.
+ */
+
+/*! \file gsm0503_mapping.c */
+
void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB,
sbit_t *hl, sbit_t *hn)
{
@@ -289,3 +300,5 @@
eB[191] = t[12];
eB[194] = t[13];
}
+
+/*! @} */