From: hyunuk.tak <hyunuk.tak@samsung.com>
Date: Thu, 23 Apr 2020 23:04:33 +0000 (+0900)
Subject: Modify some descriptions
X-Git-Tag: submit/tizen_5.5/20200424.012316^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=eebc075f29dbf8fbe083852950966034e4424373;p=platform%2Fcore%2Fapi%2Fsmart-traffic-control.git

Modify some descriptions

Change-Id: Iba1c443735843ba2be0f7f5f8107e2f5a7f0290e
Signed-off-by: hyunuk.tak <hyunuk.tak@samsung.com>
---

diff --git a/include/stc.h b/include/stc.h
index a6e1c61..81805a3 100755
--- a/include/stc.h
+++ b/include/stc.h
@@ -66,13 +66,13 @@ typedef void *stc_h;
 typedef void *stc_stats_rule_h;
 
 /**
- * @brief The statistics information handle.
+ * @brief The handle of statistical information about network traffic.
  * @since_tizen 4.0
  */
 typedef void *stc_stats_info_h;
 
 /**
- * @brief All statistics information handle.
+ * @brief The handle of all statistical information about network traffic.
  * @since_tizen 5.5
  */
 typedef void *stc_all_stats_info_h;
@@ -150,7 +150,7 @@ typedef enum {
  * @since_tizen 4.0
  */
 typedef enum {
-	STC_ROAMING_UNKNOWN,
+	STC_ROAMING_UNKNOWN,     /**< Roaming unknown */
 	STC_ROAMING_ENABLED,     /**< In roaming */
 	STC_ROAMING_DISABLED,	 /**< Not in roaming */
 } stc_roaming_type_e;
@@ -218,7 +218,7 @@ typedef enum {
  */
 
 /**
- * @brief Called for each available statistics information.
+ * @brief Called whenever there is available statistical information.
  * @details One of the following errors is delivered as a result.
  *   #STC_ERROR_NONE                Successful \n
  *   #STC_ERROR_INVALID_OPERATION   No reply \n
@@ -246,7 +246,7 @@ typedef stc_callback_ret_e (*stc_stats_info_cb)(
 		stc_error_e result, stc_stats_info_h info, void *user_data);
 
 /**
- * @brief Called when gathering statistics is completed.
+ * @brief Called when getting all statistical information is finished.
  * @details One of the following errors is delivered as a result.
  *   #STC_ERROR_NONE                Successful \n
  *   #STC_ERROR_INVALID_OPERATION   No reply \n
@@ -256,7 +256,7 @@ typedef stc_callback_ret_e (*stc_stats_info_cb)(
  * @remarks @a info will be released by the platform after the callback exits.
  *
  * @param[in] result        The result of statistics gathering completion
- * @param[in] info          All statistics information handle
+ * @param[in] info          The handle of all statistical information
  * @param[in] user_data     The user data passed from the statistics provider function
  *
  * @pre stc_get_all_stats() will invoke this callback.
@@ -421,7 +421,7 @@ int stc_foreach_stats(stc_h stc, stc_stats_rule_h rule,
 		stc_stats_info_cb info_cb, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
- * @brief Gets all statistics information according to the given rule, asynchronously.
+ * @brief Starts to get statistical information based on the rules asynchronously.
  *
  * @since_tizen 5.5
  * @privlevel public
@@ -461,7 +461,7 @@ int stc_get_all_stats(stc_h stc, stc_stats_rule_h rule,
 		stc_get_all_stats_finished_cb finished_cb, void *user_data);
 
 /**
- * @brief Iterates over the results of getting all statistics information.
+ * @brief Gets all statistical information.
  *
  * @since_tizen 5.5
  *