mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

components/nvs: fix broken sentences in comment blocks

pull/37/head
Ivan Grokhotkov 2016-09-26 12:41:04 +08:00
rodzic 1c7508885c
commit 6f2ed934d2
1 zmienionych plików z 8 dodań i 9 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

17
components/nvs_flash/include/nvs.h
Wyświetl plik

@ -78,9 +78,8 @@ esp_err_t nvs_open(const char* name, nvs_open_mode open_mode, nvs_handle *out_ha
* This family of functions set value for the key, given its name. Note that * This family of functions set value for the key, given its name. Note that
* actual storage will not be updated until nvs_commit function is called. * actual storage will not be updated until nvs_commit function is called.
* *
* @param[in] handle Handle obtained from nvs_open function. If the handle was * @param[in] handle Handle obtained from nvs_open function.
* opened with read_only set to true, nvs_set_X functions will * Handles that were opened read only cannot be used.
* fail with ESP_ERR_NVS_READONLY.
* @param[in] key Key name. Maximal length is determined by the underlying * @param[in] key Key name. Maximal length is determined by the underlying
* implementation, but is guaranteed to be at least * implementation, but is guaranteed to be at least
* 16 characters. Shouldn't be empty. * 16 characters. Shouldn't be empty.
@ -185,8 +184,8 @@ esp_err_t nvs_get_blob(nvs_handle handle, const char* key, void* out_value, size
* *
* Note that actual storage may not be updated until nvs_commit function is called. * Note that actual storage may not be updated until nvs_commit function is called.
* *
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be * @param[in] handle Storage handle obtained with nvs_open.
* opened as not read only for this call to succeed. * Handles that were opened read only cannot be used.
* *
* @param[in] key Key name. Maximal length is determined by the underlying * @param[in] key Key name. Maximal length is determined by the underlying
* implementation, but is guaranteed to be at least * implementation, but is guaranteed to be at least
@ -205,8 +204,8 @@ esp_err_t nvs_erase_key(nvs_handle handle, const char* key);
* *
* Note that actual storage may not be updated until nvs_commit function is called. * Note that actual storage may not be updated until nvs_commit function is called.
* *
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be * @param[in] handle Storage handle obtained with nvs_open.
* opened as not read only for this call to succeed. * Handles that were opened read only cannot be used.
* *
* @return - ESP_OK if erase operation was successful * @return - ESP_OK if erase operation was successful
* - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL * - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL
@ -222,8 +221,8 @@ esp_err_t nvs_erase_all(nvs_handle handle);
* to non-volatile storage. Individual implementations may write to storage at other times, * to non-volatile storage. Individual implementations may write to storage at other times,
* but this is not guaranteed. * but this is not guaranteed.
* *
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be * @param[in] handle Storage handle obtained with nvs_open.
* opened as not read only for this call to succeed. * Handles that were opened read only cannot be used.
* *
* @return - ESP_OK if the changes have been written successfully * @return - ESP_OK if the changes have been written successfully
* - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL * - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL