spi_flash: update comment blocks

diff --git a/components/spi_flash/include/esp_partition.h b/components/spi_flash/include/esp_partition.h
index e2f289eb73380508424be677e12ef9b87a635f6b..ae0185dcd7108efc62964f917c28ef95f6e813c0 100644 (file)
--- a/components/spi_flash/include/esp_partition.h
+++ b/components/spi_flash/include/esp_partition.h
@@ -82,9 +82,9 @@ typedef struct {
  * @brief Find partition based on one or more parameters
  *
  * @param type Partition type, one of esp_partition_type_t values
- * @param subtype Partition subtype, of esp_partition_subtype_t values.
- *             To find all partitions of given type, use
- *             ESP_PARTITION_SUBTYPE_ANY.
+ * @param subtype Partition subtype, one of esp_partition_subtype_t values.
+ *                To find all partitions of given type, use
+ *                ESP_PARTITION_SUBTYPE_ANY.
  * @param label (optional) Partition label. Set this value if looking
  *             for partition with a specific name. Pass NULL otherwise.
  *
@@ -99,13 +99,13 @@ esp_partition_iterator_t esp_partition_find(esp_partition_type_t type, esp_parti
  * @brief Find first partition based on one or more parameters
  *
  * @param type Partition type, one of esp_partition_type_t values
- * @param subtype Partition subtype, of esp_partition_subtype_t values.
- *             To find all partitions of given type, use
- *             ESP_PARTITION_SUBTYPE_ANY.
+ * @param subtype Partition subtype, one of esp_partition_subtype_t values.
+ *                To find all partitions of given type, use
+ *                ESP_PARTITION_SUBTYPE_ANY.
  * @param label (optional) Partition label. Set this value if looking
  *             for partition with a specific name. Pass NULL otherwise.
  *
- * @return pointer to esp_partition_t structure, or NULL if no parition is found.
+ * @return pointer to esp_partition_t structure, or NULL if no partition is found.
  *         This pointer is valid for the lifetime of the application.
  */
 const esp_partition_t* esp_partition_find_first(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);
@@ -134,9 +134,6 @@ esp_partition_iterator_t esp_partition_next(esp_partition_iterator_t iterator);
 /**
  * @brief Release partition iterator
  *
- * Any pointers obtained using esp_partition_label function will be invalid
- * after this call.
- *
  * @param iterator Iterator obtained using esp_partition_find. Must be non-NULL.
  *
  */
@@ -155,7 +152,7 @@ void esp_partition_iterator_release(esp_partition_iterator_t iterator);
  * @param size Size of data to be read, in bytes.
  *
  * @return ESP_OK, if data was read successfully;
- *         ESP_ERR_INVALID_ARG, if iterator or src are NULL;
+ *         ESP_ERR_INVALID_ARG, if src_offset exceeds partition size;
  *         ESP_ERR_INVALID_SIZE, if read would go out of bounds of the partition;
  *         or one of error codes from lower-level flash driver.
  */
@@ -181,7 +178,7 @@ esp_err_t esp_partition_read(const esp_partition_t* partition,
  *       esp_partition_erase_range call.
  *
  * @return ESP_OK, if data was written successfully;
- *         ESP_ERR_INVALID_ARG, if iterator or dst are NULL;
+ *         ESP_ERR_INVALID_ARG, if dst_offset exceeds partition size;
  *         ESP_ERR_INVALID_SIZE, if write would go out of bounds of the partition;
  *         or one of error codes from lower-level flash driver.
  */

diff --git a/components/spi_flash/include/esp_spi_flash.h b/components/spi_flash/include/esp_spi_flash.h
index df0a8decce92afeda0dc41975ae80d3404b2f2ad..c65eaa58368f452b15794b4779f47bf2c37269a7 100644 (file)
--- a/components/spi_flash/include/esp_spi_flash.h
+++ b/components/spi_flash/include/esp_spi_flash.h
@@ -77,8 +77,8 @@ esp_err_t spi_flash_erase_range(size_t start_addr, size_t size);
  * @note Both des_addr and src_addr have to be 4-byte aligned.
  *       This is a temporary limitation which will be removed.
  *
- * @param  des_addr  destination address in Flash
- * @param  src_addr  source address of the data
+ * @param  dest  destination address in Flash
+ * @param  src   pointer to the source buffer
  * @param  size  length of data, in bytes
  *
  * @return esp_err_t
@@ -91,8 +91,8 @@ esp_err_t spi_flash_write(size_t dest, const void *src, size_t size);
  * @note Both des_addr and src_addr have to be 4-byte aligned.
  *       This is a temporary limitation which will be removed.
  *
- * @param  src_addr  source address of the data in Flash.
- * @param  des_addr  destination address
+ * @param  src   source address of the data in Flash.
+ * @param  dest  pointer to the destination buffer
  * @param  size  length of data
  *
  * @return esp_err_t