ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Edit FileSystemStore.h 

Make minor edits, mostly for consistent tense across documents.
pull/8933/head
Amanda Butler 2018-12-04 16:22:47 -06:00 committed by GitHub
parent cdcf14ef79
commit 77a931b579
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
features/storage/kvstore/filesystemstore/FileSystemStore.h
View File

@ -36,7 +36,7 @@ class FileSystemStore : public KVStore {
public: public:
/** Create FileSystemStore - A Key Value API on top of FS /** Create FileSystemStore - A Key Value API on top of FS
* *
* @param fs File system (FAT/LITTLE) on top which FileSystemStore is adding KV API * @param fs File system (FAT/LITTLE) on top of which FileSystemStore is adding KV API
*/ */
FileSystemStore(FileSystem *fs); FileSystemStore(FileSystem *fs);
@ -46,8 +46,8 @@ public:
virtual ~FileSystemStore() {} virtual ~FileSystemStore() {}
/** /**
* @brief Initialize FileSystemStore, Checking validity of * @brief Initialize FileSystemStore, checking validity of
* KVStore writing folder and if not exists creates it. * KVStore writing folder and if it doesn't exist, creating it.
* *
* @returns MBED_SUCCESS Success. * @returns MBED_SUCCESS Success.
* MBED_ERROR_FAILED_OPERATION Underlying file system failed operation. * MBED_ERROR_FAILED_OPERATION Underlying file system failed operation.
@ -138,7 +138,7 @@ public:
/** /**
* @brief Start an incremental FileSystemStore set sequence. This operation is blocking other operations. * @brief Start an incremental FileSystemStore set sequence. This operation is blocking other operations.
* Any get/set/remove/iterator operation will be blocked until set_finalize will be called. * Any get/set/remove/iterator operation will be blocked until set_finalize is called.
* *
* @param[out] handle Returned incremental set handle. * @param[out] handle Returned incremental set handle.
* @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'. * @param[in] key Key - must not include '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
@ -156,7 +156,7 @@ public:
/** /**
* @brief Add data to incremental FileSystemStore set sequence. This operation is blocking other operations. * @brief Add data to incremental FileSystemStore set sequence. This operation is blocking other operations.
* Any get/set/remove operation will be blocked until set_finalize will be called. * Any get/set/remove operation will be blocked until set_finalize is called.
* *
* @param[in] handle Incremental set handle. * @param[in] handle Incremental set handle.
* @param[in] value_data Value data to add. * @param[in] value_data Value data to add.