Segundo Equipo / AvailableMemory

Function to calculate the memory available for malloc

Dependents:   AvailableMemory_HelloWorld MCBBThermostat helloaabbc SP14P1_skeleton

Diff: AvailableMemory.h

Revision:
1:d8432d8a5b6d
Parent:
0:a98bf0c96bf1
Child:
2:5dd69c9259a0
--- a/AvailableMemory.h	Sun Nov 07 19:11:52 2010 +0000
+++ b/AvailableMemory.h	Sun Nov 07 19:22:33 2010 +0000
@@ -4,7 +4,16 @@
 namespace segundo {
 namespace Utilities {
 
+/** Return the available memory for a malloc call (to the nearest 256 bytes)
+ */
 int AvailableMemory();
+
+/** Return the available memory for a malloc call
+ *
+ * @param resolution A normalised number 0.0-1.0 to represent the full range.
+ * @param maximum A normalised number 0.0-1.0 to represent the full range.
+ * @param disableInterrupts A normalised number 0.0-1.0 to represent the full range.
+ */
 int AvailableMemory(int resolution, int maximum, bool disableInterrupts);
 
 } // namespace Utilities