diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-16 19:36:21 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-03-16 19:36:21 +0000 |
| commit | ad3d21e81592481539a56e93234f5bf1fa2c0504 (patch) | |
| tree | 0e78278235ac7c8324aa3c3a7e7b0193bbd30dc6 /os/kernel/src/chmempools.c | |
| parent | 0eed163a696d4b6daab19fd8daf05b980058f5f3 (diff) | |
| download | ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.tar.gz ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.tar.bz2 ChibiOS-ad3d21e81592481539a56e93234f5bf1fa2c0504.zip | |
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
Diffstat (limited to 'os/kernel/src/chmempools.c')
| -rw-r--r-- | os/kernel/src/chmempools.c | 7 |
1 files changed, 7 insertions, 0 deletions
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.
* @{
*/
|