From: Unsung Lee <unsung.lee@samsung.com>
Date: Fri, 20 Sep 2024 07:23:04 +0000 (+0900)
Subject: storage: Update description of storage APIs
X-Git-Tag: accepted/tizen/unified/20240924.153241~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2e1779e0830e00f5a44cfbf849d64e63d9a51b5c;p=platform%2Fcore%2Fsystem%2Flibstorage.git

storage: Update description of storage APIs

Update description of storage APIs in @brief, @details, @remarks, and @retval
to supplement the explanation.

Change-Id: Ib82146a3e992d84a04c5ce5a127eb4e83bcae7d8
Signed-off-by: Unsung Lee <unsung.lee@samsung.com>
---

diff --git a/include/storage.h b/include/storage.h
index d826ae8..6bac24a 100644
--- a/include/storage.h
+++ b/include/storage.h
@@ -45,8 +45,12 @@ extern "C" {
 
 
 /**
- * @brief Gets the internal memory size.
+ * @brief Gets the size of the internal storage located in the TZ_SYS_USER path.
+ * @details Retrieves of the internal storage information using statvfs() syscall \n
+ *          and returns the information stored in the struct statvfs structure.
  * @since_tizen 2.3
+ * @remarks Does not require internal storage path as input. \n
+ *          It always uses the path stored in the TZ_SYS_USER environment variable.
  * @param[out] buf A pointer to a statvfs structure
  * @return @c 0 on success,
  *         otherwise a negative error value on failure
@@ -74,14 +78,19 @@ extern int storage_get_internal_memory_size(struct statvfs *buf);
 
 
 /**
- * @brief Gets the external memory size.
+ * @brief Gets the size of the primary external storage if external storage is supported.
+ * @details Retrieves of the external storage information \n
+ *          and returns the information stored in the struct statvfs structure.
  * @since_tizen 2.3
+ * @remarks Returns #STORAGE_ERROR_NOT_SUPPORTED
+ *          if device does not support external storage feature.
  * @param[out] buf A pointer to a statvfs structure
  * @return @c 0 on success,
  *         otherwise a negative error value on failure
  * @retval #STORAGE_ERROR_NONE Successful
  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
+ * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
  * @par Example:
  * @code
  *	...