Fix description of voice control APIs

- Issue:
Some description for APIs does not explain exact behavior of each APIs.

- Solution:
This patch fixes the description of these APIs:
  - vc_set_invocation_name()
  - vc_set_server_dialog()
  - vc_unset_server_dialog()
  - vc_request_dialog()
  - vc_get_result()
  - vc_unset_result_cb()
  - vc_tts_set_utterance_status_cb()
  - vc_mgr_specific_engine_result_cb()
  - vc_mgr_get_current_commands()
  - vc_mgr_set_selected_results()
  - vc_mgr_set_all_result_cb()
  - vc_mgr_get_error_message()
The description of these APIs did not explain exact behavior of each
APIs.
And also, this patch fixes the order of retval to follow doxygen guide.

Change-Id: I4e1f0ab1db7cb4ecd7422315a7714f053aaf7d89
Signed-off-by: Suyeon Hwang <stom.hwang@samsung.com>

diff --git a/include/voice_control.h b/include/voice_control.h
index ab80ca2..df8843d 100644 (file)
--- a/include/voice_control.h
+++ b/include/voice_control.h
@@ -90,10 +90,10 @@ extern "C"
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @post If this function is called, the state will be #VC_STATE_INITIALIZED.
  * @see vc_deinitialize()
  */
@@ -108,10 +108,10 @@ int vc_initialize(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_initialize()
  */
 int vc_deinitialize(void);
@@ -125,10 +125,10 @@ int vc_deinitialize(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @retval #VC_ERROR_OPERATION_FAILED Operation failure
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @post If this function is called, the state will be #VC_STATE_READY.
  * @see vc_unprepare()
@@ -144,9 +144,9 @@ int vc_prepare(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_READY.
  * @post If this function is called, the state will be #VC_STATE_INITIALIZED.
  * @see vc_prepare()
@@ -164,11 +164,11 @@ int vc_unprepare(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_OPERATION_FAILED Operation failure
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED or #VC_STATE_READY.
  * @post This function invokes vc_supported_language_cb() repeatedly for getting languages.
  * @see vc_supported_language_cb()
@@ -189,12 +189,12 @@ int vc_foreach_supported_languages(vc_supported_language_cb callback, void* user
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #VC_ERROR_OPERATION_FAILED Operation failure
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED or #VC_STATE_READY.
  * @see vc_foreach_supported_languages()
  */
@@ -210,9 +210,9 @@ int vc_get_current_language(char** language);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_state_changed_cb()
  * @see vc_set_state_changed_cb()
  */
@@ -228,9 +228,9 @@ int vc_get_state(vc_state_e* state);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @pre The state should be #VC_STATE_READY.
  * @see vc_set_service_state_changed_cb()
  * @see vc_unset_service_state_changed_cb()
@@ -250,10 +250,10 @@ int vc_get_service_state(vc_service_state_e* state);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The service state should be #VC_SERVICE_STATE_READY.
  * @see vc_cmd_list_destroy()
  */
@@ -262,23 +262,23 @@ int vc_get_system_command_list(vc_cmd_list_h* vc_sys_cmd_list);
 
 /**
  * @brief Sets the invocation name.
- * @since_tizen 3.0
- * @privlevel public
- * @privilege %http://tizen.org/privilege/recorder
- * @remarks Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
+ * @details Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
  *          For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample".
  *          In order to activate the background command, users can say "Tizen Sample, Play music".
  *          The invocation name is dependent on the current language. For example, if the current language is "en_US"(English), the invocation name is also "en_US".
  *          If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized.
  *          This function should be called before vc_set_command_list().
+ * @since_tizen 3.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a name is @c NULL, the invocation name will be unset.
  * @param[in] name Invocation name that an application wants to be invoked by
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_READY.
  * @see vc_set_command_list()
  */
@@ -293,15 +293,17 @@ int vc_set_invocation_name(const char* name);
  * @since_tizen 5.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework.
+ *          However, getting app ID may be failed.
  * @param[in] app_id App id which is to want to ask server dialog.
  * @param[in] credential Credential key.
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The service state should be #VC_SERVICE_STATE_READY.
  * @see vc_unset_server_dialog()
  */
@@ -314,14 +316,16 @@ int vc_set_server_dialog(const char* app_id, const char* credential);
  * @since_tizen 5.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
+ * @remarks If @a app_id is @c NULL, the API tries to get app ID using app manager framework.
+ *          However, getting app ID may be failed.
  * @param[in] app_id App id which is to not want to ask server dialog.
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The service state should be #VC_SERVICE_STATE_READY.
  * @see vc_set_server_dialog()
  */
@@ -340,16 +344,17 @@ int vc_unset_server_dialog(const char* app_id);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @remarks If @a auto_start is @c true, the recognition will start again. In this case, it can be restarted up to 4 times.
+ *          @a disp_text and @a utt_text allow @c NULL. However, it is not allowed to set both @a disp_text and @a utt_text as @c NULL.
  * @param[in] disp_text Text to be displayed on the screen
  * @param[in] utt_text Text to be spoken
  * @param[in] auto_start A variable for setting whether the dialog session will be restarted automatically or not
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The service state should be #VC_SERVICE_STATE_READY.
  */
 int vc_request_dialog(const char* disp_text, const char* utt_text, bool auto_start);
@@ -367,10 +372,10 @@ int vc_request_dialog(const char* disp_text, const char* utt_text, bool auto_sta
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_READY.
  * @see vc_unset_command_list()
  */
@@ -386,10 +391,10 @@ int vc_set_command_list(vc_cmd_list_h vc_cmd_list, int type);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_READY.
  * @see vc_set_command_list()
  */
@@ -406,9 +411,10 @@ int vc_unset_command_list(int type);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_READY.
  * @see vc_result_cb()
  */
@@ -416,7 +422,7 @@ int vc_get_result(vc_result_cb callback, void* user_data);
 
 
 /**
- * @brief Registers a callback function for getting recognition result.
+ * @brief Sets a callback function for getting recognition result.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -425,10 +431,10 @@ int vc_get_result(vc_result_cb callback, void* user_data);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_result_cb()
  * @see vc_unset_result_cb()
@@ -437,15 +443,16 @@ int vc_set_result_cb(vc_result_cb callback, void* user_data);
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_set_result_cb()
  */
@@ -453,7 +460,7 @@ int vc_unset_result_cb(void);
 
 
 /**
- * @brief Registers a callback function to be called when state is changed.
+ * @brief Sets a callback function to be called when service state is changed.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -462,10 +469,10 @@ int vc_unset_result_cb(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_service_state_changed_cb()
  * @see vc_unset_service_state_changed_cb()
@@ -474,16 +481,16 @@ int vc_set_service_state_changed_cb(vc_service_state_changed_cb callback, void*
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_set_service_state_changed_cb()
  */
@@ -491,7 +498,7 @@ int vc_unset_service_state_changed_cb(void);
 
 
 /**
- * @brief Registers a callback function to be called when state is changed.
+ * @brief Sets a callback function to be called when state is changed.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -500,10 +507,10 @@ int vc_unset_service_state_changed_cb(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_state_changed_cb()
  * @see vc_unset_state_changed_cb()
@@ -512,16 +519,16 @@ int vc_set_state_changed_cb(vc_state_changed_cb callback, void* user_data);
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_set_state_changed_cb()
  */
@@ -529,7 +536,7 @@ int vc_unset_state_changed_cb(void);
 
 
 /**
- * @brief Registers a callback function to be called when current language is changed.
+ * @brief Sets a callback function to be called when current language is changed.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -538,10 +545,10 @@ int vc_unset_state_changed_cb(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_current_language_changed_cb()
  * @see vc_unset_current_language_changed_cb()
@@ -550,16 +557,16 @@ int vc_set_current_language_changed_cb(vc_current_language_changed_cb callback,
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_set_current_language_changed_cb()
  */
@@ -567,7 +574,7 @@ int vc_unset_current_language_changed_cb(void);
 
 
 /**
- * @brief Registers a callback function to be called when an error occurred.
+ * @brief Sets a callback function to be called when an error occurred.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
@@ -576,10 +583,10 @@ int vc_unset_current_language_changed_cb(void);
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_error_cb()
  * @see vc_unset_error_cb()
@@ -588,16 +595,16 @@ int vc_set_error_cb(vc_error_cb callback, void* user_data);
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/recorder
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_STATE Invalid state
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #VC_ERROR_INVALID_STATE Invalid state
  * @pre The state should be #VC_STATE_INITIALIZED.
  * @see vc_set_error_cb()
  */
@@ -721,7 +728,7 @@ int vc_tts_unset_streaming_cb(void);
  * @brief Sets the TTS utterance status callback function.
  * @details Using this function, the developer can set the utterance status callback to be called
  *          when the VC manager client starts or stops playing TTS PCM data which was requested to be synthesized with the vc_tts_request() function.
- *          This function is called when @a to_vc_manager in the vc_tts_request() function call is @c true.
+ *          This function is called when to_vc_manager in the vc_tts_request() function call is @c true.
  * @since_tizen 5.5
  * @privlevel partner
  * @privilege %http://tizen.org/privilege/voicecontrol.tts

diff --git a/include/voice_control_command.h b/include/voice_control_command.h
index d5fcfc2..e1f64af 100644 (file)
--- a/include/voice_control_command.h
+++ b/include/voice_control_command.h
@@ -88,6 +88,7 @@ typedef struct vc_cmd_list_s* vc_cmd_list_h;
 /**
  * @brief Called to retrieve The commands in list.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @remarks @a vc_command should not be released. It is managed by the framework and will be released when invoking this callback is finished.
  * @param[in] vc_command The command handle
  * @param[in] user_data The user data passed from the foreach function
  * @return @c true to continue with the next iteration of the loop,
@@ -101,15 +102,14 @@ typedef bool (*vc_cmd_list_cb)(vc_cmd_h vc_command, void* user_data);
 /**
  * @brief Creates a handle for command list.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks If the function succeeds, @a The list handle must be released with vc_cmd_list_destroy().
+ * @remarks If the function succeeds, @a vc_cmd_list must be released with vc_cmd_list_destroy().
  * @param[out] vc_cmd_list The command list handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
  * @see vc_cmd_list_destroy()
  */
 int vc_cmd_list_create(vc_cmd_list_h* vc_cmd_list);
@@ -121,12 +121,11 @@ int vc_cmd_list_create(vc_cmd_list_h* vc_cmd_list);
  * @param[in] vc_cmd_list The command list handle
  * @param[in] free_command The command free option @c true = release each commands in list,
  *                                                 @c false = remove command from list
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_list_create()
  */
 int vc_cmd_list_destroy(vc_cmd_list_h vc_cmd_list, bool free_command);
@@ -137,12 +136,11 @@ int vc_cmd_list_destroy(vc_cmd_list_h vc_cmd_list, bool free_command);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
  * @param[out] count The count
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int vc_cmd_list_get_count(vc_cmd_list_h vc_cmd_list, int* count);
 
@@ -152,12 +150,11 @@ int vc_cmd_list_get_count(vc_cmd_list_h vc_cmd_list, int* count);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
  * @param[in] vc_command The command handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_list_remove()
  */
 int vc_cmd_list_add(vc_cmd_list_h vc_cmd_list, vc_cmd_h vc_command);
@@ -168,12 +165,11 @@ int vc_cmd_list_add(vc_cmd_list_h vc_cmd_list, vc_cmd_h vc_command);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
  * @param[in] vc_command The command handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_list_add()
  */
 int vc_cmd_list_remove(vc_cmd_list_h vc_cmd_list, vc_cmd_h vc_command);
@@ -185,12 +181,11 @@ int vc_cmd_list_remove(vc_cmd_list_h vc_cmd_list, vc_cmd_h vc_command);
  * @param[in] vc_cmd_list The command list handle
  * @param[in] callback Callback function to invoke
  * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @post This function invokes vc_cmd_list_cb() repeatedly for getting commands.
  * @see vc_cmd_list_cb()
  */
@@ -201,13 +196,12 @@ int vc_cmd_list_foreach_commands(vc_cmd_list_h vc_cmd_list, vc_cmd_list_cb callb
  * @brief Moves index to first command.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_EMPTY List empty
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_cmd_list_last()
  */
 int vc_cmd_list_first(vc_cmd_list_h vc_cmd_list);
@@ -217,13 +211,12 @@ int vc_cmd_list_first(vc_cmd_list_h vc_cmd_list);
  * @brief Moves index to last command.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_EMPTY List empty
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_cmd_list_first()
  */
 int vc_cmd_list_last(vc_cmd_list_h vc_cmd_list);
@@ -233,14 +226,13 @@ int vc_cmd_list_last(vc_cmd_list_h vc_cmd_list);
  * @brief Moves index to next command.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_EMPTY List empty
  * @retval #VC_ERROR_ITERATION_END List reached end
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_cmd_list_prev()
  */
 int vc_cmd_list_next(vc_cmd_list_h vc_cmd_list);
@@ -250,31 +242,30 @@ int vc_cmd_list_next(vc_cmd_list_h vc_cmd_list);
  * @brief Moves index to previous command.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_cmd_list The command list handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_EMPTY List empty
  * @retval #VC_ERROR_ITERATION_END List reached end
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_cmd_list_next()
  */
 int vc_cmd_list_prev(vc_cmd_list_h vc_cmd_list);
 
 
 /**
- * @brief Get current command from command list by index.
+ * @brief Gets current command from command list by index.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @remarks @a vc_command should be released after removing it from @a vc_cmd_list with vc_cmd_list_remove().
  * @param[in] vc_cmd_list The command list handle
  * @param[out] vc_command The command handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
+ * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #VC_ERROR_EMPTY List empty
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
- * @retval #VC_ERROR_NOT_SUPPORTED Not supported
  * @see vc_cmd_list_first()
  * @see vc_cmd_list_last()
  * @see vc_cmd_list_prev()
@@ -286,18 +277,16 @@ int vc_cmd_list_get_current(vc_cmd_list_h vc_cmd_list, vc_cmd_h* vc_command);
 /**
  * @brief Creates a handle for command.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks If the function succeeds, @a The command handle must be released
- *          with vc_cmd_destroy() or vc_cmd_list_destroy().
+ * @remarks If the function succeeds, @a vc_command must be released with vc_cmd_destroy() or vc_cmd_list_destroy().
  *          You should set command and type if command is valid.
  *          The command format is set to #VC_COMMAND_FORMAT_FIXED by default and can be changed with vc_cmd_set_format().
  * @param[out] vc_command The command handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #VC_ERROR_OUT_OF_MEMORY Out of memory
  * @see vc_cmd_destroy()
  */
 int vc_cmd_create(vc_cmd_h* vc_command);
@@ -307,12 +296,11 @@ int vc_cmd_create(vc_cmd_h* vc_command);
  * @brief Destroys the handle.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_command The command handle
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_create()
  */
 int vc_cmd_destroy(vc_cmd_h vc_command);
@@ -323,12 +311,11 @@ int vc_cmd_destroy(vc_cmd_h vc_command);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_command The command handle
  * @param[in] command The command or action text
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_get_command()
  */
 int vc_cmd_set_command(vc_cmd_h vc_command, const char* command);
@@ -340,12 +327,11 @@ int vc_cmd_set_command(vc_cmd_h vc_command, const char* command);
  * @remarks If the function succeeds, @a command must be released with free() by you if they are not NULL.
  * @param[in] vc_command The command handle
  * @param[out] command The command text
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_set_command()
  */
 int vc_cmd_get_command(vc_cmd_h vc_command, char** command);
@@ -359,12 +345,11 @@ int vc_cmd_get_command(vc_cmd_h vc_command, char** command);
  *         This function should be used for commands which have non-fixed format.
  * @param[in] vc_command The command handle
  * @param[out] command The unfixed command text
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported feature
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  */
 int vc_cmd_get_unfixed_command(vc_cmd_h vc_command, char** command);
 
@@ -376,12 +361,11 @@ int vc_cmd_get_unfixed_command(vc_cmd_h vc_command, char** command);
  *         You should set type if command is valid
  * @param[in] vc_command The command handle
  * @param[in] type The command type
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_get_type()
  */
 int vc_cmd_set_type(vc_cmd_h vc_command, int type);
@@ -392,12 +376,11 @@ int vc_cmd_set_type(vc_cmd_h vc_command, int type);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] vc_command The command handle
  * @param[out] type The command type
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_set_type()
  */
 int vc_cmd_get_type(vc_cmd_h vc_command, int* type);
@@ -409,12 +392,11 @@ int vc_cmd_get_type(vc_cmd_h vc_command, int* type);
  * @remarks The default format is #VC_COMMAND_FORMAT_FIXED.
  * @param[in] vc_command The command handle
  * @param[in] format The command format
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported feature
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_get_format()
  */
 int vc_cmd_set_format(vc_cmd_h vc_command, int format);
@@ -426,12 +408,11 @@ int vc_cmd_set_format(vc_cmd_h vc_command, int format);
  * @remarks The default format is #VC_COMMAND_FORMAT_FIXED.
  * @param[in] vc_command The command handle
  * @param[out] format The command format
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #VC_ERROR_NONE Successful
- * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
  * @retval #VC_ERROR_NOT_SUPPORTED Not supported feature
+ * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
  * @see vc_cmd_set_format()
  */
 int vc_cmd_get_format(vc_cmd_h vc_command, int* format);

diff --git a/include/voice_control_manager.h b/include/voice_control_manager.h
index 8978908..2d2f18c 100644 (file)
--- a/include/voice_control_manager.h
+++ b/include/voice_control_manager.h
@@ -157,8 +157,8 @@ typedef enum {
  * @brief Called when client gets the all recognition results from voice control service.
  * @since_tizen 5.0
  *
- * @remarks The @a vc_cmd_list should not be released. It is managed by the platform and will be released when invoking this callback is finished. \n
- *      The @a result and @a msg are also managed by the platform and will be released when invoking this callback is finished.
+ * @remarks The @a vc_cmd_list should not be released. It is managed by the framework and will be released when invoking this callback is finished. \n
+ *      The @a result and @a msg are also managed by the framework and will be released when invoking this callback is finished.
  *
  * @param[in] event         The result event
  * @param[in] vc_cmd_list   Command list handle
@@ -179,7 +179,7 @@ typedef bool (*vc_mgr_all_result_cb)(vc_result_event_e event, vc_cmd_list_h vc_c
  * @brief Called when client gets the pre recognition results (partial ASR) from voice control service.
  * @since_tizen 5.0
  *
- * @remarks The @a result is managed by the platform and will be released when invoking this callback is finished.
+ * @remarks The @a result is managed by the framework and will be released when invoking this callback is finished.
  *
  * @param[in] event       The pre result event
  * @param[in] result      ASR text
@@ -196,6 +196,8 @@ typedef void (*vc_mgr_pre_result_cb)(vc_pre_result_event_e event, const char *re
  * @brief Called when client gets the specific engine's result from vc-service.
  * @since_tizen 5.0
  *
+ * @remarks The @a engine_app_id, @a event and @a result are managed by the framework and will be released when invoking this callback is finished.
+ *
  * @param[in] engine_app_id The specific engine's app id
  * @param[in] event The specific engine event type
  * @param[in] result The specific engine result
@@ -226,7 +228,7 @@ typedef void (*vc_mgr_begin_speech_detected_cb)(void *user_data);
  * @brief Called when an application (VC client) requests dialog.
  * @since_tizen 5.0
  *
- * @remarks The @a disp_text and @a utt_text are managed by the platform and will be released when invoking this callback is finished.
+ * @remarks The @a disp_text and @a utt_text are managed by the framework and will be released when invoking this callback is finished.
  *
  * @param[in] pid          Pid of VC client to request dialog
  * @param[in] disp_text    Text requested to be displayed
@@ -245,7 +247,7 @@ typedef void (*vc_mgr_dialog_request_cb)(int pid, const char *disp_text, const c
  * @brief Called when engine sets private data to manager client.
  * @since_tizen 5.0
  *
- * @remarks The @a key and @a data are managed by the platform and will be released when invoking this callback is finished.
+ * @remarks The @a key and @a data are managed by the framework and will be released when invoking this callback is finished.
  *
  * @param[in] key         Private key
  * @param[in] data        Private data
@@ -262,7 +264,7 @@ typedef int (*vc_mgr_private_data_set_cb)(const char *key, const char *data, voi
  * @brief Called when engine requests private data from manager client.
  * @since_tizen 5.0
  *
- * @remarks The @a data should not be released. The @a data and @a key are managed by the platform and will be released when invoking this callback is finished.
+ * @remarks The @a data should not be released. The @a data and @a key are managed by the framework and will be released when invoking this callback is finished.
  *
  * @param[in]  key         Private key
  * @param[out] data        Private data
@@ -663,7 +665,7 @@ int vc_mgr_set_preloaded_commands_from_file(const char *file_path);
  *
  * @remarks If the function succeeds, @a vc_cmd_list must be released with vc_cmd_list_destroy(vc_cmd_list, true).
  *
- * @param[in] vc_cmd_list   The command list
+ * @param[out] vc_cmd_list   The command list
  *
  * @return 0 on success, otherwise a negative error value
  * @retval #VC_ERROR_NONE                Successful
@@ -992,8 +994,7 @@ int vc_mgr_get_recording_volume(float *volume);
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/voicecontrol.manager
  *
- * @remarks This function should be called in vc_mgr_all_result_cb().
- *      Or this function should be called after that vc_mgr_all_result_cb() returns @c false.
+ * @remarks This function should be called when vc_mgr_all_result_cb() returns @c false.
  *      The @a vc_cmd_list can be NULL, in that case the function does nothing.
  * @param[in] vc_cmd_list   The valid result list
  *
@@ -1018,6 +1019,8 @@ int vc_mgr_set_selected_results(vc_cmd_list_h vc_cmd_list);
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/voicecontrol.manager
  *
+ * @remarks This callback must be set. Without this callback, the framework can not deliver the result of voice recognition to proper client.
+ *
  * @param[in] callback    Callback function to register
  * @param[in] user_data   The user data to be passed to the callback function
  *
@@ -1383,7 +1386,7 @@ int vc_mgr_unset_current_language_changed_cb(void);
  * @retval #VC_ERROR_PERMISSION_DENIED   Permission denied
  * @retval #VC_ERROR_INVALID_PARAMETER   Invalid parameter
  * @retval #VC_ERROR_INVALID_STATE       Invalid state
- * @retval $VC_ERROR_OPERATION_FAILED    Operation failure
+ * @retval #VC_ERROR_OPERATION_FAILED    Operation failure
  * @retval #VC_ERROR_OUT_OF_MEMORY       Out of memory
  *
  * @see vc_error_cb()