src/cx/map.h

changeset 555
d79fbd028e26
parent 553
8f7d3e7b5b93
child 558
9b767b07602c
equal deleted inserted replaced
554:fd3d843b839d 555:d79fbd028e26
229 } 229 }
230 230
231 /** 231 /**
232 * Creates a key iterator for a map. 232 * Creates a key iterator for a map.
233 * 233 *
234 * The elements of the iterator are keys of type CxDataPtr.
235 *
234 * \note An iterator iterates over all elements successively. Therefore the order 236 * \note An iterator iterates over all elements successively. Therefore the order
235 * highly depends on the map implementation and may change arbitrarily when the contents change. 237 * highly depends on the map implementation and may change arbitrarily when the contents change.
236 * 238 *
237 * @param map the map to create the iterator for 239 * @param map the map to create the iterator for
238 * @return an iterator for the currently stored keys 240 * @return an iterator for the currently stored keys
243 } 245 }
244 246
245 /** 247 /**
246 * Creates an iterator for a map. 248 * Creates an iterator for a map.
247 * 249 *
248 * The values of the iterator are dynamically created key/value pairs of type CxMapEntry. 250 * The elements of the iterator are key/value pairs of type CxMapEntry.
249 * 251 *
250 * \note An iterator iterates over all elements successively. Therefore the order 252 * \note An iterator iterates over all elements successively. Therefore the order
251 * highly depends on the map implementation and may change arbitrarily when the contents change. 253 * highly depends on the map implementation and may change arbitrarily when the contents change.
252 * 254 *
253 * @param map the map to create the iterator for 255 * @param map the map to create the iterator for
254 * @return an iterator for the currently stored keys 256 * @return an iterator for the currently stored entries
255 * @see cxMapIteratorKeys() 257 * @see cxMapIteratorKeys()
256 * @see cxMapIteratorValues() 258 * @see cxMapIteratorValues()
257 */ 259 */
258 __attribute__((__nonnull__, __warn_unused_result__)) 260 __attribute__((__nonnull__, __warn_unused_result__))
259 static inline CxIterator cxMapIterator(CxMap *map) { 261 static inline CxIterator cxMapIterator(CxMap *map) {

mercurial