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

[mikehh at svn.parrot.org]

Author: mikehh
Date: Wed Jun  2 22:28:03 2010
New Revision: 47313
URL: https://trac.parrot.org/parrot/changeset/47313

Log:
add documentation

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

Modified: branches/gc_massacre/src/gc/gc_tms.c
==============================================================================
--- branches/gc_massacre/src/gc/gc_tms.c	Wed Jun  2 21:57:09 2010	(r47312)
+++ branches/gc_massacre/src/gc/gc_tms.c	Wed Jun  2 22:28:03 2010	(r47313)
@@ -469,7 +469,7 @@
 
 /*
 
-=item C<static size_t gc_tms_get_gc_tmso(PARROT_INTERP, Interpinfo_enum what)>
+=item C<static size_t gc_tms_get_gc_info(PARROT_INTERP, Interpinfo_enum what)>
 
 Stub for GC introspection function.
 
@@ -752,6 +752,16 @@
     self->gc_mark_runs++;
 }
 
+/*
+
+=item C<static void gc_tms_mark_pmc_header(PARROT_INTERP, PMC *pmc)>
+
+mark as grey
+
+=cut
+
+*/
+
 static void
 gc_tms_mark_pmc_header(PARROT_INTERP, ARGIN(PMC *pmc))
 {
@@ -768,6 +778,17 @@
     Parrot_gc_list_append(interp, self->grey_objects, item);
 }
 
+/*
+
+=item C<static void gc_tms_real_mark_pmc(PARROT_INTERP, struct TriColor_GC
+*self, struct List_Item_Header *li)>
+
+mark as live
+
+=cut
+
+*/
+
 static void
 gc_tms_real_mark_pmc(PARROT_INTERP,
         ARGIN(struct TriColor_GC *self),
@@ -794,6 +815,16 @@
         Parrot_gc_mark_PMC_alive(interp, PMC_metadata(obj));
 }
 
+/*
+
+=item C<static int gc_tms_is_pmc_ptr(PARROT_INTERP, void *ptr)>
+
+establish if *ptr is.owned
+
+=cut
+
+*/
+
 static int
 gc_tms_is_pmc_ptr(PARROT_INTERP, ARGIN_NULLOK(void *ptr))
 {
@@ -820,6 +851,16 @@
 #endif
 }
 
+/*
+
+=item C<static void gc_tms_mark_pobj_header(PARROT_INTERP, PObj * obj)>
+
+if already marked mark as grey else make as live
+
+=cut
+
+*/
+
 static void
 gc_tms_mark_pobj_header(PARROT_INTERP, ARGIN_NULLOK(PObj * obj))
 {