From: Jihoon Kim Date: Wed, 7 Sep 2022 02:06:45 +0000 (+0900) Subject: Fix warnings detected by header check script X-Git-Tag: accepted/tizen/unified/20230606.140926~4 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8f25271d66e368a6dca1861460d4e4ad9a288379;p=platform%2Fcore%2Fuifw%2Fmulti-assistant.git Fix warnings detected by header check script Change-Id: Ic0f614e8cded9d8b43e761cc539d62ed26a954ae Signed-off-by: Jihoon Kim --- diff --git a/include/multi_assistant_internal.h b/include/multi_assistant_internal.h index 08b39b2..26c2222 100644 --- a/include/multi_assistant_internal.h +++ b/include/multi_assistant_internal.h @@ -90,8 +90,8 @@ int ma_ap_deinitialize(void); * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported - * @retval #MA_ERROR_INVALID_STATE Invalid state * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MA_ERROR_INVALID_STATE Invalid state * * @pre The state should be #MA_STATE_INITIALIZED. * @see ma_error_cb() diff --git a/include/multi_assistant_settings.h b/include/multi_assistant_settings.h index b9e3493..4cb1eab 100644 --- a/include/multi_assistant_settings.h +++ b/include/multi_assistant_settings.h @@ -29,127 +29,103 @@ extern "C" #endif /** - * @brief Check multi-assistant's multiple mode. + * @brief Checks multi-assistant's multiple mode. * @since_tizen 5.5 - * @privlevel public - * + * @param[out] multiple The current multiple mode of multi-assistant * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[out] multiple The current multiple mode of multi-assistant */ int ma_settings_is_multiple_mode(bool *multiple); /** - * @brief Set multi-assistant's multiple mode. + * @brief Sets multi-assistant's multiple mode. * @since_tizen 5.5 - * @privlevel public - * + * @param[in] multiple The multiple mode of multi-assistant need to be changed into * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[in] multiple The multiple mode of multi-assistant need to be changed into */ int ma_settings_set_multiple_mode(bool multiple); /** - * @brief Get system's current voice assistant. + * @brief Gets system's current voice assistant. * @since_tizen 5.5 * @remarks Valid only in single voice assistant mode. * @remarks The @a app_id should be released using free(). - * @privlevel public - * + * @param[out] app_id The app id of the currently activated voice assistant * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[out] app_id The app id of the currently activated voice assistant */ int ma_settings_get_current_voice_assistant(char** app_id); /** - * @brief Change system's voice assistant. + * @brief Changes system's voice assistant. * @since_tizen 5.5 * @remarks Valid only in single voice assistant mode. - * @privlevel public - * + * @param[in] app_id The app id of the voice assistant that need to be activated * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[in] app_id The app id of the voice assistant that need to be activated */ int ma_settings_change_voice_assistant(const char* app_id); /** - * @brief Get whether the specific voice assistant should be enabled or not. + * @brief Gets whether the specific voice assistant should be enabled or not. * @since_tizen 7.0 - * @privlevel public - * + * @param[in] app_id The app id of the voice assistant + * @param[out] enabled The enabled state of the voice assistant * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[in] app_id The app id of the voice assistant - * @param[out] enabled The enabled state of the voice assistant */ int ma_settings_get_voice_assistant_enabled(const char* app_id, bool *enabled); /** - * @brief En/Disable a specific voice assistant. + * @brief En/Disables a specific voice assistant. * @since_tizen 5.5 * @remarks Valid only in multiple voice assistant mode. - * @privlevel public - * + * @param[in] app_id The app id of the voice assistant that need to be changed + * @param[in] enabled The voice assistant need to be enabled or not * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter - * - * @param[in] app_id The app id of the voice assistant that need to be changed - * @param[in] enabled The voice assistant need to be enabled or not */ int ma_settings_set_voice_assistant_enabled(const char* app_id, bool enabled); /** - * @brief Retrieve system's default voice assistant. + * @brief Retrieves system's default voice assistant. * @since_tizen 5.5 * @remarks Valid only in multiple voice assistant mode. * @remarks The @a app_id should be released using free(). - * @privlevel public - * + * @param[out] app_id The app id of the voice assistant currently set as default one * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[out] app_id The app id of the voice assistant currently set as default one */ int ma_settings_get_default_voice_assistant(char** app_id); /** - * @brief Change system's default voice assistant. + * @brief Changes system's default voice assistant. * @since_tizen 5.5 * @remarks Valid only in multiple voice assistant mode. - * @privlevel public - * + * @param[in] app_id The app id of the voice assistant that need to set as default one * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MA_ERROR_OPERATION_FAILED Operation failed - * - * @param[in] app_id The app id of the voice assistant that need to set as default one */ int ma_settings_set_default_voice_assistant(const char* app_id); diff --git a/include/multi_assistant_ui.h b/include/multi_assistant_ui.h index 3d7f31d..617d92f 100644 --- a/include/multi_assistant_ui.h +++ b/include/multi_assistant_ui.h @@ -118,7 +118,6 @@ typedef void (*ma_ui_recognition_result_cb)(ma_recognition_result_event_e result * @param[in] user_data The user data passed from the callback registration function * * @see ma_ui_set_enable_common_ui_cb() - * @see ma_ui_set_enable_common_ui_cb() */ typedef void (*ma_ui_enable_common_ui_cb)(bool enable, void* user_data); @@ -203,8 +202,8 @@ int ma_ui_unprepare(void); * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported * @retval #MA_ERROR_PERMISSION_DENIED Permission denied - * @retval #MA_ERROR_INVALID_STATE Invalid state * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MA_ERROR_INVALID_STATE Invalid state */ int ma_ui_get_state(ma_state_e* state); @@ -275,8 +274,8 @@ int ma_ui_change_assistant(const char* app_id); * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported - * @retval #MA_ERROR_INVALID_STATE Invalid state * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MA_ERROR_INVALID_STATE Invalid state * * @pre The state should be #MA_STATE_INITIALIZED. * @see ma_state_changed_cb() @@ -309,8 +308,8 @@ int ma_ui_unset_state_changed_cb(void); * @return @c 0 on success, otherwise a negative error value * @retval #MA_ERROR_NONE Successful * @retval #MA_ERROR_NOT_SUPPORTED Not supported - * @retval #MA_ERROR_INVALID_STATE Invalid state * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MA_ERROR_INVALID_STATE Invalid state * * @pre The state should be #MA_STATE_INITIALIZED. * @see ma_error_cb()