summaryrefslogtreecommitdiffstats
path: root/src/coding/gsm0503_tables.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-06-12 14:59:37 +0200
committerHarald Welte <laforge@gnumonks.org>2017-06-12 15:35:23 +0200
commitc663678b26aed636e13b56ab8a220791e268f244 (patch)
treedfadda0a6275a55672b16bde1e00fbce34c7f28e /src/coding/gsm0503_tables.c
parentb9946d372cb17c95ef629449961004d6e6f12239 (diff)
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
Diffstat (limited to 'src/coding/gsm0503_tables.c')
-rw-r--r--src/coding/gsm0503_tables.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/coding/gsm0503_tables.c b/src/coding/gsm0503_tables.c
index 90ca88d8..1c85765d 100644
--- a/src/coding/gsm0503_tables.c
+++ b/src/coding/gsm0503_tables.c
@@ -24,6 +24,18 @@
#include <osmocom/core/bits.h>
#include <osmocom/coding/gsm0503_tables.h>
+/*! \addtogroup tables
+ * @{
+ *
+ * \brief GSM TS 05.03 tables
+ *
+ * This module contains various tables defining parts of 3GPP TS 05.03
+ * / 45.003, primarily for the purpose of (de)puncturing, interleaving,
+ * etc.
+ */
+
+/*! \file gsm0503_tables.c */
+
const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8] = {
{ 1,1, 1,1, 1,1, 1,1 },
{ 1,1, 0,0, 1,0, 0,0 },
@@ -1730,3 +1742,5 @@ const ubit_t gsm0503_mcs5_usf_precode_table[8][36] = {
{ 0,0,1,0,0,1,1,0,1, 1,0,1,1,1,1,1,1,1, 0,1,1,0,1,0,0,0,1, 0,0,1,1,1,0,1,0,0, },
{ 0,1,1,0,1,0,1,1,1, 0,1,0,1,0,1,1,1,1, 0,0,0,1,1,1,1,1,0, 0,1,0,0,1,0,0,1,1, },
};
+
+/*! @} */