From 15ee17c8740a378cffcae681421b9e28fcde3d4c Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Sat, 6 Sep 2008 08:56:34 +0000
Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@426
 35acf78f-673a-0410-8e92-d51de3d6d3f4

---
 src/chheap.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'src/chheap.c')

diff --git a/src/chheap.c b/src/chheap.c
index ecdf7284a..e8ce605c7 100644
--- a/src/chheap.c
+++ b/src/chheap.c
@@ -185,11 +185,13 @@ void chHeapFree(void *p) {
 
 /**
  * Determines the heap status.
- * @sizep pointer to a variable that will receive the total fragmented free
- *        space
+ * @param sizep pointer to a variable that will receive the total fragmented
+ *              free space
  * @return the number of fragments in the heap
  * @note This function is meant to be used in the test suite, it should not be
  *       really useful for the application code.
+ * @note This function is not implemented when the \p CH_USE_MALLOC_HEAP
+ *       configuration option is used (it always returns zero).
  */
 size_t chHeapStatus(size_t *sizep) {
   struct header *qp;
-- 
cgit v1.2.3