ucx/cx/iterator.h

changeset 750
4d7a2238c5ac
parent 748
49a284f61e8c
child 776
96555c0ed875
--- a/ucx/cx/iterator.h	Sun May 21 11:52:06 2023 +0200
+++ b/ucx/cx/iterator.h	Sun May 21 16:34:58 2023 +0200
@@ -51,6 +51,8 @@
 
     /**
      * Returns a pointer to the current element.
+     *
+     * When valid returns false, the behavior of this function is undefined.
      */
     __attribute__ ((__nonnull__))
     void *(*current)(void const *);
@@ -63,12 +65,16 @@
 
     /**
      * Advances the iterator.
+     *
+     * When valid returns false, the behavior of this function is undefined.
      */
     __attribute__ ((__nonnull__))
     void (*next)(void *);
 
     /**
      * Flag current element for removal, if possible.
+     *
+     * When valid returns false, the behavior of this function is undefined.
      */
     __attribute__ ((__nonnull__))
     bool (*flag_removal)(void *);

mercurial