Documentation improvements, renamed some event APIs.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2179 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 3 insertions, 4 deletions

diff --git a/os/kernel/src/chmemcore.c b/os/kernel/src/chmemcore.c
index f835e2111..04edb7dae 100644
--- a/os/kernel/src/chmemcore.c
+++ b/os/kernel/src/chmemcore.c
@@ -35,15 +35,15 @@
  *          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

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

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

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

  * @{

  */

 

 #include "ch.h"

 

-#if CH_USE_MEMCORE

+#if CH_USE_MEMCORE || defined(__DOXYGEN__)

 

 static uint8_t *nextmem;

 static uint8_t *endmem;

@@ -73,7 +73,6 @@ void core_init(void) {
  *          type @p stkalign_t so it is not possible to allocate less

  *          than <code>sizeof(stkalign_t)</code>.

  *

- *

  * @param[in] size      the size of the block to be allocated

  * @return              A pointer to the allocated memory block.

  * @retval NULL         allocation failed, core memory exhausted.