Document base and size of objects allocated by finalized_malloc

* include/gc_disclaim.h (GC_finalized_malloc): Refine comment (add
a note about GC_base and GC_size).

diff --git a/include/gc_disclaim.h b/include/gc_disclaim.h
index 3631e6e..716b741 100644 (file)
--- a/include/gc_disclaim.h
+++ b/include/gc_disclaim.h
@@ -48,6 +48,9 @@ struct GC_finalizer_closure {
 /* dedicated object kind with a disclaim procedure, and is more         */
 /* efficient than GC_register_finalizer and friends.                    */
 /* GC_init_finalized_malloc must be called before using this.           */
+/* Note that GC_size (applied to such allocated object) returns a value */
+/* slightly bigger than the specified allocation size, and that GC_base */
+/* result points to a word prior to the start of the allocated object.  */
 GC_API GC_ATTR_MALLOC GC_ATTR_ALLOC_SIZE(1) void * GC_CALL
         GC_finalized_malloc(size_t /*size*/,
                             const struct GC_finalizer_closure * /*fc*/);