[svn:parrot] r39728 - branches/tt761_keys_revamp/src/pmc

[bacek at svn.parrot.org]

Author: bacek
Date: Mon Jun 22 23:47:11 2009
New Revision: 39728
URL: https://trac.parrot.org/parrot/changeset/39728

Log:
[pmc] Add little bit of docs to Hash.

Modified:
   branches/tt761_keys_revamp/src/pmc/hash.pmc

Modified: branches/tt761_keys_revamp/src/pmc/hash.pmc
==============================================================================
--- branches/tt761_keys_revamp/src/pmc/hash.pmc	Mon Jun 22 23:21:31 2009	(r39727)
+++ branches/tt761_keys_revamp/src/pmc/hash.pmc	Mon Jun 22 23:47:11 2009	(r39728)
@@ -8,6 +8,28 @@
 
 =head1 DESCRIPTION
 
+Hash PMC wraps Parrot's _hash to provide high-level API:
+
+=over 4
+
+=item *
+
+Convert between various types to use as hash keys.
+
+=item *
+
+Convert between various types to use as hash values.
+
+=item *
+
+Handle compound Keys for nested Hash/Array lookups.
+
+=item *
+
+Provide C<HashIterator> to iterate over C<Hash>.
+
+=back
+
 These are the vtable functions for the Hash PMC.
 
 =head2 Functions
@@ -68,7 +90,14 @@
 
 /*
 
-Poor-man polymorphic functions to convert something to hash key-type.
+Poor-man polymorphic functions to convert something to something.
+
+There is bunch of functions to convert from passed value to stored keys type and to/from
+stored values type.
+
+void *hash_key_from_TYPE convert to keys type.
+void *hash_value_from_TYPE convert to values type.
+TYPE hash_value_to_TYPE convert from values type.
 
 */