From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Fri, 22 Oct 2010 14:27:24 +0000 (+0000)
Subject: doc: Add missing return values.
X-Git-Tag: 2.6.0~5^2~70
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=3bafef8c0de45030118cf2efb30595483d931ac8;p=bertos.git

doc: Add missing return values.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4450 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/struct/bitarray.h b/bertos/struct/bitarray.h
index 0dc54c91..83a0ef16 100644
--- 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)
 {