src/cx/iterator.h

changeset 704
35f06c5eeb0e
parent 695
eb1884a8b096
child 740
378578666c83
     1.1 --- a/src/cx/iterator.h	Sun May 21 11:52:58 2023 +0200
     1.2 +++ b/src/cx/iterator.h	Sun May 21 14:03:21 2023 +0200
     1.3 @@ -51,6 +51,8 @@
     1.4  
     1.5      /**
     1.6       * Returns a pointer to the current element.
     1.7 +     *
     1.8 +     * When valid returns false, the behavior of this function is undefined.
     1.9       */
    1.10      __attribute__ ((__nonnull__))
    1.11      void *(*current)(void const *);
    1.12 @@ -63,12 +65,16 @@
    1.13  
    1.14      /**
    1.15       * Advances the iterator.
    1.16 +     *
    1.17 +     * When valid returns false, the behavior of this function is undefined.
    1.18       */
    1.19      __attribute__ ((__nonnull__))
    1.20      void (*next)(void *);
    1.21  
    1.22      /**
    1.23       * Flag current element for removal, if possible.
    1.24 +     *
    1.25 +     * When valid returns false, the behavior of this function is undefined.
    1.26       */
    1.27      __attribute__ ((__nonnull__))
    1.28      bool (*flag_removal)(void *);

mercurial