1 files changed, 10 insertions, 10 deletions

diff --git a/os/kernel/src/chheap.c b/os/kernel/src/chheap.c
index 820f15362..fc92e3c18 100644
--- a/os/kernel/src/chheap.c
+++ b/os/kernel/src/chheap.c
@@ -31,22 +31,22 @@
  *          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

+ *          allocator.

+ * @pre     In order to use the heap APIs the @p CH_USE_HEAP option must

  *          be enabled in @p chconf.h.

  * @{

  */

 

 #include "ch.h"

 

-#if CH_USE_HEAP

+#if CH_USE_HEAP || defined(__DOXYGEN__)

 

-#if !CH_USE_MALLOC_HEAP

+#if !CH_USE_MALLOC_HEAP || defined(__DOXYGEN__)

 

 /*

  * Defaults on the best synchronization mechanism available.

  */

-#if CH_USE_MUTEXES

+#if CH_USE_MUTEXES || defined(__DOXYGEN__)

 #define H_LOCK(h)       chMtxLock(&(h)->h_mtx)

 #define H_UNLOCK(h)     chMtxUnlock()

 #else

@@ -67,7 +67,7 @@ void heap_init(void) {
   default_heap.h_provider = chCoreAlloc;

   default_heap.h_free.h.u.next = (union heap_header *)NULL;

   default_heap.h_free.h.size = 0;

-#if CH_USE_MUTEXES

+#if CH_USE_MUTEXES || defined(__DOXYGEN__)

   chMtxInit(&default_heap.h_mtx);

 #else

   chSemInit(&default_heap.h_sem, 1);

@@ -76,8 +76,8 @@ void heap_init(void) {
 

 /**

  * @brief   Initializes a memory heap from a static memory area.

- * @note    Both the heap buffer base and the heap size must be aligned to

- *          the @p align_t type size.

+ * @pre     Both the heap buffer base and the heap size must be aligned to

+ *          the @p stkalign_t type size.

  *

  * @param[out] heapp    pointer to the memory heap descriptor to be initialized

  * @param[in] buf       heap buffer base

@@ -93,7 +93,7 @@ void chHeapInit(MemoryHeap *heapp, void *buf, size_t size) {
   heapp->h_free.h.size = 0;

   hp->h.u.next = NULL;

   hp->h.size = size - sizeof(union heap_header);

-#if CH_USE_MUTEXES

+#if CH_USE_MUTEXES || defined(__DOXYGEN__)

   chMtxInit(&heapp->h_mtx);

 #else

   chSemInit(&heapp->h_sem, 1);

@@ -104,7 +104,7 @@ void chHeapInit(MemoryHeap *heapp, void *buf, size_t size) {
  * @brief   Allocates a block of memory from the heap by using the first-fit

  *          algorithm.

  * @details The allocated block is guaranteed to be properly aligned for a

- *          pointer data type (@p align_t).

+ *          pointer data type (@p stkalign_t).

  *

  * @param[in] heapp     pointer to a heap descriptor or @p NULL in order to

  *                      access the default heap.