From b1926b67e9f37fb460c2ae6d5dc52337036e3ff0 Mon Sep 17 00:00:00 2001 From: Jihoon Kim Date: Mon, 7 Oct 2024 17:31:45 +0900 Subject: [PATCH] Fix documentation warnings Change-Id: I7c7cb61ed5c355fc7733fd603e118347645134a3 Signed-off-by: Jihoon Kim --- inputmethod/include/inputmethod.h | 70 ++++++++++++++++--------------- 1 file changed, 36 insertions(+), 34 deletions(-) diff --git a/inputmethod/include/inputmethod.h b/inputmethod/include/inputmethod.h index 5f48621..08537af 100644 --- a/inputmethod/include/inputmethod.h +++ b/inputmethod/include/inputmethod.h @@ -50,7 +50,7 @@ typedef enum { IME_ERROR_NO_CALLBACK_FUNCTION = TIZEN_ERROR_IME | 0x0001, /**< Necessary callback function is not set */ IME_ERROR_NOT_RUNNING = TIZEN_ERROR_IME | 0x0002, /**< IME main loop is not started yet */ IME_ERROR_OPERATION_FAILED = TIZEN_ERROR_IME | 0x0003, /**< Operation failed */ - IME_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< out of memory */ + IME_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ } ime_error_e; /** @@ -821,6 +821,8 @@ typedef void (*ime_prediction_hint_data_set_cb)(const char *key, const char *val * * @privlevel public * + * @privilege %http://tizen.org/privilege/ime + * * @remarks Regardless of the rotation degree, the @a x, @a y values of the top-left corner on the screen are based on 0, 0. * This function is used to adjust the position of the input panel when its size changes in floating mode. * @@ -882,26 +884,6 @@ typedef struct { * * @pre The ime_event_set_***() functions can be called to set the event handling callback functions. * - * @see #ime_callback_s - * @see ime_event_set_focus_in_cb() - * @see ime_event_set_focus_out_cb() - * @see ime_event_set_surrounding_text_updated_cb() - * @see ime_event_set_input_context_reset_cb() - * @see ime_event_set_cursor_position_updated_cb() - * @see ime_event_set_language_requested_cb() - * @see ime_event_set_language_set_cb() - * @see ime_event_set_imdata_set_cb() - * @see ime_event_set_layout_set_cb() - * @see ime_event_set_return_key_type_set_cb() - * @see ime_event_set_return_key_state_set_cb() - * @see ime_event_set_geometry_requested_cb() - * @see ime_event_set_display_language_changed_cb() - * @see ime_event_set_rotation_degree_changed_cb() - * @see ime_event_set_accessibility_state_changed_cb() - * @see ime_event_set_option_window_created_cb() - * @see ime_event_set_option_window_destroyed_cb() - * @see ime_event_set_prediction_hint_set_cb() - * * @code static void inputmethod_create_cb(void *user_data); static void inputmethod_terminate_cb(void *user_data); @@ -963,6 +945,26 @@ typedef struct { ime_run(&basic_callback, NULL); } * @endcode + * + * @see #ime_callback_s + * @see ime_event_set_focus_in_cb() + * @see ime_event_set_focus_out_cb() + * @see ime_event_set_surrounding_text_updated_cb() + * @see ime_event_set_input_context_reset_cb() + * @see ime_event_set_cursor_position_updated_cb() + * @see ime_event_set_language_requested_cb() + * @see ime_event_set_language_set_cb() + * @see ime_event_set_imdata_set_cb() + * @see ime_event_set_layout_set_cb() + * @see ime_event_set_return_key_type_set_cb() + * @see ime_event_set_return_key_state_set_cb() + * @see ime_event_set_geometry_requested_cb() + * @see ime_event_set_display_language_changed_cb() + * @see ime_event_set_rotation_degree_changed_cb() + * @see ime_event_set_accessibility_state_changed_cb() + * @see ime_event_set_option_window_created_cb() + * @see ime_event_set_option_window_destroyed_cb() + * @see ime_event_set_prediction_hint_set_cb() */ int ime_run(ime_callback_s *basic_cb, void *user_data); @@ -1355,9 +1357,6 @@ int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func, * * @post The ime_run() function should be called to start the IME application's main loop. * - * @see ime_process_key_event_cb() - * @see ime_run() - * * @code static void inputmethod_create_cb(void *user_data); static void inputmethod_terminate_cb(void *user_data); @@ -1401,6 +1400,9 @@ int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func, ime_run(&basic_callback, NULL); } * @endcode + * + * @see ime_process_key_event_cb() + * @see ime_run() */ int ime_event_set_process_key_event_cb(ime_process_key_event_cb callback_func, void *user_data); @@ -1685,12 +1687,6 @@ int ime_hide_preedit_string(void); * * @post This function is supposed to be followed by the ime_show_preedit_string() function. * - * @see #ime_preedit_attribute - * @see ime_commit_string() - * @see ime_show_preedit_string() - * @see ime_hide_preedit_string() - * @see ime_update_preedit_cursor() - * * @code { int ret; @@ -1724,6 +1720,12 @@ int ime_hide_preedit_string(void); } } * @endcode + * + * @see #ime_preedit_attribute + * @see ime_commit_string() + * @see ime_show_preedit_string() + * @see ime_hide_preedit_string() + * @see ime_update_preedit_cursor() */ int ime_update_preedit_string(const char *str, Eina_List *attrs); @@ -1745,10 +1747,6 @@ int ime_update_preedit_string(const char *str, Eina_List *attrs); * * @post This function is supposed to be followed by the ime_update_preedit_string() function. * - * @see ime_show_preedit_string() - * @see ime_hide_preedit_string() - * @see ime_update_preedit_string() - * * @code { int ret; @@ -1776,6 +1774,10 @@ int ime_update_preedit_string(const char *str, Eina_List *attrs); ret = ime_update_preedit_cursor(1); } * @endcode + * + * @see ime_show_preedit_string() + * @see ime_hide_preedit_string() + * @see ime_update_preedit_string() */ int ime_update_preedit_cursor(unsigned int pos); -- 2.34.1