X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fstruct%2Fheap.h;h=9846079af7a734e73a40752d1353c43ce4779789;hb=cbdd295b3172dbfc635ff6895e5eaa0b92e07180;hp=efd02c284ad5a7ffd9544cc8315bf37b521399c4;hpb=f884c67ed85598875ef683987323fd6085e01e14;p=bertos.git diff --git a/bertos/struct/heap.h b/bertos/struct/heap.h index efd02c28..9846079a 100644 --- a/bertos/struct/heap.h +++ b/bertos/struct/heap.h @@ -30,13 +30,16 @@ * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti * --> * + * \defgroup heap Embedded optimized memory allocator + * \ingroup core + * \{ + * * \brief Heap subsystem (public interface). * * \todo Heap memory could be defined as an array of MemChunk, and used * in this form also within the implementation. This would probably remove * memory alignment problems, and also some aliasing issues. * - * \version $Id$ * \author Bernie Innocenti * * $WIZ$ module_name = "heap" @@ -102,12 +105,19 @@ size_t heap_freeSpace(struct Heap *h); #if CONFIG_HEAP_MALLOC +/** + * \name Compatibility interface with C standard library + * \{ + */ void *heap_malloc(struct Heap* heap, size_t size); void *heap_calloc(struct Heap* heap, size_t size); void heap_free(struct Heap* heap, void * mem); +/** \} */ #endif +/** \} */ //defgroup heap + int heap_testSetup(void); int heap_testRun(void); int heap_testTearDown(void);