summaryrefslogtreecommitdiffstats
path: root/include/osmocom/coding
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 00:17:59 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:22 +0000
commit87e4550585c643e97e0003119b254251ac5ed1d4 (patch)
tree9287f66aba70e9253f4d62926c54dddeb492895e /include/osmocom/coding
parent249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff)
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'include/osmocom/coding')
-rw-r--r--include/osmocom/coding/gsm0503_coding.h2
-rw-r--r--include/osmocom/coding/gsm0503_interleaving.h2
-rw-r--r--include/osmocom/coding/gsm0503_mapping.h2
-rw-r--r--include/osmocom/coding/gsm0503_parity.h2
-rw-r--r--include/osmocom/coding/gsm0503_tables.h2
5 files changed, 5 insertions, 5 deletions
diff --git a/include/osmocom/coding/gsm0503_coding.h b/include/osmocom/coding/gsm0503_coding.h
index 2f0e6315..a9c59e47 100644
--- a/include/osmocom/coding/gsm0503_coding.h
+++ b/include/osmocom/coding/gsm0503_coding.h
@@ -8,7 +8,7 @@
*/
/*! \file gsm0503_coding.h
- * \brief GSM TS 05.03 coding
+ * GSM TS 05.03 coding
*/
#define GSM0503_GPRS_BURSTS_NBITS (116 * 4)
diff --git a/include/osmocom/coding/gsm0503_interleaving.h b/include/osmocom/coding/gsm0503_interleaving.h
index a5d25ed5..1463fb38 100644
--- a/include/osmocom/coding/gsm0503_interleaving.h
+++ b/include/osmocom/coding/gsm0503_interleaving.h
@@ -7,7 +7,7 @@
*/
/*! \file gsm0503_interleaving.h
- * \brief GSM TS 05.03 interleaving
+ * GSM TS 05.03 interleaving
*/
void gsm0503_xcch_deinterleave(sbit_t *cB, const sbit_t *iB);
diff --git a/include/osmocom/coding/gsm0503_mapping.h b/include/osmocom/coding/gsm0503_mapping.h
index 6e139bf0..435c9131 100644
--- a/include/osmocom/coding/gsm0503_mapping.h
+++ b/include/osmocom/coding/gsm0503_mapping.h
@@ -7,7 +7,7 @@
*/
/*! \file gsm0503_mapping.c
- * \brief GSM TS 05.03 burst mapping
+ * GSM TS 05.03 burst mapping
*/
void gsm0503_xcch_burst_unmap(sbit_t *iB, const sbit_t *eB,
diff --git a/include/osmocom/coding/gsm0503_parity.h b/include/osmocom/coding/gsm0503_parity.h
index f844720b..2743bdb1 100644
--- a/include/osmocom/coding/gsm0503_parity.h
+++ b/include/osmocom/coding/gsm0503_parity.h
@@ -7,7 +7,7 @@
*/
/*! \file gsm0503_parity.h
- * \brief GSM TS 05.03 parity
+ * GSM TS 05.03 parity
*/
const struct osmo_crc64gen_code gsm0503_fire_crc40;
diff --git a/include/osmocom/coding/gsm0503_tables.h b/include/osmocom/coding/gsm0503_tables.h
index 4622cae7..f8c43c61 100644
--- a/include/osmocom/coding/gsm0503_tables.h
+++ b/include/osmocom/coding/gsm0503_tables.h
@@ -8,7 +8,7 @@
*/
/*! \file gsm0503_tables.h
- * \brief GSM TS 05.03 tables
+ * GSM TS 05.03 tables
*/
extern const ubit_t gsm0503_pdtch_hl_hn_ubit[4][8];