From ad3d21e81592481539a56e93234f5bf1fa2c0504 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Tue, 16 Mar 2010 19:36:21 +0000
Subject: Documentation reorganization. Moved the description from kernel.dox
 into the source code for ease of editing and reference.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1746 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/kernel/src/chmempools.c | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'os/kernel/src/chmempools.c')

diff --git a/os/kernel/src/chmempools.c b/os/kernel/src/chmempools.c
index f79e20353..31e4682fb 100644
--- a/os/kernel/src/chmempools.c
+++ b/os/kernel/src/chmempools.c
@@ -22,6 +22,13 @@
  * @brief   Memory Pools code.
  *
  * @addtogroup pools
+ * @details Memory Pools related APIs and services.
+ *          <h2>Operation mode</h2>
+ *          The Memory Pools APIs allow to allocate/free fixed size objects in
+ *          <b>constant time</b> and reliably without memory fragmentation
+ *          problems.<br>
+ *          In order to use the memory pools APIs the @p CH_USE_MEMPOOLS option
+ *          must be enabled in @p chconf.h.
  * @{
  */
 
-- 
cgit v1.2.3