Minor documentation changes (#1156)

* Add notes to `defaultCache.h`.
* Fix inconsistencies in the documentation (examples).

Relates-To: OLPEDGE-2370

Signed-off-by: Halyna Dumych <[email protected]>

Author: HalynaDumych

docs/dataservice-read-catalog-example.md

@@ -50,7 +50,7 @@ After building and running the example project, you see the following informatio
 
 - `edge-example-catalog` – a catalog description.
 - `versioned-world-layer` – a layer description.
-- `Request partition data - Success, data size - 3375` - a success message that displays the size of data retrieved from the requested partition.
+- `Request partition data - Success, data size - 3375` – a success message that displays the size of data retrieved from the requested partition.
 
 ```bash
 [INFO] read-example - Catalog description: edge-example-catalog
@@ -66,7 +66,7 @@ To integrate the Data SDK libraries in the Android example project:
 
 - [Set up prerequisites](#prerequisites-android)
 - [Build the Data SDK](#build-sdk-android)
-- [Build and Run the APK](#build-and-run-android)
+- [Build and run the APK](#build-and-run-android)
 
 ### <a name="prerequisites-android"></a>Prerequisites
 
@@ -416,4 +416,4 @@ if (data_response.IsSuccessful()) {
 }
 ```
 
-The `DataResult` class contains the raw partition data that is an alias for a `std::shared_ptr<std::vector<unsigned char>>`.
+The `DataResult` class contains raw partition data that is an alias for a `std::shared_ptr<std::vector<unsigned char>>`.

docs/dataservice-write-example.md

@@ -56,7 +56,7 @@ To integrate the Data SDK libraries in the Android example project:
 
 - [Set up prerequisites](#prerequisites-android)
 - [Build the Data SDK](#build-sdk-android)
-- [Build and Run the APK](#build-and-run-android)
+- [Build and run the APK](#build-and-run-android)
 
 ### <a name="prerequisites-android"></a>Prerequisites
 
@@ -106,7 +106,7 @@ To integrate the Data SDK libraries in the iOS example application written in th
 
 - [Set up prerequisites](#prerequisites-ios)
 - [Build the Data SDK](#build-sdk-ios)
-- [Build and Run the Application](#build-and-run-ios)
+- [Build and run the Application](#build-and-run-ios)
 
 ### <a name="prerequisites-ios"></a>Prerequisites
 

olp-cpp-sdk-core/include/olp/core/cache/DefaultCache.h

@@ -83,6 +83,8 @@ class CORE_API DefaultCache : public KeyValueCache {
    *
    * @return `StorageOpenResult` if there are problems opening any of
    * the provided paths on the disk.
+   *
+   * @note If the cache cannot be opened or repaired, it is deleted.
    */
   StorageOpenResult Open();
 
@@ -92,8 +94,10 @@ class CORE_API DefaultCache : public KeyValueCache {
    * @param type The type of cache to open.
    *
    * @return `Success` if the cache is created or already open, `NotReady` if
-   * DefaultCache is closed and `OpenDiskPathFailure` if there are problems
+   * `DefaultCache` is closed, and `OpenDiskPathFailure` if there are problems
    * opening the provided path on the disk.
+   *
+   * @note If the cache cannot be opened or repaired, it is deleted.
    */
   StorageOpenResult Open(CacheType type);