irop_flag_highlevel flag added to Confirm and Cast
[libfirm] / ir / adt / bitset.h
index 3635631..62f44f9 100644 (file)
@@ -52,7 +52,7 @@ typedef struct _bitset_t {
  *   alignment.
  *
  * @param area A pointer to memory reserved for the bitset.
- * @param units The number of units that are allocated for the bitset.
+ * @param size The size of the bitset in bits.
  * @return A pointer to the initialized bitset.
  */
 static INLINE bitset_t *_bitset_prepare(void *area, bitset_pos_t size)
@@ -85,9 +85,10 @@ static INLINE bitset_t *_bitset_mask_highest(bitset_t *bs)
 #define bitset_capacity(bs) ((bs)->units * BS_UNIT_SIZE_BITS)
 
 /**
- * Get the highest bit which can be stored in the bitset.
+ * Get the size of the bitset in bits.
+ * @note Note the difference between capacity and size.
  * @param bs The bitset.
- * @return The highest bit which can be set or cleared.
+ * @return The highest bit which can be set or cleared plus 1.
  */
 #define bistet_size(bs)  ((bs)->size)
 
@@ -244,6 +245,7 @@ static INLINE bitset_pos_t bitset_max(const bitset_t *bs)
  * @note Note that if pos is set, pos is returned.
  * @param bs The bitset.
  * @param pos The bit from which to search for the next set bit.
+ * @param set if 1, serach for set bits, else for unset bits
  * @return The next set bit from pos on, or -1, if no set bit was found
  * after pos.
  */