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

1 files changed, 16 insertions, 0 deletions

diff --git a/os/kernel/src/chmemcore.c b/os/kernel/src/chmemcore.c
index 435120a33..d0c657a48 100644
--- a/os/kernel/src/chmemcore.c
+++ b/os/kernel/src/chmemcore.c
@@ -22,6 +22,22 @@
  * @brief   Core memory manager code.

  *

  * @addtogroup memcore

+ * @details Core Memory Manager related APIs and services.

+ *          <h2>Operation mode</h2>

+ *          The core memory manager is a simplified allocator that only allows

+ *          to allocate memory blocks without the possibility to free them.<br>

+ *          This allocator is meant as a memory blocks provider for the other

+ *          allocators such as:

+ *          - C-Runtime allocator (through a compiler specific adapter module).

+ *          - Heap allocator (see @ref heaps).

+ *          - Memory pools allocator (see @ref pools).

+ *          .

+ *          By having a centralized memory provider the various allocators can

+ *          coexist and share the main memory.<br>

+ *          This allocator, alone, is also useful for very simple applications

+ *          that just require a simple way to get memory blocks.<br>

+ *          In order to use the core memory manager APIs the @p CH_USE_MEMCORE

+ *          option must be enabled in @p chconf.h.

  * @{

  */