Skip to content

Commit c45f874

Browse files
committed
Update flag parameter docs in KVStore classes
1 parent 70b7ba7 commit c45f874

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

features/storage/kvstore/filesystemstore/FileSystemStore.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ class FileSystemStore : public KVStore {
5050
* if it doesn't exist, creating it by default. If other init modes are desired,
5151
* set the flags as necessary.
5252
*
53-
* @param[in] no_overwrite If no valid FileSystemStore is found, do not create one.
53+
* @param[in] flags Flags that determine how the FileSystemStore allows KV
54+
* read/write and store creation.
5455
*
5556
* @returns MBED_SUCCESS Success.
5657
* MBED_ERROR_INITIALIZATION_FAILED No valid FileSystemStore found on the device.

features/storage/kvstore/include/KVStore.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ class KVStore {
7474
* erasing if necessary. If this is undesired, set the no_overwrite parameter
7575
* to true.
7676
*
77-
* @param[in] no_overwrite If true, KVStore will not modify the underlying storage.
77+
* @param[in] flags Flags that determine how the FileSystemStore allows KV
78+
* read/write and store creation.
79+
*
7880
*
7981
* @returns MBED_ERROR_INITIALIZATION_FAILED No valid KVStore in the storage.
8082
* MBED_SUCCESS on success or an error code on other failure

features/storage/kvstore/securestore/SecureStore.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ class SecureStore : public KVStore {
7474
* @brief Initialize SecureStore class. It will also initialize
7575
* the underlying KVStore and the rollback protection KVStore by default.
7676
* If other init modes are needed, set the flags as necessary.
77+
*
78+
* @param[in] flags Flags that determine how the FileSystemStore allows KV
79+
* read/write and store creation.
7780
*
7881
* @returns MBED_SUCCESS Success.
7982
* or any other error from underlying KVStore instances.

features/storage/kvstore/tdbstore/TDBStore.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ class TDBStore : public KVStore {
6363
* is not valid, TBDStore will overwrite the data by default. If other init modes are
6464
* desired, set the flags as necessary.
6565
*
66-
* @param[in] flags The read/write and initiazation mode of the TBDStore.
66+
* @param[in] flags Flags that determine how the FileSystemStore allows KV
67+
* read/write and store creation.
6768
*
6869
* @returns MBED_SUCCESS Success.
6970
* MBED_ERROR_INITIALIZATION_FAILED No valid TBD store found in the BlockDevice.

0 commit comments

Comments
 (0)