From: Ji-hoon Lee <dalton.lee@samsung.com>
Date: Fri, 5 Apr 2019 06:29:19 +0000 (+0900)
Subject: Update doxygen documentation
X-Git-Tag: submit/tizen/20190418.072452~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F56%2F202856%2F2;p=platform%2Fcore%2Fuifw%2Fmulti-assistant.git

Update doxygen documentation

Change-Id: I7e28a69a05a8db90b89e7ab53301fd37b2620e67
---

diff --git a/include/multi_assistant.h b/include/multi_assistant.h
index 5d8d75b..051406c 100644
--- a/include/multi_assistant.h
+++ b/include/multi_assistant.h
@@ -338,6 +338,7 @@ int ma_send_result(const char* display_text, const char* utterance_text, const c
  * @brief Sends recognition result to the multi-assistant service.
  * @since_tizen 5.5
  * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
  *
  * @param[in] result The recognition result
  *
@@ -384,45 +385,58 @@ int ma_set_active_state_changed_cb(ma_active_state_changed_cb callback, void* us
 int ma_unset_active_state_changed_cb(void);
 
 /**
- * @brief Start receiving audio streaming data.
+ * @brief Starts receiving audio streaming data.
  * @since_tizen 5.5
  * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ *
+ * @param[in] type The type of audio streaming data need to be started streaming
  *
  * @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_PERMISSION_DENIED Permission denied
+ * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int ma_start_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type);
 
 /**
- * @brief Stop receiving audio streaming data.
+ * @brief Stops receiving audio streaming data.
  * @since_tizen 5.5
  * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ *
+ * @param[in] type The type of audio streaming data need to be stopped streaming
  *
  * @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_PERMISSION_DENIED Permission denied
+ * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int ma_stop_receiving_audio_streaming_data(ma_audio_streaming_data_type_e type);
 
 /**
- * @brief Update the client's voice feedback state to the server.
+ * @brief Updates the client's voice feedback state to the server.
  * @since_tizen 5.5
  * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ *
+ * @param[in] state The current voice feedback state
  *
  * @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_PERMISSION_DENIED Permission denied
+ * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int ma_update_voice_feedback_state(ma_voice_feedback_state_e state);
 
 /**
- * @brief Send assistant-specific command to the server.
+ * @brief Sends assistant-specific command to the server.
  * @since_tizen 5.5
  * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
  *
  * @param[in] command The command to be sent to the server
  *
@@ -430,6 +444,7 @@ int ma_update_voice_feedback_state(ma_voice_feedback_state_e state);
  * @retval #MA_ERROR_NONE Successful
  * @retval #MA_ERROR_NOT_SUPPORTED Not supported
  * @retval #MA_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MA_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int ma_send_assistant_specific_command(const char* command);
 
@@ -453,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 active state changed callback.
+ * @brief Unsets a wakeup engine command callback.
  * @since_tizen 5.5
  *
  * @return @c 0 on success, otherwise a negative error value
diff --git a/include/multi_assistant_common.h b/include/multi_assistant_common.h
index 72db430..b8059b4 100644
--- a/include/multi_assistant_common.h
+++ b/include/multi_assistant_common.h
@@ -218,6 +218,7 @@ typedef void (*ma_active_state_changed_cb)(ma_active_state_e previous, ma_active
 /**
  * @brief Called when a wakeup engine specific command is retrieved.
  * @since_tizen 5.5
+ * @remarks The @a command should not be released and can be used only in the callback. To use outside, make a copy.
  *
  * @param[in] command The wakeup engine specific command
  * @param[in] user_data The user data passed from the callback registration function