alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

spi_flash: state that esp_partition_iterator_release allows NULL arg

Browse Source 
The implementation allows passing the NULL argument, and the function
is used in the examples accordingly. Fix the discrepancy in the
doxygen comment.

Closes https://github.com/espressif/esp-idf/issues/7545
This commit is contained in:
Ivan Grokhotkov 2021-09-10 20:55:01 +02:00
parent 59f6087b55
commit f94035ad85
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/spi_flash/include/esp_partition.h
View File

@ -181,7 +181,9 @@ esp_partition_iterator_t esp_partition_next(esp_partition_iterator_t iterator);
/**
* @brief Release partition iterator
*
* @param iterator Iterator obtained using esp_partition_find. Must be non-NULL.
* @param iterator Iterator obtained using esp_partition_find.
* The iterator is allowed to be NULL, so it is not necessary to check its value
* before calling this function.
*
*/
void esp_partition_iterator_release(esp_partition_iterator_t iterator);