spi_flash: state that esp_partition_iterator_release allows NULL arg

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
pull/7680/head
Ivan Grokhotkov 2021-09-10 20:55:01 +02:00
rodzic 59f6087b55
commit f94035ad85
1 zmienionych plików z 3 dodań i 1 usunięć

Wyświetl plik

@ -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);