diff options
| author | Harald Welte <laforge@gnumonks.org> | 2017-06-12 14:59:37 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2017-06-12 15:35:23 +0200 |
| commit | c663678b26aed636e13b56ab8a220791e268f244 (patch) | |
| tree | dfadda0a6275a55672b16bde1e00fbce34c7f28e /src/coding/gsm0503_mapping.c | |
| parent | b9946d372cb17c95ef629449961004d6e6f12239 (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_mapping.c')
| -rw-r--r-- | src/coding/gsm0503_mapping.c | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/coding/gsm0503_mapping.c b/src/coding/gsm0503_mapping.c index 4dd3076b..82c049ce 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 @@ void gsm0503_mcs5_burst_swap(sbit_t *eB) eB[191] = t[12]; eB[194] = t[13]; } + +/*! @} */ |