From aa063996eecc880896c84d8b7dce5919b98dff81 Mon Sep 17 00:00:00 2001 From: Jihoon Kim Date: Mon, 1 Feb 2021 19:09:07 +0900 Subject: [PATCH] Fix document issues Change-Id: Id9b6ef9d894c965f6da265c22eed7b15befbcd21 Signed-off-by: Jihoon Kim --- inputmethod/include/inputmethod.h | 12 ++++++------ inputmethod/include/inputmethod_internal.h | 15 +++++++++------ inputmethod/include/inputmethod_private.h | 2 +- remote_input/include/remote_input.h | 2 +- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/inputmethod/include/inputmethod.h b/inputmethod/include/inputmethod.h index 6cfeebe..e2baa2d 100644 --- a/inputmethod/include/inputmethod.h +++ b/inputmethod/include/inputmethod.h @@ -91,7 +91,7 @@ typedef enum { * * @remarks Currently, a font style is available to use. * - * @see ime_preedit_attribute + * @see #ime_preedit_attribute * @see ime_update_preedit_string() */ typedef enum { @@ -138,7 +138,7 @@ typedef enum { * @remarks A preedit string may have one or more different attributes. This structure describes each attribute of the string. * * @see ime_update_preedit_string() - * @see ime_attribute_type + * @see #ime_attribute_type */ typedef struct { unsigned int start; /**< The start position in the string of this attribute */ @@ -839,7 +839,7 @@ typedef struct { * * @pre The ime_event_set_***() functions can be called to set the event handling callback functions. * - * @see ime_callback_s + * @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() @@ -1642,7 +1642,7 @@ 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_preedit_attribute * @see ime_commit_string() * @see ime_show_preedit_string() * @see ime_hide_preedit_string() @@ -1975,7 +1975,7 @@ int ime_context_get_layout(ime_context_h context, Ecore_IMF_Input_Panel_Layout * * @post Input panel UI should be drawn or operated by this information accordingly. * * @see ime_show_cb() - * @see ime_layout_variation_e + * @see #ime_layout_variation_e */ int ime_context_get_layout_variation(ime_context_h context, ime_layout_variation_e *layout_variation); @@ -2537,7 +2537,7 @@ int ime_request_hide(void); * @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * - * @see ime_event_type_e + * @see #ime_event_type_e */ int ime_update_input_panel_event(ime_event_type_e type, unsigned int value); diff --git a/inputmethod/include/inputmethod_internal.h b/inputmethod/include/inputmethod_internal.h index 0b8002b..08caaf5 100644 --- 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); diff --git a/inputmethod/include/inputmethod_private.h b/inputmethod/include/inputmethod_private.h index b4e1f24..75ef7ab 100644 --- a/inputmethod/include/inputmethod_private.h +++ b/inputmethod/include/inputmethod_private.h @@ -40,7 +40,7 @@ struct _ime_device_info { Ecore_IMF_Device_Subclass dev_subclass; /**< The device subclass */ }; -void ime_privilege_cache_init(); +void ime_privilege_cache_init(void); #endif /* __TIZEN_UIX_INPUTMETHOD_PRIVATE_H__ */ diff --git a/remote_input/include/remote_input.h b/remote_input/include/remote_input.h index 2360529..82fa3c0 100644 --- a/remote_input/include/remote_input.h +++ b/remote_input/include/remote_input.h @@ -172,8 +172,8 @@ typedef void (*remote_input_resource_changed_cb)(remote_input_resource_e resourc * @param[out] remote_handle The remote input handle * @return 0 on success, otherwise a negative error value * @retval #REMOTE_INPUT_ERROR_NONE Successful - * @retval #REMOTE_INPUT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #REMOTE_INPUT_ERROR_PERMISSION_DENIED Permission denied + * @retval #REMOTE_INPUT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #REMOTE_INPUT_ERROR_OUT_OF_MEMORY Out of memory * @retval #REMOTE_INPUT_ERROR_OPERATION_FAILED Operation failure * @see remote_input_destroy() -- 2.34.1