From: Inhong Han <inhong1.han@samsung.com>
Date: Wed, 10 Apr 2019 04:50:32 +0000 (+0900)
Subject: Change API description by API review
X-Git-Tag: submit/tizen_5.0/20190419.011400~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2d20856575e26d129a96caf4b3f9a0fd47a819c2;p=platform%2Fcore%2Fapi%2Finputmethod.git

Change API description by API review

Change-Id: I9c79f1cf47d146ea29149e138fe90178a97a2fe3
---

diff --git a/include/inputmethod.h b/include/inputmethod.h
index 5794bca..a77c686 100644
--- a/include/inputmethod.h
+++ b/include/inputmethod.h
@@ -39,7 +39,7 @@ extern "C" {
  */
 
 /**
- * @brief Enumeration for input method function error
+ * @brief Enumeration for input method function error.
  *
  * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
  */
@@ -54,7 +54,7 @@ typedef enum {
 } ime_error_e;
 
 /**
- * @brief Enumeration of the option window type
+ * @brief Enumeration of the option window type.
  *
  * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
  *
@@ -66,7 +66,7 @@ typedef enum {
 } ime_option_window_type_e;
 
 /**
- * @brief Enumeration of layout variation
+ * @brief Enumeration of layout variation.
  *
  * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
  *
@@ -85,7 +85,7 @@ typedef enum {
 } ime_layout_variation_e;
 
 /**
- * @brief Enumeration of string attribute type
+ * @brief Enumeration of string attribute type.
  *
  * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
  *
@@ -712,7 +712,7 @@ typedef void (*ime_prediction_hint_set_cb)(const char *prediction_hint, void *us
 typedef void (*ime_mime_type_set_request_cb)(const char *mime_type, void *user_data);
 
 /**
- * @brief Called to set the prediction hint key and value to deliver to the input panel.
+ * @brief Called with the prediction hint key and value which can be delivered to the input panel.
  *
  * @since_tizen 5.0
  *
@@ -720,7 +720,7 @@ typedef void (*ime_mime_type_set_request_cb)(const char *mime_type, void *user_d
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @remarks @a value is valid only in the callback. To use outside the callback, make a copy.
+ * @remarks @a key and @a value is valid only in the callback. To use outside the callback, make a copy.
  * This function is used by the applications to deliver the prediction hint data message to the input panel.
  *
  * @param[in] key The prediction hint key to be set to the input panel
@@ -2395,8 +2395,8 @@ int ime_set_floating_drag_end(void);
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @remarks The ime_prediction_hint_data_set_cb() callback function is called to set the prediction
- * hint key and value to deliver to the input panel.
+ * @remarks The ime_prediction_hint_data_set_cb() callback function is called to provide the prediction
+ * hint key and value which can be delivered to the input panel.
  *
  * @param[in] callback_func The prediction hint event callback function
  * @param[in] user_data User data to be passed to the callback function