# HG changeset patch # User Mike Becker # Date 1653647329 -7200 # Node ID d79fbd028e26d0cbfadb7d0b73f432d66f77e73d # Parent fd3d843b839dceaab3b181526393d74e4d2dfa79 fix documentation for map iterators diff -r fd3d843b839d -r d79fbd028e26 src/cx/map.h --- 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() */