Diff: Memory/InternalEEPROM.h

Revision:

17:4ea2509445ac

Parent:

0:6b68dac0d986

Child:

20:9df19da50290

--- a/Memory/InternalEEPROM.h	Fri Jan 02 14:17:03 2015 +0000
+++ b/Memory/InternalEEPROM.h	Wed Jan 07 14:02:39 2015 +0100
@@ -20,35 +20,7 @@
 #include "mbed.h"
 
 /**
- * Internal EEPROM Example
- *
- * @code
- * #include "mbed.h"
- * #include "InternalEEPROM.h"
- *
- * int main(void) {
- *    InternalEEPROM mem;
- *
- *    err = SPIFI::instance().init();
- *    if (err != SPIFI::Ok) {
- *        printf("Failed to initialize SPIFI, error %d\n", err);
- *    }
- *    
- *    // Write "Hello World!" into the first bytes of the SPIFI
- *    char buff[20] = "Hello World!";
- *    err = SPIFI::instance().program(0, strlen(buff)+1, buff, SPIFI::EraseAsRequired);
- *    if (err != SPIFI::Ok) {
- *        printf("Failed to write to SPIFI, error %d\n", err);
- *    }
- *
- *    // Now verify that it can be read
- *    if (memcmp((char*)SPIFI::SpifiMemBase, buff, strlen(buff)+1) == 0) {
- *        printf("Readback from memory OK: '%s'\n", SPIFI::SpifiMemBase);
- *    } else {
- *        printf("Spifi does not contain the correct data!\n");
- *    }
- * }
- * @endcode
+ * Internal EEPROM Driver
  */
 class InternalEEPROM {
 public:
@@ -62,7 +34,7 @@
     InternalEEPROM();
     ~InternalEEPROM();
 
-    /** Initializes the SPIFI ROM driver making the content of the external serial flash available
+    /** Initializes the EEPROM
      *
      *  @returns
      *       Ok on success