From 8e428dbd1a48615c36c8c086dd51079050c9fb1c Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 6 Feb 2010 12:31:09 +0000 Subject: Kernel headers cleanup. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1568 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/mempools.h | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) (limited to 'os/kernel/include/mempools.h') diff --git a/os/kernel/include/mempools.h b/os/kernel/include/mempools.h index 553534dd3..d6611663a 100644 --- a/os/kernel/include/mempools.h +++ b/os/kernel/include/mempools.h @@ -18,8 +18,9 @@ */ /** - * @file mempools.h - * @brief Memory Pools macros and structures. + * @file mempools.h + * @brief Memory Pools macros and structures. + * * @addtogroup pools * @{ */ @@ -30,14 +31,15 @@ #if CH_USE_MEMPOOLS /** - * @brief Memory pool free object header. + * @brief Memory pool free object header. */ struct pool_header { - struct pool_header *ph_next; + struct pool_header *ph_next; /**< @brief Pointer to the next pool + header in the list. */ }; /** - * @brief Memory pool descriptor. + * @brief Memory pool descriptor. */ typedef struct { struct pool_header *mp_next; /**< @brief Pointer to the header. */ @@ -48,13 +50,13 @@ typedef struct { } MemoryPool; /** - * @brief Data part of a static memory pool initializer. + * @brief Data part of a static memory pool initializer. * @details This macro should be used when statically initializing a * memory pool that is part of a bigger structure. * - * @param[in] name the name of the memory pool variable - * @param[in] size size of the memory pool contained objects - * @param[in] provider memory provider function for the memory pool + * @param[in] name the name of the memory pool variable + * @param[in] size size of the memory pool contained objects + * @param[in] provider memory provider function for the memory pool */ #define _MEMORYPOOL_DATA(name, size, provider) \ {NULL, MEM_ALIGN_SIZE(size), provider} -- cgit v1.2.3