Rephrase API documentation as per review

Change-Id: Ife419bc70e2bbf03e1f0315cfd77b93d390ebb82

diff --git a/include/multi_assistant.h b/include/multi_assistant.h
index 051406c930758d7c8af2f6c659a6f82052e7357f..d65faa873363ceee66cc0b83dbd002259c19d4bd 100644 (file)
--- a/include/multi_assistant.h
+++ b/include/multi_assistant.h
@@ -351,7 +351,7 @@ int ma_send_result(const char* display_text, const char* utterance_text, const c
 int ma_send_recognition_result(ma_recognition_result_event_e result);
 
 /**
- * @brief Sets a active state changed callback.
+ * @brief Sets the active state changed callback.
  * @since_tizen 5.5
  *
  * @param[in] callback The callback
@@ -370,7 +370,7 @@ int ma_send_recognition_result(ma_recognition_result_event_e result);
 int ma_set_active_state_changed_cb(ma_active_state_changed_cb callback, void* user_data);
 
 /**
- * @brief Unsets a active state changed callback.
+ * @brief Unsets the active state changed callback.
  * @since_tizen 5.5
  *
  * @return @c 0 on success, otherwise a negative error value
@@ -390,7 +390,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 need to be started streaming
+ * @param[in] type The type of audio streaming data for which the streaming should be started
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MA_ERROR_NONE Successful
@@ -406,7 +406,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 need to be stopped streaming
+ * @param[in] type The type of audio streaming data for which the streaming should be stopped
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #MA_ERROR_NONE Successful
@@ -417,7 +417,7 @@ 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 Updates the client's voice feedback state to the server.
+ * @brief Sends an update of the client's voice feedback state to the server.
  * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -449,7 +449,7 @@ int ma_update_voice_feedback_state(ma_voice_feedback_state_e state);
 int ma_send_assistant_specific_command(const char* command);
 
 /**
- * @brief Sets a wakeup engine command callback.
+ * @brief Sets the wakeup engine command callback.
  * @since_tizen 5.5
  *
  * @param[in] callback The callback
@@ -468,7 +468,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 a wakeup engine command callback.
+ * @brief Unsets the wakeup engine command callback.
  * @since_tizen 5.5
  *
  * @return @c 0 on success, otherwise a negative error value

diff --git a/include/multi_assistant_ui.h b/include/multi_assistant_ui.h
index ac7f6b3056c76ce959bb7b6a0ce61724b25ec7e7..2186640cce8d032934b32202f39be473ed7b1f23 100644 (file)
--- a/include/multi_assistant_ui.h
+++ b/include/multi_assistant_ui.h
@@ -104,7 +104,7 @@ typedef void (*ma_ui_result_cb)(const char* display_text, const char* utterance_
 typedef void (*ma_ui_change_assistant_cb)(const char* app_id, void* user_data);
 
 /**
- * @brief Called when the multi-assistant service sends the recognition results for showing at UI.
+ * @brief Called when the multi-assistant service sends the recognition results.
  * @since_tizen 5.5
  *
  * @param[in] result The recognition result