diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2008-08-29 08:31:33 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2008-08-29 08:31:33 +0000 |
| commit | ff6163a0494434bb73926b42cfdc9681313fc662 (patch) | |
| tree | 56c35f5284f227043bed10cb2f490f24f05572fa /docs | |
| parent | 7ffd1d5e5b41393b518ad0a3b6e94056d9044e26 (diff) | |
| download | ChibiOS-ff6163a0494434bb73926b42cfdc9681313fc662.tar.gz ChibiOS-ff6163a0494434bb73926b42cfdc9681313fc662.tar.bz2 ChibiOS-ff6163a0494434bb73926b42cfdc9681313fc662.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@414 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Doxyfile | 2 | ||||
| -rw-r--r-- | docs/ch.txt | 32 |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 7f4432c52..4df239ac5 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -255,6 +255,8 @@ PREDEFINED = __JUST_STUBS__ \ CH_USE_QUEUES_HALFDUPLEX \ CH_USE_SERIAL_FULLDUPLEX \ CH_USE_SERIAL_HALFDUPLEX \ + CH_USE_HEAP \ + CH_USE_MEMPOOLS \ CH_USE_MESSAGES \ CH_USE_MESSAGES_EVENT \ CH_USE_MESSAGES_PRIORITY \ diff --git a/docs/ch.txt b/docs/ch.txt index a88291bb2..307dc6765 100644 --- a/docs/ch.txt +++ b/docs/ch.txt @@ -345,6 +345,38 @@ /** @} */
/**
+ * @defgroup Heap Heap
+ * @{
+ * Heap Allocator related APIs.
+ * <b>Operation mode</b><br><br>
+ * The heap allocator implements a first-fit strategy and its APIs are
+ * functionally equivalent to the usual \p malloc() and \p free(). The main
+ * difference is that the heap APIs are thread safe.<br>
+ * By enabling the \p CH_USE_MALLOC_HEAP option the heap manager will use the
+ * runtime-provided \p malloc() and \p free() as backend for the heap APIs
+ * instead of the system provided allocator.<br>
+ * In order to use the heap APIs the \p CH_USE_HEAP option must be specified
+ * in \p chconf.h.
+ * @file include/heap.h Heap macros and structures.
+ * @file chheap.c Heap functions.
+ */
+/** @} */
+
+/**
+ * @defgroup MemoryPools Memory Pools
+ * @{
+ * Memory Pools related APIs.
+ * <b>Operation mode</b><br><br>
+ * 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 Time APIs the \p CH_USE_MEMPOOLS option must be
+ * specified in \p chconf.h.
+ * @file include/mempools.h Memory Pools macros and structures.
+ * @file chmempools.c Memory Pools functions.
+ */
+/** @} */
+
+/**
* @defgroup Semaphores Semaphores
* @{
* Semaphores and threads synchronization.
|