mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Diff: hal/flash_api.h

Revision:
174:b96e65c34a4d
Parent:
172:7d866c31b3c5
Child:
189:f392fc9709a3
--- a/hal/flash_api.h	Fri Sep 15 14:59:18 2017 +0100
+++ b/hal/flash_api.h	Mon Oct 02 15:33:19 2017 +0100
@@ -75,9 +75,9 @@
  */
 int32_t flash_read(flash_t *obj, uint32_t address, uint8_t *data, uint32_t size);
 
-/** Program one page starting at defined address
+/** Program pages starting at defined address
  *
- * The page should be at page boundary, should not cross multiple sectors.
+ * The pages should not cross multiple sectors.
  * This function does not do any check for address alignments or if size is aligned to a page size.
  * @param obj The flash object
  * @param address The sector starting address
@@ -97,6 +97,7 @@
 
 /** Get page size
  *
+ * The page size defines the writable page size
  * @param obj The flash object
  * @return The size of a page
  */