summaryrefslogtreecommitdiffstats
path: root/include/osmocom/coding/gsm0503_tables.h
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 /include/osmocom/coding/gsm0503_tables.h
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 'include/osmocom/coding/gsm0503_tables.h')
-rw-r--r--include/osmocom/coding/gsm0503_tables.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/osmocom/coding/gsm0503_tables.h b/include/osmocom/coding/gsm0503_tables.h
index e6761ca4..4622cae7 100644
--- a/include/osmocom/coding/gsm0503_tables.h
+++ b/include/osmocom/coding/gsm0503_tables.h
@@ -3,6 +3,14 @@
#include <stdint.h>
#include <osmocom/core/bits.h>
+/*! \addtogroup tables
+ * @{
+ */
+
+/*! \file gsm0503_tables.h
+ * \brief GSM TS 05.03 tables
+ */
+
extern const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8];
extern const ubit_t gsm0503_pdtch_edge_hl_hn_ubit[3][8];
extern const sbit_t gsm0503_pdtch_hl_hn_sbit[4][8];
@@ -48,3 +56,5 @@ extern const ubit_t gsm0503_ahs_ic_ubit[4][4];
extern const sbit_t gsm0503_ahs_ic_sbit[4][4];
extern const uint8_t gsm0503_tch_hr_interleaving[228][2];
extern const ubit_t gsm0503_mcs5_usf_precode_table[8][36];
+
+/*! @} */