diff options
| author | Harald Welte <laforge@gnumonks.org> | 2016-04-25 12:11:20 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2016-05-05 18:49:27 +0200 |
| commit | 2d2e2cca0dc1d62addc9c9fcb3a59f343fc3baf6 (patch) | |
| tree | 8ec3ba89d486e4c324d32d1980ce68d5118d2db1 /src/bitcomp.c | |
| parent | 0996c879255e4653740814112bf98d0ddc93100c (diff) | |
Update doxygen annotations in libosmocore
This adds and improves doxygen API descriptions all over libosmocore,
reducing the 'white spots' that don't have any documentation.
Diffstat (limited to 'src/bitcomp.c')
| -rw-r--r-- | src/bitcomp.c | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/src/bitcomp.c b/src/bitcomp.c index bf359274..8b3090e6 100644 --- a/src/bitcomp.c +++ b/src/bitcomp.c @@ -232,9 +232,9 @@ static const unsigned t4_make_up[2][15] = { /*! \brief Attempt to decode compressed bit vector * - * Return length of RLE according to modified ITU-T T.4 from TS 44.060 Table 9.1.10.2 - * or -1 if no applicable RLE found - * N. B: we need explicit bit length to make decoding unambiguous + * \return length of RLE according to modified ITU-T T.4 from TS 44.060 + * Table 9.1.10.2 or -1 if no applicable RLE found N. B: we need + * explicit bit length to make decoding unambiguous */ static inline int t4_rle_term(unsigned w, bool b, unsigned bits) { @@ -256,8 +256,9 @@ static inline int t4_rle_makeup(unsigned w, bool b, unsigned bits) /*! \brief Make-up codes for a given length * - * Return proper make-up code word for an uninterrupted sequence of b bits - * of length len according to modified ITU-T T.4 from TS 44.060 Table 9.1.10.2 */ + * \return Return proper make-up code word for an uninterrupted + * sequence of b bits of length len according to modified ITU-T T.4 + * from TS 44.060 Table 9.1.10.2 */ static inline int t4_rle(struct bitvec *bv, unsigned len, bool b) { if (len >= 960) { @@ -384,7 +385,7 @@ static inline enum dec_state _t4_step(struct bitvec *v, uint16_t w, bool b, unsi * \param[in] in bit vector with encoded data * \param[in] cc color code (whether decoding should start with 1 or 0) * \param[out] out the bit vector to store result into - * returns 0 on success, negative value otherwise + * \return 0 on success, negative value otherwise */ int osmo_t4_decode(const struct bitvec *in, bool cc, struct bitvec *out) { @@ -437,7 +438,8 @@ int osmo_t4_decode(const struct bitvec *in, bool cc, struct bitvec *out) /*! \brief encode bit vector in-place using T4 encoding * Assumes MSB first encoding. * \param[in] bv bit vector to be encoded - * returns color code (if the encoding started with 0 or 1) or -1 on failure (encoded is bigger than original) + * \return color code (if the encoding started with 0 or 1) or -1 on + * failure (encoded is bigger than original) */ int osmo_t4_encode(struct bitvec *bv) { |