Add remarks for additional privileges

Change-Id: I3ce6765012901624f928e0c86c80a0248d0e6dea
Signed-off-by: sooyeon <sooyeon.kim@samsung.com>

diff --git a/include/vce.h b/include/vce.h
index 851dddd..4509c32 100644 (file)
--- a/include/vce.h
+++ b/include/vce.h
@@ -688,7 +688,8 @@ typedef struct {
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
- * @remarks The service_app_main() should be used for working the engine after this function.
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0. \n
+ *          The service_app_main() should be used for working the engine after this function.
  * 
  * @param[in] argc The argument count(original)
  * @param[in] argv The argument(original)
@@ -796,8 +797,10 @@ int vce_main(int argc, char** argv, vce_request_callback_s* callback);
 /**
  * @brief Sends the results to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @param[in] event A result event
  * @param[in] result_id Result ids
@@ -823,8 +826,10 @@ int vce_send_result(vce_result_event_e event, int* result_id, int count, const c
 /**
  * @brief Sends the ASR result to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @param[in] event A asr result event
  * @param[in] asr_result A asr result text
@@ -842,8 +847,10 @@ int vce_send_asr_result(vce_asr_result_event_e event, const char* asr_result, vo
 /**
  * @brief Sends the NLG (Natural Language Generation) result to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @param[in] nlg_result A nlg result
  * @param[in] user_data The user data passed from the start
@@ -860,8 +867,10 @@ int vce_send_nlg_result(const char* nlg_result, void* user_data);
 /**
  * @brief Sends the specific engine result to the engine service user.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  *
  * @param[in] engine_app_id A specific engine's app id
  * @param[in] event A specific engine result event
@@ -894,8 +903,10 @@ int vce_send_specific_engine_result(const char* engine_app_id, const char* event
  *          #VCE_ERROR_NOT_SUPPORTED_FEATURE \n
  *          #VCE_ERROR_TTS_FAILED.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @param[in] error Error type
  * @param[in] msg Error message
@@ -1045,6 +1056,7 @@ int vce_get_audio_type(char** audio_type);
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @param[in] key Private key
  * @param[in] data Private data
@@ -1066,7 +1078,8 @@ int vce_set_private_data(const char* key, const char* data);
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
- * @remarks The @a data must be released using free() when it is no longer required.
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0. \n
+ *          The @a data must be released using free() when it is no longer required.
  * 
  * @param[in] key Private key
  * @param[out] data Private data
@@ -1088,6 +1101,7 @@ int vce_get_private_data(const char* key, char** data);
  * @privilege %http://tizen.org/privilege/recorder
  *            %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  * 
  * @return 0 on success, otherwise a negative error value.
  * @retval #VCE_ERROR_NONE Successful
@@ -1115,8 +1129,10 @@ int vce_stop_recording(void);
 /**
  * @brief Sends audio formats necessary for playing TTS feedback.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  *
  * @param[in] rate A sampling rate
  * @param[in] channel The audio channel
@@ -1134,8 +1150,10 @@ int vce_send_feedback_audio_format(int rate, vce_audio_channel_e channel, vce_au
 /**
  * @brief Sends audio streaming necessary for playing TTS feedback.
  * @since_tizen @if MOBILE 4.0 @elseif WEARABLE 5.0 @endif
+ * @privlevel public
  * @privilege %http://tizen.org/privilege/appmanager.launch (Since 7.0)
  *            %http://tizen.org/privilege/datasharing (Since 7.0)
+ * @remarks To use this function, privileges of appmanager.launch and datasharing should be included since 7.0.
  *
  * @param[in] event A feedback event
  * @param[in] buffer The feedback data