[svn:parrot] r38152 - branches/packfile_revamp/src/pmc

bacek at svn.parrot.org bacek at svn.parrot.org
Thu Apr 16 10:04:03 UTC 2009


Author: bacek
Date: Thu Apr 16 10:04:01 2009
New Revision: 38152
URL: https://trac.parrot.org/parrot/changeset/38152

Log:
Some minor documentation stuff. Infinoid++

Modified:
   branches/packfile_revamp/src/pmc/packfileannotation.pmc
   branches/packfile_revamp/src/pmc/packfileannotationkeys.pmc
   branches/packfile_revamp/src/pmc/packfileconstanttable.pmc
   branches/packfile_revamp/src/pmc/packfiledirectory.pmc
   branches/packfile_revamp/src/pmc/packfilefixupentry.pmc
   branches/packfile_revamp/src/pmc/packfilefixuptable.pmc

Modified: branches/packfile_revamp/src/pmc/packfileannotation.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfileannotation.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfileannotation.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -110,7 +110,7 @@
 
 /*
 
-=item C<void set_key_id(INTVAL offset)>
+=item C<void set_key_id(INTVAL key_id)>
 
 Set the ID of the key of the annotation.
 
@@ -138,7 +138,7 @@
 
 /*
 
-=item C<void set_integer(INTVAL offset)>
+=item C<void set_integer(INTVAL value)>
 
 Set the value of the annotation.
 

Modified: branches/packfile_revamp/src/pmc/packfileannotationkeys.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfileannotationkeys.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfileannotationkeys.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -192,7 +192,7 @@
 
 /*
 
-=item C<void set_pointer()>
+=item C<void set_pointer(void *pointer)>
 
 Initialize from PackFile_Annotation pointer.
 
@@ -229,7 +229,7 @@
 
 /*
 
-=item C<void set_constant_table()>
+=item C<void set_constant_table(PMC *table)>
 
 Set PackfileConstantTable associated with Keys.
 
@@ -242,7 +242,7 @@
 
 /*
 
-=item C<void get_constant_table()>
+=item C<PMC *get_constant_table()>
 
 Get PackfileConstantTable associated with PackfileAnnotationKeys.
 Solely for testing purpose only.
@@ -259,7 +259,7 @@
 
 /*
 
-=item C<void get_name_constant()>
+=item C<INTVAL get_name_constant(INTVAL index)>
 
 Get constant id used for name at given C<index>.
 

Modified: branches/packfile_revamp/src/pmc/packfileconstanttable.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfileconstanttable.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfileconstanttable.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -30,7 +30,7 @@
     /* ResizablePMCArray for storing constants */
     ATTR PMC *constants;
 
-    /* ResizablePMCArray for storing constant types */
+    /* ResizableIntegerArray for storing constant types */
     ATTR PMC *types;
 
 /*
@@ -258,7 +258,7 @@
 
 /*
 
-=item C<void set_number_keyed_int(INTVAL index, INTVAL value)>
+=item C<void set_number_keyed_int(INTVAL index, FLOATVAL value)>
 
 Set the constant to the given number.
 

Modified: branches/packfile_revamp/src/pmc/packfiledirectory.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfiledirectory.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfiledirectory.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -227,8 +227,7 @@
 
 =item C<PMC *get_pmc_keyed(PMC *key)>
 
-Fetch a keyed string value from the packfiledirectory object.  Dispatches to
-get_pmc_keyed_str.
+Fetch a keyed string value from the packfiledirectory object.
 
 =cut
 
@@ -260,6 +259,17 @@
             PARROT_PACKFILEDIRECTORY(SELF)->hash, name, segment);
     }
 
+/*
+
+=item C<PMC *set_pmc_keyed(PMC *key)>
+
+Add a segment with the given name to the directory.  Dispatches to
+set_pmc_keyed_str.
+
+=cut
+
+*/
+
     VTABLE void set_pmc_keyed(PMC *key, PMC *segment)  {
         STRING *s_key = VTABLE_get_string(interp, key);
         VTABLE_set_pmc_keyed_str(interp, SELF, s_key, segment);

Modified: branches/packfile_revamp/src/pmc/packfilefixupentry.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfilefixupentry.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfilefixupentry.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -87,7 +87,9 @@
 
 /*
 
-=item C<set_pointer>
+=item C<void set_pointer(void *pointer)>
+
+Initialize from PackFile_FixupEntry pointer.
 
 =cut
 
@@ -108,6 +110,9 @@
 /*
 
 =item C<void *get_pointer()>
+
+Create PackFile_FixupEntry* from self.
+
 =cut
 
 */

Modified: branches/packfile_revamp/src/pmc/packfilefixuptable.pmc
==============================================================================
--- branches/packfile_revamp/src/pmc/packfilefixuptable.pmc	Thu Apr 16 09:49:12 2009	(r38151)
+++ branches/packfile_revamp/src/pmc/packfilefixuptable.pmc	Thu Apr 16 10:04:01 2009	(r38152)
@@ -92,7 +92,9 @@
 
 /*
 
-=item C<set_pointer>
+=item C<void set_pointer(void *pointer)>
+
+Initialize from PackFile_FixupTable pointer.
 
 =cut
 
@@ -120,6 +122,9 @@
 /*
 
 =item C<void *get_pointer()>
+
+Create PackFile_FixupTable* from self.
+
 =cut
 
 */


More information about the parrot-commits mailing list