From 1df288d62604d5901fce340da1ecd38bffe5cf02 Mon Sep 17 00:00:00 2001 From: Ji-hoon Lee Date: Thu, 7 Jan 2021 14:44:31 +0900 Subject: [PATCH] Incorporate suggested API description changes Change-Id: Id03a724aae6d3c7d25dbf4612886a149793b401c --- include/multi_assistant.h | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/include/multi_assistant.h b/include/multi_assistant.h index 652557f..0e810a9 100644 --- a/include/multi_assistant.h +++ b/include/multi_assistant.h @@ -790,14 +790,15 @@ int ma_set_voice_key_status_changed_cb(ma_voice_key_status_changed_cb callback, int ma_unset_voice_key_status_changed_cb(void); /** - * @brief Adds a wake word used for activating assistant. - * @details Different pairs identify a different word. + * @brief Adds a group of wake words for activating assistant. + * @details A pair with the same word and the different language + * identifies a different operation. * For example, <"Hi Tizen", "en_US"> and <"Hi Tizen", "en_GB"> - * are different words. If <"Hi Tizen", "en_US"> is added, then - * "Hi Tizen" will not wake the Tizen voice assistant if the - * wakeup language is set to "en_GB". <"Hi Tizen", "en_GB"> will - * have to be added for that.\n - * Adding the same word twice does not cause any error to be returned. + * will operate differently. When the wake up language is set to "en_GB", + * although <"Hi Tizen", "en_US"> is added, then + * "Hi Tizen" won't wake up the Tizen voice assistant. + * <"Hi Tizen", "en_GB"> have to be added for this use case.\n + * Adding the same word twice does not return any errors. * @since_tizen 6.0 * * @param[in] wake_word The wake word to be added to the list of wake words @@ -816,12 +817,12 @@ int ma_unset_voice_key_status_changed_cb(void); int ma_add_wake_word(const char* wake_word, const char *language); /** - * @brief Removes a wake word used for activating assistant. - * @details Different pairs identify a different word. + * @brief Removes a group of wake words for activating assistant. + * @details A pair with the same word and the different language + * identifies a different operation. * For example, <"Hi Tizen", "en_US"> and <"Hi Tizen", "en_GB"> - * are different words.\n - * Removing a word not present on the list does not cause any error - * to be returned. + * will operate differently. + * Removing an unregistered word doesn't return any errors. * @since_tizen 6.0 * * @param[in] wake_word The wake word to be removed from the list of wake words -- 2.34.1