Merge branch 'tizen_6.0' into tizen

[platform/core/api/inputmethod.git] / inputmethod / include / inputmethod_internal.h

diff --git a/inputmethod/include/inputmethod_internal.h b/inputmethod/include/inputmethod_internal.h
index 4d90952..3cf056a 100644 (file)
--- a/inputmethod/include/inputmethod_internal.h
+++ b/inputmethod/include/inputmethod_internal.h
@@ -175,7 +175,7 @@ typedef void (*ime_candidate_more_window_show_cb)(void *user_data);
 typedef void (*ime_candidate_more_window_hide_cb)(void *user_data);
 
 /**
- * @brief Called when an AUX item is selected
+ * @brief Called when an AUX item is selected.
  *
  * @since_tizen 5.5
  *
@@ -187,7 +187,7 @@ typedef void (*ime_candidate_more_window_hide_cb)(void *user_data);
 typedef void (*ime_aux_select_cb)(uint32_t item, void *user_data);
 
 /**
- * @brief Called when a candidate item is selected
+ * @brief Called when a candidate item is selected.
  *
  * @since_tizen 5.5
  *
@@ -199,7 +199,7 @@ typedef void (*ime_aux_select_cb)(uint32_t item, void *user_data);
 typedef void (*ime_candidate_select_cb)(uint32_t item, void *user_data);
 
 /**
- * @brief Called when a candidate table page is up
+ * @brief Called when a candidate table page is up.
  *
  * @since_tizen 5.5
  *
@@ -210,7 +210,7 @@ typedef void (*ime_candidate_select_cb)(uint32_t item, void *user_data);
 typedef void (*ime_candidate_table_page_up_cb)(void *user_data);
 
 /**
- * @brief Called when a candidate table page is down
+ * @brief Called when a candidate table page is down.
  *
  * @since_tizen 5.5
  *
@@ -414,15 +414,18 @@ int ime_flush_imengine(void);
 int ime_reset_imengine(void);
 
 /**
- * @brief Send an Event to IMEngine
+ * @brief Send an Event to IMEngine.
  *
  * @since_tizen 5.0
  *
  * @privilege %http://tizen.org/privilege/ime
  *
- * @return 0 on success, otherwise a negative error value
  * @param[in] command The command to be sent.
  * @param[in] value The value corresponding to the command.
+ *
+ * @return 0 on success, otherwise a negative error value
+ * @retval #IME_ERROR_NONE No error
+ * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
  */
 int ime_send_imengine_event(int command, unsigned int value);