Diff: eeprom.h

Revision:

2:79ed7ff7c23d

Parent:

1:a262173cac81

Child:

3:925096a4c7f0

--- a/eeprom.h	Wed Dec 11 23:13:19 2013 +0000
+++ b/eeprom.h	Mon Nov 02 23:20:56 2015 +0000
@@ -3,6 +3,10 @@
 
 /***********************************************************
 Author: Bernard Borredon
+Date : 12 decembre 2013
+Version: 1.2
+  - Update api documentation
+  
 Date: 11 december 2013
 Version: 1.1
   - Change address parameter size form uint16_t to uint32_t (error for eeprom > 24C256).
@@ -335,162 +339,162 @@
                      T24C32=4096,T24C64=8192,T24C128=16384,T24C256=32768,
                      T24C512=65536,T24C1024=131072,T24C1025=131073} Type;
                                          
-    /*
+    /**
      * Constructor, initialize the eeprom on i2c interface.
      * @param sda : sda i2c pin (PinName)
      * @param scl : scl i2c pin (PinName)
      * @param address : eeprom address, according to eeprom type (uint8_t)
      * @param type : eeprom type (TypeEeprom) 
-     * @return none
+     * @return : none
     */
     EEPROM(PinName sda, PinName scl, uint8_t address, TypeEeprom type);
     
-    /*
+    /**
      * Random read byte
      * @param address : start address (uint32_t)
      * @param data : byte to read (int8_t&)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, int8_t& data);
     
-    /*
+    /**
      * Random read short
      * @param address : start address (uint32_t)
      * @param data : short to read (int16_t&)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, int16_t& data);
     
-    /*
+    /**
      * Random read long
      * @param address : start address (uint32_t)
      * @param data : long to read (int32_t&)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, int32_t& data);
     
-    /*
+    /**
      * Random read float
      * @param address : start address (uint32_t)
      * @param data : float to read (float&)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, float& data);
     
-    /*
+    /**
      * Random read anything
      * @param address : start address (uint32_t)
      * @param data : data to read (void *)
      * @param size : number of bytes to read (uint32_t)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, void *data, uint32_t size);
     
-    /*
+    /**
      * Current address read byte
      * @param data : byte to read (int8_t&)
-     * @return none
+     * @return : none
     */
     void read(int8_t& data);
     
-    /*
+    /**
      * Sequential read byte
      * @param address : start address (uint32_t)
      * @param data : bytes array to read (int8_t[]&)
      * @param size : number of bytes to read (uint32_t)
-     * @return none
+     * @return : none
     */
     void read(uint32_t address, int8_t *data, uint32_t size);
     
-    /*
+    /**
      * Write byte
      * @param address : start address (uint32_t)
      * @param data : byte to write (int8_t)
-     * @return none
+     * @return : none
     */
     void write(uint32_t address, int8_t data);
     
-    /*
+    /**
      * Write short
      * @param address : start address (uint32_t)
      * @param data : short to write (int16_t)
-     * @return none
+     * @return : none
     */
     void write(uint32_t address, int16_t data);
     
-    /*
+    /**
      * Write long
      * @param address : start address (uint32_t)
      * @param data : long to write (int32_t)
-     * @return none
+     * @return : none
     */
     void write(uint32_t address, int32_t data);
     
-    /*
+    /**
      * Write float
      * @param address : start address (uint32_t)
      * @param data : float to write (float)
-     * @return error number if > 0 (uint8_t)
+     * @return : none
     */
     void write(uint32_t address, float data);
     
-    /*
+    /**
      * Write anything (use the page write mode)
      * @param address : start address (uint32_t)
      * @param data : data to write (void *)
      * @param size : number of bytes to write (uint32_t)
-     * @return none
+     * @return : none
     */
     void write(uint32_t address, void *data, uint32_t size);
     
-    /*
+    /**
      * Write array of bytes (use the page mode)
      * @param address : start address (uint32_t)
      * @param data : bytes array to write (int8_t[])
      * @param size : number of bytes to write (uint32_t)
-     * @return none
+     * @return : none
     */
     void write(uint32_t address, int8_t data[], uint32_t size);
     
-    /*
+    /**
      * Wait eeprom ready
      * @param : none
-     * @return none
+     * @return : none
     */
     void ready(void);
     
-    /*
+    /**
      * Get eeprom size in bytes
      * @param : none
-     * @return size in bytes (uint32_t)
+     * @return : size in bytes (uint32_t)
     */
     uint32_t getSize(void);
         
-        /*
+    /**
      * Get eeprom name
      * @param : none
-     * @return name (const char*)
+     * @return : name (const char*)
     */
     const char* getName(void);
     
-    /*
+    /**
      * Clear eeprom (write with 0)
      * @param  : none
-     * @return current error number (uint8_t)
+     * @return : none
     */
     void clear(void);
     
-     /*
+     /**
      * Get the current error number (EEPROM_NoError if no error)
      * @param  : none
-     * @return none
+     * @return : current error number (uint8_t)
     */
     uint8_t getError(void);
     
-    /*
+    /**
      * Get current error message
      * @param  : none
-     * @return current error message(std::string)
+     * @return : current error message(std::string)
     */
     std::string getErrorMessage(void)
     {