X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Fheap.h;h=97cef8a3f1dd615b6e46c2a4694f6ef53bc7da5e;hb=faed9d33b0a6bd6c2376e313fa3b73512c545caa;hp=07ca8087b3102c8140b3f7251736a2053c8617ca;hpb=76c53bfa0136be55cf17e57b1ee098e5dfeefa70;p=bertos.git diff --git a/mware/heap.h b/mware/heap.h old mode 100755 new mode 100644 index 07ca8087..97cef8a3 --- a/mware/heap.h +++ b/mware/heap.h @@ -1,9 +1,34 @@ -/*! +/** * \file * * * \brief Heap subsystem (public interface). @@ -20,6 +45,12 @@ /*#* *#* $Log$ + *#* Revision 1.7 2006/07/19 12:56:27 bernie + *#* Convert to new Doxygen style. + *#* + *#* Revision 1.6 2005/11/27 23:36:19 bernie + *#* Use appconfig.h instead of cfg/config.h. + *#* *#* Revision 1.5 2005/11/04 16:20:02 bernie *#* Fix reference to README.devlib in header. *#* @@ -47,24 +78,24 @@ #define MWARE_HEAP_H #include -#include +#include struct _MemChunk; -//! A heap +/// A heap struct Heap { - struct _MemChunk *FreeList; //!< Head of the free list + struct _MemChunk *FreeList; ///< Head of the free list }; -//! Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes +/// Initialize \a heap within the buffer pointed by \a memory which is of \a size bytes void heap_init(struct Heap* heap, void* memory, size_t size); -//! Allocate a chunk of memory of \a size bytes from the heap +/// Allocate a chunk of memory of \a size bytes from the heap void *heap_allocmem(struct Heap* heap, size_t size); -//! Free a chunk of memory of \a size bytes from the heap +/// Free a chunk of memory of \a size bytes from the heap void heap_freemem(struct Heap* heap, void *mem, size_t size);