ucx: comparison src/cx/iterator.h

-:a5b0e47fc7de
+:2cb1ed4da55d
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 /**
-* \file iterator.h
+* @file iterator.h
-* \brief Interface for iterator implementations.
+* @brief Interface for iterator implementations.
-* \author Mike Becker
+* @author Mike Becker
-* \author Olaf Wintermann
+* @author Olaf Wintermann
-* \copyright 2-Clause BSD License
+* @copyright 2-Clause BSD License
 */
 #ifndef UCX_ITERATOR_H
 #define UCX_ITERATOR_H
 */
 size_t elem_size;
 /**
 * May contain the total number of elements, if known.
-* Shall be set to \c SIZE_MAX when the total number is unknown during iteration.
+* Shall be set to @c SIZE_MAX when the total number is unknown during iteration.
 */
 size_t elem_count;
 };
 /**
 * An iterator points to a certain element in a (possibly unbounded) chain of elements.
 * Iterators that are based on collections (which have a defined "first" element), are supposed
 * to be "position-aware", which means that they keep track of the current index within the collection.
 *
 * @note Objects that are pointed to by an iterator are always mutable through that iterator. However,
-* any concurrent mutation of the collection other than by this iterator makes this iterator invalid
+* any concurrent mutation of the collection other than by this iterator makes this iterator invalid,
 * and it must not be used anymore.
 */
 typedef struct cx_iterator_s CxIterator;
 /**
 * Checks if the iterator points to valid data.
 *
 * This is especially false for past-the-end iterators.
 *
 * @param iter the iterator
-* @return true iff the iterator points to valid data
+* @retval true if the iterator points to valid data
+* @retval false if the iterator already moved past the end
 */
 #define cxIteratorValid(iter) (iter).base.valid(&(iter))
 /**
 * Returns a pointer to the current element.
 *
 * The behavior is undefined if this iterator is invalid.
 *
 * @param iter the iterator
 * @return a pointer to the current element
+* @see cxIteratorValid()
 */
 #define cxIteratorCurrent(iter) (iter).base.current(&iter)
 /**
 * Advances the iterator to the next element.
 #define cxIteratorNext(iter) (iter).base.next(&iter)
 /**
 * Flags the current element for removal, if this iterator is mutating.
 *
+* Does nothing for non-mutating iterators.
+*
 * @param iter the iterator
 */
 #define cxIteratorFlagRemoval(iter) (iter).base.remove |= (iter).base.mutating
 /**
 * Obtains a reference to an arbitrary iterator.
 *
 * This is useful for APIs that expect some iterator as an argument.
 *
 * @param iter the iterator
+* @return (@c CxIterator*) a pointer to the iterator
 */
 #define cxIteratorRef(iter) &((iter).base)
 /**
 * Loops over an iterator.
+*
 * @param type the type of the elements
 * @param elem the name of the iteration variable
 * @param iter the iterator
 */
 #define cx_foreach(type, elem, iter) \
 /**
 * Creates an iterator for the specified plain array.
 *
-* The \p array can be \c NULL in which case the iterator will be immediately
+* The @p array can be @c NULL in which case the iterator will be immediately
-* initialized such that #cxIteratorValid() returns \c false.
+* initialized such that #cxIteratorValid() returns @c false.
 *
 * This iterator yields the addresses of the array elements.
 * If you want to iterator over an array of pointers, you can
 * use cxIteratorPtr() to create an iterator which directly
 * yields the stored pointers.
 *
-* @param array a pointer to the array (can be \c NULL)
+* @param array a pointer to the array (can be @c NULL)
 * @param elem_size the size of one array element
 * @param elem_count the number of elements in the array
 * @return an iterator for the specified array
 * @see cxIteratorPtr()
 */
 *
 * While the iterator is in use, the array may only be altered by removing
 * elements through #cxIteratorFlagRemoval(). Every other change to the array
 * will bring this iterator to an undefined state.
 *
-* When \p remove_keeps_order is set to \c false, removing an element will only
+* When @p remove_keeps_order is set to @c false, removing an element will only
 * move the last element to the position of the removed element, instead of
 * moving all subsequent elements by one. Usually, when the order of elements is
-* not important, this parameter should be set to \c false.
+* not important, this parameter should be set to @c false.
 *
-* The \p array can be \c NULL in which case the iterator will be immediately
+* The @p array can be @c NULL in which case the iterator will be immediately
-* initialized such that #cxIteratorValid() returns \c false.
+* initialized such that #cxIteratorValid() returns @c false.
 *
 *
-* @param array a pointer to the array (can be \c NULL)
+* @param array a pointer to the array (can be @c NULL)
 * @param elem_size the size of one array element
 * @param elem_count the number of elements in the array
-* @param remove_keeps_order \c true if the order of elements must be preserved
+* @param remove_keeps_order @c true if the order of elements must be preserved
 * when removing an element
 * @return an iterator for the specified array
 */
 cx_attr_nodiscard
 CxIterator cxMutIterator(
 * This iterator assumes that every element in the array is a pointer
 * and yields exactly those pointers during iteration (while in contrast
 * an iterator created with cxIterator() would return the addresses
 * of those pointers within the array).
 *
-* @param array a pointer to the array (can be \c NULL)
+* @param array a pointer to the array (can be @c NULL)
 * @param elem_count the number of elements in the array
 * @return an iterator for the specified array
 * @see cxIterator()
 */
 cx_attr_nodiscard
 * Creates a mutating iterator for the specified plain pointer array.
 *
 * This is the mutating variant of cxIteratorPtr(). See also
 * cxMutIterator().
 *
-* @param array a pointer to the array (can be \c NULL)
+* @param array a pointer to the array (can be @c NULL)
 * @param elem_count the number of elements in the array
-* @param remove_keeps_order \c true if the order of elements must be preserved
+* @param remove_keeps_order @c true if the order of elements must be preserved
 * when removing an element
 * @return an iterator for the specified array
 * @see cxMutIterator()
 * @see cxIteratorPtr()
 */

Mercurial > hg > ucx / file comparison

comparison: src/cx/iterator.h

src/cx/iterator.h