[svn:parrot] r48516 - trunk/src/pmc

[mikehh at svn.parrot.org]

Author: mikehh
Date: Sun Aug 15 13:03:59 2010
New Revision: 48516
URL: https://trac.parrot.org/parrot/changeset/48516

Log:
add documentation to pass pmc_docs.t

Modified:
   trunk/src/pmc/orderedhash.pmc

Modified: trunk/src/pmc/orderedhash.pmc
==============================================================================
--- trunk/src/pmc/orderedhash.pmc	Sun Aug 15 12:46:01 2010	(r48515)
+++ trunk/src/pmc/orderedhash.pmc	Sun Aug 15 13:03:59 2010	(r48516)
@@ -132,8 +132,18 @@
 /* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
 /* HEADERIZER END: static */
 
-/* Get list_item by index */
-/* XXX Can this actually return NULL or not? */
+/*
+
+=item C<static PMC* get_list_item(PARROT_INTERP, PMC *self, INTVAL idx)>
+
+Get list_item by index
+
+XXX Can this actually return NULL or not?
+
+=cut
+
+*/
+
 PARROT_WARN_UNUSED_RESULT
 PARROT_CAN_RETURN_NULL
 static PMC*
@@ -158,8 +168,19 @@
     return list_entry;
 }
 
-/* Find first/last in cloned/thawed OrderedHash */
-/* Parameter C<pmc_hash> is Hash, not OrderedHash */
+/*
+
+=item C<static void find_bounds(PARROT_INTERP, PMC *pmc_hash, PMC **first, PMC
+**last)>
+
+Find first/last in cloned/thawed OrderedHash
+
+Parameter C<pmc_hash> is Hash, not OrderedHash
+
+=cut
+
+*/
+
 static void
 find_bounds(PARROT_INTERP, ARGIN(PMC *pmc_hash), ARGMOD(PMC **first), ARGMOD(PMC **last))
 {
@@ -182,6 +203,17 @@
 }
 
 /* Helpers for boxing values */
+
+/*
+
+=item C<static PMC* box_string(PARROT_INTERP, STRING *str)>
+
+Helper function to box STRING
+
+=cut
+
+*/
+
 PARROT_CANNOT_RETURN_NULL
 PARROT_WARN_UNUSED_RESULT
 static PMC*
@@ -195,6 +227,16 @@
     return ret;
 }
 
+/*
+
+=item C<static PMC* box_integer(PARROT_INTERP, INTVAL val)>
+
+Helper function to box INTVAL
+
+=cut
+
+*/
+
 PARROT_CANNOT_RETURN_NULL
 PARROT_WARN_UNUSED_RESULT
 static PMC*
@@ -208,6 +250,16 @@
     return ret;
 }
 
+/*
+
+=item C<static PMC* box_number(PARROT_INTERP, FLOATVAL val)>
+
+Helper function to box FLOATVAL
+
+=cut
+
+*/
+
 PARROT_CANNOT_RETURN_NULL
 PARROT_WARN_UNUSED_RESULT
 static PMC*