summaryrefslogtreecommitdiffstats
path: root/src/bitcomp.c
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 /src/bitcomp.c
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 'src/bitcomp.c')
-rw-r--r--src/bitcomp.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/bitcomp.c b/src/bitcomp.c
index 9c01246b..acf165e0 100644
--- a/src/bitcomp.c
+++ b/src/bitcomp.c
@@ -25,7 +25,7 @@
*/
/*! \file bitcomp.c
- * \brief Osmocom bit compression routines
+ * Osmocom bit compression routines
*/
#include <stdint.h>
@@ -222,7 +222,7 @@ static const unsigned t4_make_up[2][15] = {
}
};
-/*! \brief Make-up codes for a given length
+/*! Make-up codes for a given length
*
* \return Return proper make-up code word for an uninterrupted
* sequence of b bits of length len according to modified ITU-T T.4
@@ -307,7 +307,7 @@ static inline int t4_rle(struct bitvec *bv, unsigned len, bool b)
return bitvec_set_uint(bv, t4_term[b][len], t4_term_length[b][len]);
}
-/*! \brief encode bit vector in-place using T4 encoding
+/*! encode bit vector in-place using T4 encoding
* Assumes MSB first encoding.
* \param[in] bv bit vector to be encoded
* \return color code (if the encoding started with 0 or 1) or -1 on