Quellcode durchsuchen

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
Ivan Grokhotkov vor 4 Jahren
Ursprung
Commit
f94035ad85
1 geänderte Dateien mit 3 neuen und 1 gelöschten Zeilen
  1. 3 1
      components/spi_flash/include/esp_partition.h

+ 3 - 1
components/spi_flash/include/esp_partition.h

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