Diff: AvailableMemory.h

Revision:

7:b4a90cb19332

Parent:

6:e94f3a11bad7

Child:

8:1d4f30a80292

--- a/AvailableMemory.h	Sun Nov 07 21:26:38 2010 +0000
+++ b/AvailableMemory.h	Sun Nov 07 21:31:21 2010 +0000
@@ -4,33 +4,17 @@
 #ifndef SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
 #define SEGUNDO_UTILITIES_AVAILABLEMEMORY_H
 
-/** @fn const char *Test::member(char c,int n)
- *  @brief A member function.
- *  @param c a character.
- *  @param n an integer.
- *  @exception std::out_of_range parameter is out of range.
- *  @return a character pointer.
- */
-
-///Ethernet network interface return codes
-enum EthernetErr {
-    __ETH_MIN = -0xFFFF,
-    ETH_TIMEOUT, ///<Timeout during setup
-    ETH_OK = 0 ///<Success
-};
-
 namespace segundo {
 namespace Utilities {
 
-/** Return the available memory for a malloc call (to the nearest 256 bytes)
+/** Return the available memory for a malloc call
  */
 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.
+ * @param resolution Resolution in number of bytes
+ * @param maximum Maximum amount of memory to check
+ * @param disableInterrupts Disable interrupts whilst checking
  */
 int AvailableMemory(int resolution, int maximum, bool disableInterrupts);