Change API description by API review

Change-Id: Id2128ab41a3b8cabfaede41357603d78a344fa3b

diff --git a/include/inputmethod.h b/include/inputmethod.h
index 6b5ff79bbae98f5803656655a08864239b7df2c5..a6f1d06db3896023c8b9a338f274f4570b425293 100644 (file)
--- a/include/inputmethod.h
+++ b/include/inputmethod.h
@@ -543,6 +543,12 @@ typedef void (*ime_geometry_requested_cb)(void *user_data, int *x, int *y, int *
  *
  * @details This function processes the key event before an associated text input UI control does.
  *
+ * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
+ *
+ * @privlevel public
+ *
+ * @privilege %http://tizen.org/privilege/ime
+ *
  * @remarks If the key event is from the external device, @a dev_info will have its name, class and subclass information.
  *
  * @param[in] keycode The key code to be sent
@@ -714,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 prediction_hint_data is valid only in the callback. To use outside the callback, make a copy.
+ * @remarks @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
@@ -1259,7 +1265,7 @@ int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func,
  static bool inputmethod_process_key_event_cb(ime_key_code_e keycode, ime_key_mask_e keymask, void *user_data);
  {
         if (keymask & IME_KEY_MASK_CONTROL) {
-                return false; // e.g., Cotrol+C key event would be forwarded to UI control of the client application
+                return false; // e.g., Control+C key event would be forwarded to UI control of the client application
         }
         if (keymask & IME_KEY_MASK_ALT) {
                 return false;
@@ -1437,16 +1443,16 @@ int ime_event_set_option_window_destroyed_cb(ime_option_window_destroyed_cb call
 /**
  * @brief Sends a key event to the associated text input UI control.
  *
+ * @details This function sends key down or up event with key mask to the client application.
+ * If @a forward_key is @c true, this key event goes to the edit field directly. And if @a forward_key
+ * is @c false, the ime_process_key_event_cb() callback function receives the key event before the edit field.
+ *
  * @since_tizen @if MOBILE 2.4 @else 3.0 @endif
  *
  * @privlevel public
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @details This function sends key down or up event with key mask to the client application.
- * If @a forward_key is @c true, this key event goes to the edit filed directly. And if @a forward_key
- * is @c false, the ime_process_key_event_cb() callback function receives the key event before the edit field.
- *
  * @param[in] keycode The key code to be sent
  * @param[in] keymask The modifier key mask
  * @param[in] forward_key The flag to send the key event directly to the edit field
@@ -1642,14 +1648,14 @@ int ime_delete_surrounding_text(int offset, int len);
 /**
  * @brief Gets the surrounding text from the position of the cursor, synchronously.
  *
- * @remarks @a text must be released using free().
- *
  * @since_tizen 3.0
  *
  * @privlevel public
  *
  * @privilege %http://tizen.org/privilege/ime
  *
+ * @remarks @a text must be released using free().
+ *
  * @param[in] maxlen_before The maximum length of string to be retrieved before the cursor; -1 means unlimited
  * @param[in] maxlen_after The maximum length of string to be retrieved after the cursor; -1 means unlimited
  * @param[out] text The surrounding text
@@ -1724,10 +1730,11 @@ int ime_get_selected_text(char **text);
  * @return The input panel main window object on success, otherwise NULL
  *
  * @exception #IME_ERROR_NONE Successful
- * #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
- * #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- * #IME_ERROR_OPERATION_FAILED Operation failed
+ * @exception #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
+ * @exception #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
+ * @exception #IME_ERROR_OPERATION_FAILED Operation failed
  *
+ * @see get_last_result()
  * @see ime_create_cb()
  * @see ime_terminate_cb()
  * @see ime_show_cb()