From: Ji-hoon Lee <dalton.lee@samsung.com>
Date: Fri, 10 Apr 2020 00:25:36 +0000 (+0900)
Subject: Rephrase API descriptions
X-Git-Tag: submit/tizen/20200821.114909~1^2~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=08cfded9680ce18a7a0fa9d682b358774e90f2ef;p=platform%2Fcore%2Fuifw%2Fmulti-assistant.git

Rephrase API descriptions

Change-Id: I754a8a8564ed4c99474c9c656bb8d321f62b8f0d
---

diff --git a/include/multi_assistant.h b/include/multi_assistant.h
index 58dd04a..2ed064c 100644
--- a/include/multi_assistant.h
+++ b/include/multi_assistant.h
@@ -389,7 +389,7 @@ int ma_unset_active_state_changed_cb(void);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  *
- * @param[in] type The type of audio streaming data for which the streaming should be started
+ * @param[in] type The type of audio data to start streaming
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MA_ERROR_NONE Successful
@@ -405,7 +405,7 @@ int ma_start_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type)
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  *
- * @param[in] type The type of audio streaming data for which the streaming should be stopped
+ * @param[in] type The type of audio data to stop streaming
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MA_ERROR_NONE Successful
@@ -416,12 +416,12 @@ int ma_start_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type)
 int ma_stop_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type);
 
 /**
- * @brief Sends an update of the client's voice feedback state to the server.
+ * @brief Updates the state of client's voice feedback to the server.
  * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  *
- * @param[in] state The current voice feedback state
+ * @param[in] state The current state of voice feedback
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MA_ERROR_NONE Successful
@@ -432,7 +432,7 @@ int ma_stop_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type);
 int ma_update_voice_feedback_state(ma_voice_feedback_state_e state);
 
 /**
- * @brief Sends assistant-specific command to the server.
+ * @brief Sends an assistant-specific command to the server.
  * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -449,6 +449,10 @@ int ma_send_assistant_specific_command(const char* command);
 
 /**
  * @brief Sets the wakeup engine command callback.
+ * @details The wakeup engine command callback will be called when the wakeup engine
+ *          sends wakeup engine specific command to the voice assistant.
+ *          The command MUST be defined by both wakeup engine and voice assistant.
+ *
  * @since_tizen 5.5
  *
  * @param[in] callback The callback
@@ -467,7 +471,7 @@ int ma_send_assistant_specific_command(const char* command);
 int ma_set_wakeup_engine_command_cb(ma_wakeup_engine_command_cb callback, void* user_data);
 
 /**
- * @brief Unsets the wakeup engine command callback.
+ * @brief Unsets the callback.
  * @since_tizen 5.5
  *
  * @return @c 0 on success, otherwise a negative error value