Segundo Equipo / AvailableMemory

Function to calculate the memory available for malloc

Dependents:   AvailableMemory_HelloWorld MCBBThermostat helloaabbc SP14P1_skeleton

Files at this revision

API Documentation at this revision

Revision 13:c8a20f79e011, committed 2010-11-08

Comitter:
segundo
Date:
Mon Nov 08 13:03:46 2010 +0000
Parent:
12:3004855925ff
Child:
14:5d5fc6b4ed16
Commit message:

Changed in this revision

AvailableMemory.h Show annotated file Show diff for this revision Revisions of this file 
--- a/AvailableMemory.h	Mon Nov 08 12:47:36 2010 +0000
+++ b/AvailableMemory.h	Mon Nov 08 13:03:46 2010 +0000
@@ -12,6 +12,19 @@
 namespace segundo {
 /**
  * A collection of utilities
+ *
+ * Example:
+ * @code
+ * #include <stdio.h>
+ * #include "AvailableMemory.h"
+ *
+ * int main() {
+ *
+ *     printf("Available memory (bytes to nearest 256) : %d\n", AvailableMemory());
+ *     printf("Available memory (exact bytes) : %d\n", AvailableMemory(1));
+ *
+ * }
+ * @endcode
  */
 namespace Utilities {