[svn:parrot] r47312 - branches/gc_massacre/src/gc

[mikehh at svn.parrot.org]

Author: mikehh
Date: Wed Jun  2 21:57:09 2010
New Revision: 47312
URL: https://trac.parrot.org/parrot/changeset/47312

Log:
add documentation

Modified:
   branches/gc_massacre/src/gc/gc_ms.c

Modified: branches/gc_massacre/src/gc/gc_ms.c
==============================================================================
--- branches/gc_massacre/src/gc/gc_ms.c	Wed Jun  2 21:37:46 2010	(r47311)
+++ branches/gc_massacre/src/gc/gc_ms.c	Wed Jun  2 21:57:09 2010	(r47312)
@@ -711,6 +711,16 @@
     ++pool->num_free_objects;
 }
 
+/*
+
+=item C<void gc_ms_mark_pmc_header(PARROT_INTERP, PMC *obj)>
+
+Mark the PMC *obj as live and attach PMCs and/or buffers
+
+=cut
+
+*/
+
 void
 gc_ms_mark_pmc_header(PARROT_INTERP, ARGMOD_NULLOK(PMC *obj))
 {
@@ -736,6 +746,16 @@
     }
 }
 
+/*
+
+=item C<static int gc_ms_is_pmc_ptr(PARROT_INTERP, void *ptr)>
+
+return True if *ptr is contained in the pool
+
+=cut
+
+*/
+
 static int
 gc_ms_is_pmc_ptr(PARROT_INTERP, ARGIN_NULLOK(void *ptr))
 {
@@ -790,6 +810,16 @@
     }
 }
 
+/*
+
+=item C<static void gc_ms_mark_pobj_header(PARROT_INTERP, PObj *obj)>
+
+mark *obj as live
+
+=cut
+
+*/
+
 static void
 gc_ms_mark_pobj_header(PARROT_INTERP, ARGMOD_NULLOK(PObj *obj))
 {