kopia lustrzana https://github.com/espressif/esp-idf
components/nvs: fix broken sentences in comment blocks
rodzic
1c7508885c
commit
6f2ed934d2
|
@ -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
|
||||
* 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
|
||||
* opened with read_only set to true, nvs_set_X functions will
|
||||
* fail with ESP_ERR_NVS_READONLY.
|
||||
* @param[in] handle Handle obtained from nvs_open function.
|
||||
* Handles that were opened read only cannot be used.
|
||||
* @param[in] key Key name. Maximal length is determined by the underlying
|
||||
* implementation, but is guaranteed to be at least
|
||||
* 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.
|
||||
*
|
||||
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be
|
||||
* opened as not read only for this call to succeed.
|
||||
* @param[in] handle Storage handle obtained with nvs_open.
|
||||
* Handles that were opened read only cannot be used.
|
||||
*
|
||||
* @param[in] key Key name. Maximal length is determined by the underlying
|
||||
* 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.
|
||||
*
|
||||
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be
|
||||
* opened as not read only for this call to succeed.
|
||||
* @param[in] handle Storage handle obtained with nvs_open.
|
||||
* Handles that were opened read only cannot be used.
|
||||
*
|
||||
* @return - ESP_OK if erase operation was successful
|
||||
* - 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,
|
||||
* but this is not guaranteed.
|
||||
*
|
||||
* @param[in] handle Storage handle obtained with nvs_open. If handle has to be
|
||||
* opened as not read only for this call to succeed.
|
||||
* @param[in] handle Storage handle obtained with nvs_open.
|
||||
* Handles that were opened read only cannot be used.
|
||||
*
|
||||
* @return - ESP_OK if the changes have been written successfully
|
||||
* - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL
|
||||
|
|
Ładowanie…
Reference in New Issue