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 /include/osmocom/coding/gsm0503_parity.h | |
| 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 'include/osmocom/coding/gsm0503_parity.h')
| -rw-r--r-- | include/osmocom/coding/gsm0503_parity.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/osmocom/coding/gsm0503_parity.h b/include/osmocom/coding/gsm0503_parity.h index 540124a7..f844720b 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_crc16gen_code gsm0503_sch_crc10; 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; + +/*! @} */ |