summaryrefslogtreecommitdiffstats
path: root/src/bits.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 14:18:17 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 14:19:12 +0200
commitef7a44e33d52ab2e046efdd2535c9428796fc09e (patch)
tree1dd78086912cf2a37351c5e8fc64bbfec3cd055d /src/bits.c
parent53de0d31698e8c598e36ccad9d864c450da343b9 (diff)
[doc] bits.c: Better / more Doxygen documentation
Change-Id: If824a5c8d8ee6e3dc96a3fddeb105786c0c027c1
Diffstat (limited to 'src/bits.c')
-rw-r--r--src/bits.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/bits.c b/src/bits.c
index af09441a..fa917b07 100644
--- a/src/bits.c
+++ b/src/bits.c
@@ -28,6 +28,11 @@
* @{
* Osmocom bit level support code.
*
+ * This module implements the notion of different bit-fields, such as
+ * - unpacked bits (\ref ubit_t), i.e. 1 bit per byte
+ * - packed bits (\ref pbit_t), i.e. 8 bits per byte
+ * - soft bits (\ref sbit_t), 1 bit per byte from -127 to 127
+ *
* \file bits.c */
/*! convert unpacked bits to packed bits, return length in bytes