doc: Add missing return values.

[bertos.git] / bertos / struct / bitarray.h

diff --git a/bertos/struct/bitarray.h b/bertos/struct/bitarray.h
index 0dc54c9160786cd9418e3239ff7d38bbb02ba302..83a0ef16acfe1c1eba06fc545b6edcf4b81645a3 100644 (file)
--- a/bertos/struct/bitarray.h
+++ b/bertos/struct/bitarray.h
@@ -144,6 +144,9 @@ INLINE bool bitarray_test(BitArray *bitx, int idx)
  * Check if the bitarray is full
  *
  * Only \a bitarray_len bits are tested.
+ *
+ * \param bitx BitArray to test
+ * \return True if \a bitx is full, false otherwise
  */
 INLINE bool bitarray_isFull(BitArray *bitx)
 {
@@ -170,6 +173,7 @@ INLINE bool bitarray_isFull(BitArray *bitx)
  * \param bitx BitArray context
  * \param idx Starting bit
  * \param offset Number of bits to test
+ * \return True if range is full, false otherwise
  */
 INLINE bool bitarray_isRangeFull(BitArray *bitx, int idx, int offset)
 {
@@ -191,6 +195,7 @@ INLINE bool bitarray_isRangeFull(BitArray *bitx, int idx, int offset)
  * \param bitx BitArray context
  * \param idx Starting bit
  * \param offset Number of bits to test
+ * \return True if range is empty, false otherwise
  */
 INLINE bool bitarray_isRangeEmpty(BitArray *bitx, int idx, int offset)
 {