changeset
fix documentation for map iterators
Fri, 27 May 2022 12:28:49 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Fri, 27 May 2022 12:28:49 +0200
- changeset 555
- d79fbd028e26
- parent 554
- fd3d843b839d
- child 556
- 3d19cae7e924
fix documentation for map iterators
| src/cx/map.h | file | annotate | diff | comparison | revisions |
--- a/src/cx/map.h Fri May 27 12:28:35 2022 +0200 +++ b/src/cx/map.h Fri May 27 12:28:49 2022 +0200 @@ -231,6 +231,8 @@ /** * Creates a key iterator for a map. * + * The elements of the iterator are keys of type CxDataPtr. + * * \note An iterator iterates over all elements successively. Therefore the order * highly depends on the map implementation and may change arbitrarily when the contents change. * @@ -245,13 +247,13 @@ /** * Creates an iterator for a map. * - * The values of the iterator are dynamically created key/value pairs of type CxMapEntry. + * The elements of the iterator are key/value pairs of type CxMapEntry. * * \note An iterator iterates over all elements successively. Therefore the order * highly depends on the map implementation and may change arbitrarily when the contents change. * * @param map the map to create the iterator for - * @return an iterator for the currently stored keys + * @return an iterator for the currently stored entries * @see cxMapIteratorKeys() * @see cxMapIteratorValues() */
