Documentation improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@830 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 9 insertions, 10 deletions

diff --git a/src/chmempools.c b/src/chmempools.c
index 7d3a162bb..dd6f3d1ba 100644
--- a/src/chmempools.c
+++ b/src/chmempools.c
@@ -27,12 +27,12 @@
 #include <ch.h>

 

 #if CH_USE_MEMPOOLS

-

 /**

  * @brief Initializes an empty memory pool.

  *

- * @param mp pointer to a @p MemoryPool structure

- * @param size the size of the objects contained in this memory pool

+ * @param[out] mp pointer to a @p MemoryPool structure

+ * @param[in] size the size of the objects contained in this memory pool,

+ *                 the minimum accepted size is the size of a pointer to void

  */

 void chPoolInit(MemoryPool *mp, size_t size) {

 

@@ -45,7 +45,7 @@ void chPoolInit(MemoryPool *mp, size_t size) {
 /**

  * @brief Allocates an object from a memory pool.

  *

- * @param mp pointer to a @p MemoryPool structure

+ * @param[in] mp pointer to a @p MemoryPool structure

  * @return The pointer to the allocated object.

  * @retval NULL if pool is empty.

  */

@@ -63,7 +63,7 @@ void *chPoolAllocI(MemoryPool *mp) {
 /**

  * @brief Allocates an object from a memory pool.

  *

- * @param mp pointer to a @p MemoryPool structure

+ * @param[in] mp pointer to a @p MemoryPool structure

  * @return The pointer to the allocated object.

  * @retval NULL if pool is empty.

  */

@@ -79,8 +79,8 @@ void *chPoolAlloc(MemoryPool *mp) {
 /**

  * @brief Releases (or adds) an object into (to) a memory pool.

  *

- * @param mp pointer to a @p MemoryPool structure

- * @param objp the pointer to the object to be released or added

+ * @param[in] mp pointer to a @p MemoryPool structure

+ * @param[in] objp the pointer to the object to be released or added

  * @note the object is assumed to be of the right size for the specified

  *       memory pool.

  */

@@ -96,8 +96,8 @@ void chPoolFreeI(MemoryPool *mp, void *objp) {
 /**

  * @brief Releases (or adds) an object into (to) a memory pool.

  *

- * @param mp pointer to a @p MemoryPool structure

- * @param objp the pointer to the object to be released or added

+ * @param[in] mp pointer to a @p MemoryPool structure

+ * @param[in] objp the pointer to the object to be released or added

  * @note the object is assumed to be of the right size for the specified

  *       memory pool.

  */

@@ -107,7 +107,6 @@ void chPoolFree(MemoryPool *mp, void *objp) {
   chPoolFreeI(mp, objp);

   chSysUnlock();

 }

-

 #endif /* CH_USE_MEMPOOLS */

 

 /** @} */