Update flag parameter docs in KVStore classes

pea-pod · pea-pod · commit 7b6acc65818f · 2020-04-04T15:53:01.000-05:00
diff --git a/features/storage/kvstore/filesystemstore/FileSystemStore.h b/features/storage/kvstore/filesystemstore/FileSystemStore.h
@@ -50,7 +50,8 @@ class FileSystemStore : public KVStore {
       *        if it doesn't exist, creating it by default. If other init modes are desired,
       *        set the flags as necessary.
       *
-      * @param[in]  no_overwrite    If no valid FileSystemStore is found, do not create one.
+      * @param[in]  flags                            Flags that determine how the FileSystemStore allows KV
+      *                                              read/write and store creation.
       * 
       * @returns MBED_SUCCESS                        Success.
       *          MBED_ERROR_INITIALIZATION_FAILED    No valid FileSystemStore found on the device. 
diff --git a/features/storage/kvstore/include/KVStore.h b/features/storage/kvstore/include/KVStore.h
@@ -74,7 +74,9 @@ class KVStore {
      *  erasing if necessary. If this is undesired, set the no_overwrite parameter
      *  to true.
      *
-     * @param[in]   no_overwrite    If true, KVStore will not modify the underlying storage.
+     * @param[in]  flags                            Flags that determine how the FileSystemStore allows KV
+     *                                              read/write and store creation.
+     * 
      * 
      * @returns MBED_ERROR_INITIALIZATION_FAILED    No valid KVStore in the storage.
      *          MBED_SUCCESS on success or an error code on other failure
diff --git a/features/storage/kvstore/securestore/SecureStore.h b/features/storage/kvstore/securestore/SecureStore.h
@@ -74,6 +74,9 @@ class SecureStore : public KVStore {
      * @brief Initialize SecureStore class. It will also initialize
      *        the underlying KVStore and the rollback protection KVStore by default.
      *        If other init modes are needed, set the flags as necessary.
+     * 
+     * @param[in]  flags                            Flags that determine how the FileSystemStore allows KV
+     *                                              read/write and store creation.
      *
      * @returns MBED_SUCCESS                        Success.
      *          or any other error from underlying KVStore instances.
diff --git a/features/storage/kvstore/tdbstore/TDBStore.h b/features/storage/kvstore/tdbstore/TDBStore.h
@@ -63,7 +63,8 @@ class TDBStore : public KVStore {
      *        is not valid, TBDStore will overwrite the data by default. If other init modes are
      *        desired, set the flags as necessary.
      *
-     * @param[in]  flags                            The read/write and initiazation mode of the TBDStore.
+     * @param[in]  flags                            Flags that determine how the FileSystemStore allows KV
+     *                                              read/write and store creation.
      * 
      * @returns MBED_SUCCESS                        Success.
      *          MBED_ERROR_INITIALIZATION_FAILED    No valid TBD store found in the BlockDevice.

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ class FileSystemStore : public KVStore {`
`50`	`50`	`* if it doesn't exist, creating it by default. If other init modes are desired,`
`51`	`51`	`* set the flags as necessary.`
`52`	`52`	`*`
`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.`
`54`	`55`	`*`
`55`	`56`	`* @returns MBED_SUCCESS Success.`
`56`	`57`	`* MBED_ERROR_INITIALIZATION_FAILED No valid FileSystemStore found on the device.`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,9 @@ class KVStore {`
`74`	`74`	`* erasing if necessary. If this is undesired, set the no_overwrite parameter`
`75`	`75`	`* to true.`
`76`	`76`	`*`
`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`	`+ *`
`78`	`80`	`*`
`79`	`81`	`* @returns MBED_ERROR_INITIALIZATION_FAILED No valid KVStore in the storage.`
`80`	`82`	`* MBED_SUCCESS on success or an error code on other failure`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,8 @@ class TDBStore : public KVStore {`
`63`	`63`	`* is not valid, TBDStore will overwrite the data by default. If other init modes are`
`64`	`64`	`* desired, set the flags as necessary.`
`65`	`65`	`*`
`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.`
`67`	`68`	`*`
`68`	`69`	`* @returns MBED_SUCCESS Success.`
`69`	`70`	`* MBED_ERROR_INITIALIZATION_FAILED No valid TBD store found in the BlockDevice.`