From 20138b685ec646ef0eec3302b2097767bba27fa8 Mon Sep 17 00:00:00 2001 From: striker Date: Sun, 2 Nov 2003 01:06:49 +0000 Subject: * include/apr_allocator.h (apr_memnode_t, apr_allocator_free): Update comments regarding the use of fields within apr_memnode_t. git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@64707 13f79535-47bb-0310-9956-ffa450edef68 --- include/apr_allocator.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'include/apr_allocator.h') diff --git a/include/apr_allocator.h b/include/apr_allocator.h index b2b7b8f0a..ce2f4e26a 100644 --- a/include/apr_allocator.h +++ b/include/apr_allocator.h @@ -83,7 +83,10 @@ typedef struct apr_memnode_t apr_memnode_t; /** basic memory node structure * @note The next, ref and first_avail fields are available for use by the * caller of apr_allocator_alloc(), the remaining fields are read-only. - * The next, ref and first_avail fields will be properly restored by + * The next field has to be used with caution and sensibly set when the + * memnode is passed back to apr_allocator_free(). See apr_allocator_free() + * for details. + * The ref and first_avail fields will be properly restored by * apr_allocator_free(). */ struct apr_memnode_t { @@ -126,7 +129,9 @@ APR_DECLARE(apr_memnode_t *) apr_allocator_alloc(apr_allocator_t *allocator, apr_size_t size); /** - * Free a block of mem, giving it back to the allocator + * Free a list of blocks of mem, giving them back to the allocator. + * The list is typically terminated by a memnode with its next field + * set to NULL. * @param allocator The allocator to give the mem back to * @param memnode The memory node to return */ -- cgit v1.2.1