Diff: AvailableMemory.h

Revision:

12:3004855925ff

Parent:

11:0f5d5918761a

Child:

13:c8a20f79e011

--- a/AvailableMemory.h	Mon Nov 08 12:42:34 2010 +0000
+++ b/AvailableMemory.h	Mon Nov 08 12:47:36 2010 +0000
@@ -1,5 +1,5 @@
 /** @file
- * @brief Return the memory available for a malloc call
+ * Return the memory available for a malloc call.
  * This is done by a binary search approach
  * calling malloc/free starting with a maximum
  */
@@ -18,8 +18,8 @@
 /** Return the memory available for a malloc call
  * @param resolution Resolution in number of bytes,
  * 1 will return the exact value,
- * default is 256 which will return the available memory to the nearest 256 bytes
- * @param maximum Maximum amount of memory to check, default is 32K
+ * default will return the available memory to the nearest 256 bytes
+ * @param maximum Maximum amount of memory to check, default is 32K (0x8000)
  * @param disableInterrupts Disable interrupts whilst checking, default is true
  * @return Available memory in bytes accurate to within resolution
  */