Document AA .byKeyValue().

dlang · Jan 2, 2015 · 7dd04d0 · 7dd04d0
1 parent 9cb473c
commit 7dd04d0
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/hash-map.dd b/hash-map.dd
@@ -296,6 +296,12 @@ Properties for associative arrays are:
         $(TROW $(D .byValue()), $(ARGS Returns a delegate suitable for use as a $(I ForeachAggregate) to
         a $(GLINK2 statement, ForeachStatement)  which will iterate over the values
         of the associative array.))
+        $(TROW $(D .byKeyValue()), $(ARGS Returns a delegate suitable for use
+        as a $(I ForeachAggregate) to a $(GLINK2 statement, ForeachStatement)
+        which will iterate over key-value pairs of the associative array. The
+        returned pairs are represented by an opaque type with $(D .key) and
+        $(D .value) properties for accessing the key and value of the pair,
+        respectively.))
         $(TROW $(D .get(Key key, lazy Value defVal)),
         $(ARGS Looks up $(D key); if it exists returns corresponding value
         else evaluates and returns $(D defVal).))