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

Edit TDBStore.h 

Edit file for punctuation and consistent tense.
pull/9208/head
Amanda Butler 2018-12-04 16:27:35 -06:00 committed by Cruz Monrreal II
parent 053212b540
commit 81296b34d0
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
features/storage/kvstore/tdbstore/TDBStore.h
View File

@ -41,7 +41,7 @@ public:
* *
* @param[in] bd Underlying block device. The BlockDevice * @param[in] bd Underlying block device. The BlockDevice
* can be any BlockDevice with flash characteristics. * can be any BlockDevice with flash characteristics.
* If using a non flash BlockDevice, like SDBlockDevice, * If using a BlockDevice without flash, such as SDBlockDevice,
* please add the FlashSimBlockDevice on top of it. * please add the FlashSimBlockDevice on top of it.
* *
* @returns none * @returns none
@ -57,7 +57,7 @@ public:
/** /**
* @brief Initialize TDBStore. If data exists, TDBStore will check the data integrity * @brief Initialize TDBStore. If data exists, TDBStore will check the data integrity
* on initialize. If Integrity checks fails the TDBStore will use GC to collect * on initialize. If the integrity checks fails, the TDBStore will use GC to collect
* the available data and clean corrupted and erroneous records. * the available data and clean corrupted and erroneous records.
* *
* @returns MBED_SUCCESS Success. * @returns MBED_SUCCESS Success.
@ -157,7 +157,7 @@ public:
/** /**
* @brief Start an incremental TDBStore set sequence. This operation is blocking other operations. * @brief Start an incremental TDBStore 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 '*' '/' '?' ':' ';' '\' '"' '|' ' ' '<' '>' '\'.
@ -246,8 +246,8 @@ public:
virtual int iterator_close(iterator_t it); virtual int iterator_close(iterator_t it);
/** /**
* @brief Set data in reserved area which is a special location for special data such as ROT. * @brief Set data in reserved area, which is a special location for special data, such as ROT.
* The data written to reserved area can not be overwritten. * The data written to reserved area can't be overwritten.
* *
* @param[in] reserved_data Reserved data buffer. * @param[in] reserved_data Reserved data buffer.
* @param[in] reserved_data_buf_size * @param[in] reserved_data_buf_size
@ -263,7 +263,7 @@ public:
virtual int reserved_data_set(const void *reserved_data, size_t reserved_data_buf_size); virtual int reserved_data_set(const void *reserved_data, size_t reserved_data_buf_size);
/** /**
* @brief Get data from reserved area which is a special location for special data such as ROT. * @brief Get data from reserved area, which is a special location for special data, such as ROT.
* *
* @param[in] reserved_data Reserved data buffer. * @param[in] reserved_data Reserved data buffer.
* @param[in] reserved_data_buf_size * @param[in] reserved_data_buf_size