doc corrections
authorChristian Thaeter <ct@pipapo.org>
Fri, 1 Dec 2006 22:16:18 +0000 (23:16 +0100)
committerChristian Thaeter <ct@pipapo.org>
Fri, 1 Dec 2006 22:16:18 +0000 (23:16 +0100)
lib/acogc.c
lib/acogc.h

index 2606945..8b64b14 100644 (file)
@@ -21,7 +21,6 @@
 #include <stdlib.h>
 
 #include "acogc.h"
-
 // TODO collection statistics (timing, global counter, etc)
 
 /*
index 4e1d321..8f1cb95 100644 (file)
@@ -146,10 +146,12 @@ typedef enum
 
 typedef enum
   {
+    // first 2 states are not GC controlled and memory tagged with thme has no gc descriptor
     ACOGC_UNSET,        /* undefined */
+    ACOGC_ALLOC,        /* malloc/free acogoc_alloc/acogc_free */
+    // next 2 states for memory with gc descriptor
     ACOGC_STATIC,       /* non freeable */
     ACOGC_GC,           /* garbage collected */
-    ACOGC_ALLOC,        /* malloc/free acogoc_alloc/acogc_free */
   } acogc_alloc_type;
 
 /*
@@ -206,7 +208,11 @@ acogc_root_collect (AcogcRoot self, acogc_freeing_policy pol);
 /*
   factory
 
-  the factory holds the static size for all objects it manages. objects are allocated with 'acogc_factory_alloc'. collected objects are cached and freed based on the high_water/low_water policies. collected, not-yet-freed objects can be reinstantiated and the user can implement fancy caching schemes.
+  the factory holds the static size for all objects it manages.
+  Objects are allocated with 'acogc_factory_alloc'.
+  Collected objects are cached and freed based on the high_water/low_water policies.
+  Collected, not-yet-freed objects can be reinstantiated and
+  the user can implement fancy caching schemes.
 */
 struct acogc_factory_struct
 {
@@ -228,16 +234,13 @@ struct acogc_factory_struct
 
   size_t size;                          /* size od objects allocated by this factory */
 
-  acogc_mark_func mark;                 /* proactive collection check */
-  acogc_initize_func initize;           /* finalizer called before a object is free()'ed */
+  acogc_mark_func mark;                 /* marker function */
+  acogc_initize_func initize;           /* initizer for NULL'ing referencess */
   acogc_finalize_func finalize;         /* finalizer called before a object is free()'ed */
 };
 
 /*
   initialize a acogc_factory
-
-  the user has to supply arrays with offsetof() values of pointers and weakrefs terminated with SIZE_MAX,
-  the GC takes care to initialize them
 */
 void
 acogc_factory_init (AcogcFactory self,