Merge branch 'doc/esp_partition_documentation' into 'master'

krzychb · krzychb · commit dc73031f7f3c · 2020-12-11T16:36:44.000+08:00
SPI Flash: fix doc error in esp_partition.h

See merge request espressif/esp-idf!10506
diff --git a/components/spi_flash/include/esp_partition.h b/components/spi_flash/include/esp_partition.h
@@ -256,9 +256,9 @@ esp_err_t esp_partition_write(const esp_partition_t* partition,
                               size_t dst_offset, const void* src, size_t size);
 
 /**
- * @brief Read data from the partition
+ * @brief Read data from the partition without any transformation/decryption.
  *
- * @note This function is essentially the same as \c esp_partition_write() above.
+ * @note This function is essentially the same as \c esp_partition_read() above.
  *       It just never decrypts data but returns it as is.
  *
  * @param partition Pointer to partition structure obtained using

Original file line number	Diff line number	Diff line change
`@@ -256,9 +256,9 @@ esp_err_t esp_partition_write(const esp_partition_t* partition,`
`256`	`256`	`size_t dst_offset, const void* src, size_t size);`
`257`	`257`
`258`	`258`	`/**`
`259`		`- * @brief Read data from the partition`
	`259`	`+ * @brief Read data from the partition without any transformation/decryption.`
`260`	`260`	`*`
`261`		`- * @note This function is essentially the same as \c esp_partition_write() above.`
	`261`	`+ * @note This function is essentially the same as \c esp_partition_read() above.`
`262`	`262`	`* It just never decrypts data but returns it as is.`
`263`	`263`	`*`
`264`	`264`	`* @param partition Pointer to partition structure obtained using`