Diff: AvailableMemory.h

Revision:

14:5d5fc6b4ed16

Parent:

13:c8a20f79e011

Child:

15:d00289c15c89

--- a/AvailableMemory.h	Mon Nov 08 13:03:46 2010 +0000
+++ b/AvailableMemory.h	Mon Nov 08 13:15:20 2010 +0000
@@ -1,7 +1,7 @@
 /** @file
  * Return the memory available for a malloc call.
  * This is done by a binary search approach
- * calling malloc/free starting with a maximum
+ * calling malloc/free starting with a maximum.
  */
 #ifndef SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
 #define SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
@@ -12,6 +12,10 @@
 namespace segundo {
 /**
  * A collection of utilities
+ */
+namespace Utilities {
+
+/** Return the memory available for a malloc call
  *
  * Example:
  * @code
@@ -24,12 +28,7 @@
  *     printf("Available memory (exact bytes) : %d\n", AvailableMemory(1));
  *
  * }
- * @endcode
- */
-namespace Utilities {
-
-/** Return the memory available for a malloc call
- * @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)