Diff: AvailableMemory.h

Revision:

15:d00289c15c89

Parent:

14:5d5fc6b4ed16

--- a/AvailableMemory.h	Mon Nov 08 13:15:20 2010 +0000
+++ b/AvailableMemory.h	Mon Nov 08 13:21:36 2010 +0000
@@ -1,7 +1,5 @@
 /** @file
  * Return the memory available for a malloc call.
- * This is done by a binary search approach
- * calling malloc/free starting with a maximum.
  */
 #ifndef SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
 #define SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
@@ -15,7 +13,9 @@
  */
 namespace Utilities {
 
-/** 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.
  *
  * Example:
  * @code
@@ -28,7 +28,8 @@
  *     printf("Available memory (exact bytes) : %d\n", AvailableMemory(1));
  *
  * }
- * @endcode* @param resolution Resolution in number of bytes,
+ * @endcode
+ * @param resolution Resolution in number of bytes,
  * 1 will return the exact value,
  * default will return the available memory to the nearest 256 bytes
  * @param maximum Maximum amount of memory to check, default is 32K (0x8000)