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/include/osmocom/coding/gsm0503_coding.h b/include/osmocom/coding/gsm0503_coding.h
index f6591f5..55375bb 100644
--- a/include/osmocom/coding/gsm0503_coding.h
+++ b/include/osmocom/coding/gsm0503_coding.h
@@ -3,6 +3,14 @@
#include <stdint.h>
#include <osmocom/core/bits.h>
+/*! \addtogroup coding
+ * @{
+ */
+
+/*! \file gsm0503_coding.h
+ * \brief GSM TS 05.03 coding
+ */
+
#define GSM0503_GPRS_BURSTS_NBITS (116 * 4)
#define GSM0503_EGPRS_BURSTS_NBITS (348 * 4)
#define NUM_BYTES(N) ((N + 8 - 1) / 8)
@@ -61,3 +69,5 @@
int gsm0503_sch_encode(ubit_t *burst, const uint8_t *sb_info);
int gsm0503_sch_decode(uint8_t *sb_info, const sbit_t *burst);
+
+/*! @} */
diff --git a/include/osmocom/coding/gsm0503_interleaving.h b/include/osmocom/coding/gsm0503_interleaving.h
index f97dff4..85c7328 100644
--- a/include/osmocom/coding/gsm0503_interleaving.h
+++ b/include/osmocom/coding/gsm0503_interleaving.h
@@ -2,6 +2,14 @@
#include <osmocom/core/bits.h>
+/*! \addtogroup interleaving
+ * @{
+ */
+
+/*! \file gsm0503_interleaving.h
+ * \brief GSM TS 05.03 interleaving
+ */
+
void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB);
void gsm0503_xcch_interleave(ubit_t *cB, ubit_t *iB);
@@ -49,3 +57,5 @@
const sbit_t *hi, const sbit_t *di);
void gsm0503_mcs8_dl_interleave(const ubit_t *hc, const ubit_t *c1,
const ubit_t *c2, ubit_t *hi, ubit_t *di);
+
+/*! @} */
diff --git a/include/osmocom/coding/gsm0503_mapping.h b/include/osmocom/coding/gsm0503_mapping.h
index 93e4b67..6e139bf 100644
--- a/include/osmocom/coding/gsm0503_mapping.h
+++ b/include/osmocom/coding/gsm0503_mapping.h
@@ -2,6 +2,14 @@
#include <osmocom/core/bits.h>
+/*! \addtogroup mapping
+ * @{
+ */
+
+/*! \file gsm0503_mapping.c
+ * \brief GSM TS 05.03 burst mapping
+ */
+
void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB,
sbit_t *hl, sbit_t *hn);
void gsm0503_xcch_burst_map(const ubit_t *iB, ubit_t *eB, const ubit_t *hl,
@@ -31,3 +39,5 @@
sbit_t *hi, sbit_t *up, int B);
void gsm0503_mcs5_burst_swap(sbit_t *eB);
+
+/*! @} */
diff --git a/include/osmocom/coding/gsm0503_parity.h b/include/osmocom/coding/gsm0503_parity.h
index 540124a..f844720 100644
--- a/include/osmocom/coding/gsm0503_parity.h
+++ b/include/osmocom/coding/gsm0503_parity.h
@@ -2,6 +2,14 @@
#include <osmocom/core/crcgen.h>
+/*! \addtogroup parity
+ * @{
+ */
+
+/*! \file gsm0503_parity.h
+ * \brief GSM TS 05.03 parity
+ */
+
const struct osmo_crc64gen_code gsm0503_fire_crc40;
const struct osmo_crc16gen_code gsm0503_cs234_crc16;
const struct osmo_crc8gen_code gsm0503_mcs_crc8_hdr;
@@ -11,3 +19,5 @@
const struct osmo_crc8gen_code gsm0503_tch_fr_crc3;
const struct osmo_crc8gen_code gsm0503_tch_efr_crc8;
const struct osmo_crc8gen_code gsm0503_amr_crc6;
+
+/*! @} */
diff --git a/include/osmocom/coding/gsm0503_tables.h b/include/osmocom/coding/gsm0503_tables.h
index e6761ca..4622cae 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 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];
+
+/*! @} */