[svn:parrot] r49629 - branches/generational_gc/src/gc

[mikehh at svn.parrot.org]

Author: mikehh
Date: Fri Oct 22 01:13:18 2010
New Revision: 49629
URL: https://trac.parrot.org/parrot/changeset/49629

Log:
[generational_gc] add missing c function docs

Modified:
   branches/generational_gc/src/gc/gc_ms2.c

Modified: branches/generational_gc/src/gc/gc_ms2.c
==============================================================================
--- branches/generational_gc/src/gc/gc_ms2.c	Fri Oct 22 00:53:46 2010	(r49628)
+++ branches/generational_gc/src/gc/gc_ms2.c	Fri Oct 22 01:13:18 2010	(r49629)
@@ -921,6 +921,18 @@
 
 }
 
+/*
+
+=item C<static void gc_ms2_pmc_validate(PARROT_INTERP, PMC *pmc)>
+
+=item C<static void gc_ms2_string_validate(PARROT_INTERP, STRING *s)>
+
+Validate pmc/string objects re current generation
+
+=cut
+
+*/
+
 static void
 gc_ms2_pmc_validate(PARROT_INTERP, ARGIN(PMC *pmc))
 {
@@ -1498,6 +1510,16 @@
 }
 
 
+/*
+
+=item C<static void gc_ms2_vtable_mark_propagate(PARROT_INTERP, PMC *pmc)>
+
+propogate to next generation if req
+
+=cut
+
+*/
+
 static void
 gc_ms2_vtable_mark_propagate(PARROT_INTERP, ARGIN(PMC *pmc))
 {
@@ -1530,6 +1552,16 @@
     PObj_live_SET(pmc);
 }
 
+/*
+
+=item C<static void gc_ms2_string_mark_propagate(PARROT_INTERP, STRING *s)>
+
+propogate to next generation if req
+
+=cut
+
+*/
+
 static void
 gc_ms2_string_mark_propagate(PARROT_INTERP, ARGIN(STRING *s))
 {
@@ -1556,6 +1588,7 @@
         | PObj_GC_generation_2_FLAG);
     s->flags |= gen2flags(self->current_generation);
 }
+
 /*
 =item C<static void gc_ms2_sweep_pool(PARROT_INTERP, Pool_Allocator *pool,
 Linked_List *list, sweep_cb callback)>
@@ -1564,6 +1597,7 @@
 
 =cut
 */
+
 static void
 gc_ms2_sweep_pool(PARROT_INTERP,
         ARGIN(Pool_Allocator *pool),
@@ -1965,6 +1999,18 @@
     return total_amount;
 }
 
+/*
+
+=item C<static int pobj2gen(PMC *pmc)>
+
+=item C<static int gen2flags(int gen)>
+
+helper functions to check and use macro
+
+=cut
+
+*/
+
 static int
 pobj2gen(ARGIN(PMC *pmc))
 {
@@ -2025,6 +2071,16 @@
     obj->flags |= gen2flags(gen);
 }
 
+/*
+
+=item C<static void gc_ms2_check_sanity(PARROT_INTERP)>
+
+sanity check
+
+=cut
+
+*/
+
 static void
 gc_ms2_check_sanity(PARROT_INTERP)
 {
@@ -2046,6 +2102,17 @@
     }
 }
 
+/*
+
+=item C<static void gc_ms2_print_stats(PARROT_INTERP, const char* header, int
+gen)>
+
+debug function
+
+=cut
+
+*/
+
 static void
 gc_ms2_print_stats(PARROT_INTERP, const char* header, int gen)
 {