src/cx/map.h

changeset 555
d79fbd028e26
parent 553
8f7d3e7b5b93
child 558
9b767b07602c
     1.1 --- a/src/cx/map.h	Fri May 27 12:28:35 2022 +0200
     1.2 +++ b/src/cx/map.h	Fri May 27 12:28:49 2022 +0200
     1.3 @@ -231,6 +231,8 @@
     1.4  /**
     1.5   * Creates a key iterator for a map.
     1.6   *
     1.7 + * The elements of the iterator are keys of type CxDataPtr.
     1.8 + *
     1.9   * \note An iterator iterates over all elements successively. Therefore the order
    1.10   * highly depends on the map implementation and may change arbitrarily when the contents change.
    1.11   *
    1.12 @@ -245,13 +247,13 @@
    1.13  /**
    1.14   * Creates an iterator for a map.
    1.15   *
    1.16 - * The values of the iterator are dynamically created key/value pairs of type CxMapEntry.
    1.17 + * The elements of the iterator are key/value pairs of type CxMapEntry.
    1.18   *
    1.19   * \note An iterator iterates over all elements successively. Therefore the order
    1.20   * highly depends on the map implementation and may change arbitrarily when the contents change.
    1.21   *
    1.22   * @param map the map to create the iterator for
    1.23 - * @return an iterator for the currently stored keys
    1.24 + * @return an iterator for the currently stored entries
    1.25   * @see cxMapIteratorKeys()
    1.26   * @see cxMapIteratorValues()
    1.27   */

mercurial