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

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Sun Aug 15 01:37:47 2010
New Revision: 48498
URL: https://trac.parrot.org/parrot/changeset/48498

Log:
Insert POD 'item' so that documentor will know where to add PMC function documentation.  In several places, convert inline comments to POD.

Modified:
   trunk/src/pmc/class.pmc

Modified: trunk/src/pmc/class.pmc
==============================================================================
--- trunk/src/pmc/class.pmc	Sun Aug 15 01:18:28 2010	(r48497)
+++ trunk/src/pmc/class.pmc	Sun Aug 15 01:37:47 2010	(r48498)
@@ -187,6 +187,16 @@
 /* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
 /* HEADERIZER END: static */
 
+/*
+
+=item C<static int pointer_compare(PARROT_INTERP, const void *a, const void *b)>
+
+
+
+=cut
+
+*/
+
 static int
 pointer_compare(SHIM_INTERP, ARGIN_NULLOK(const void *a),
     ARGIN_NULLOK(const void *b))
@@ -195,6 +205,16 @@
     return a != b;
 }
 
+/*
+
+=item C<static size_t key_hash_pointer(PARROT_INTERP, const void *value, size_t seed)>
+
+
+
+=cut
+
+*/
+
 static size_t
 key_hash_pointer(SHIM_INTERP, ARGIN(const void *value), size_t seed)
 {
@@ -202,6 +222,17 @@
     return ((size_t) value ^ seed);
 }
 
+/*
+
+=item C<static int cache_class_attribs(PARROT_INTERP,
+    PMC *cur_class, PMC *attrib_index, PMC *cache, int cur_index)>
+
+
+
+=cut
+
+*/
+
 static int
 cache_class_attribs(PARROT_INTERP,
         ARGIN(PMC *cur_class), ARGIN(PMC *attrib_index),
@@ -241,8 +272,17 @@
     return cur_index;
 }
 
-/* This function builds the attribute index (table to map class name and
- * attribute name to an index) for the current class. */
+/*
+
+=item C<static void build_attrib_index(PARROT_INTERP, PMC *self)>
+
+This function builds the attribute index (table to map class name and
+attribute name to an index) for the current class.
+
+=cut
+
+*/
+
 static void
 build_attrib_index(PARROT_INTERP, ARGIN(PMC *self))
 {
@@ -271,8 +311,17 @@
     _class->attrib_index = attrib_index;
     _class->attrib_cache = cache;
 }
+ 
+/*
+
+=item C<static void init_class_from_hash(PARROT_INTERP, PMC *self, PMC *info)>
+
+Takes a hash and initializes the class based on it.
+
+=cut
+
+*/
 
-/* Takes a hash and initializes the class based on it. */
 static void
 init_class_from_hash(PARROT_INTERP, ARGMOD(PMC *self), ARGIN_NULLOK(PMC *info))
 {
@@ -434,6 +483,16 @@
     Parrot_oo_extract_methods_from_namespace(interp, self, _class->_namespace);
 }
 
+/*
+
+=item C<static void initialize_parents(PARROT_INTERP, PMC *object, PMC *all_parents)>
+
+
+
+=cut
+
+*/
+
 static void
 initialize_parents(PARROT_INTERP, ARGIN(PMC *object), ARGIN(PMC *all_parents))
 {
@@ -463,6 +522,17 @@
     }
 }
 
+/*
+
+=item C<static void initialize_parents_pmc(PARROT_INTERP,
+    PMC *object, PMC *all_parents, PMC *init)>
+
+
+
+=cut
+
+*/
+
 static void
 initialize_parents_pmc(PARROT_INTERP, ARGIN(PMC *object),
         ARGIN(PMC *all_parents), ARGIN(PMC *init))
@@ -491,10 +561,19 @@
     }
 }
 
-/* This function makes and caches the name of this class, returning the string
- * directly.  VTABLE_isa() uses the name without copying it, for efficiency
- * reasons, as it does not modify the STRING.  VTABLE_get_string() makes a copy
- * of the STRING, so its callers are free to modify it. */
+/*
+
+=item C<static STRING * make_class_name(PARROT_INTERP, PMC *SELF)>
+
+This function makes and caches the name of this class, returning the string
+directly.  C<VTABLE_isa()> uses the name without copying it, for efficiency
+reasons, as it does not modify the STRING.  C<VTABLE_get_string()> makes a
+copy of the STRING, so its callers are free to modify it.
+
+=cut
+
+*/
+
 PARROT_CANNOT_RETURN_NULL
 static STRING *
 make_class_name(PARROT_INTERP, ARGIN(PMC *SELF))
@@ -525,11 +604,19 @@
     return _class->name;
 }
 
-/* calculates the C3 method resolution order for this class. C3 is the
- * name of an algorithm used to calculate the method resolution order
- * (MRO) to use in a system with multiple inheritance. For more information
- * see the documentation associated with C<Parrot_ComputeMRO_C3>.
- */
+/*
+
+=item C<static void calculate_mro(PARROT_INTERP, PMC *SELF, INTVAL num_parents)>
+
+Calculates the C3 method resolution order for this class. C3 is the name of an
+algorithm used to calculate the method resolution order (MRO) to use in a
+system with multiple inheritance. For more information see the documentation
+associated with C<Parrot_ComputeMRO_C3>.
+
+=cut
+
+*/
+
 static void
 calculate_mro(PARROT_INTERP, ARGIN(PMC *SELF), INTVAL num_parents)
 {