Modify c header with ACR comment

Change-Id: I23f37b3f1e171b24f911127f72afc4ecae23b62e
Signed-off-by: sungwook79.park <sungwook79.park@samsung.com>

diff --git a/include/tts.h b/include/tts.h
index e8d94a08504b89be17e4c72f0e27aa7f83409ab6..b49b15a591ff54e0d8052cc615a747e39b7558c3 100644 (file)
--- a/include/tts.h
+++ b/include/tts.h
@@ -790,7 +790,7 @@ int tts_pause(tts_h tts);
 int tts_repeat(tts_h tts, char** text_repeat, int* utt_id);
 
 /**
- * @brief Registers a callback function to be called when the TTS state changes.
+ * @brief Sets a callback function to be called when the TTS state changes.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -809,7 +809,7 @@ int tts_set_state_changed_cb(tts_h tts, tts_state_changed_cb callback, void* use
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to be called when the TTS state changes.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -825,7 +825,7 @@ int tts_unset_state_changed_cb(tts_h tts);
 
 
 /**
- * @brief Registers a callback function to detect utterance start.
+ * @brief Sets a callback function to detect utterance start.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -844,7 +844,7 @@ int tts_set_utterance_started_cb(tts_h tts, tts_utterance_started_cb callback, v
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to detect utterance start.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -860,7 +860,7 @@ int tts_unset_utterance_started_cb(tts_h tts);
 
 
 /**
- * @brief Registers a callback function to detect utterance completion.
+ * @brief Sets a callback function to detect utterance completion.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -879,7 +879,7 @@ int tts_set_utterance_completed_cb(tts_h tts, tts_utterance_completed_cb callbac
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to detect utterance completion.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -895,7 +895,7 @@ int tts_unset_utterance_completed_cb(tts_h tts);
 
 
 /**
- * @brief Registers a callback function to detect errors.
+ * @brief Sets a callback function to detect errors.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -914,7 +914,7 @@ int tts_set_error_cb(tts_h tts, tts_error_cb callback, void* user_data);
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to detect errors.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -930,7 +930,7 @@ int tts_unset_error_cb(tts_h tts);
 
 
 /**
- * @brief Registers a callback function to detect default voice change.
+ * @brief Sets a callback function to detect default voice change.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -949,7 +949,7 @@ int tts_set_default_voice_changed_cb(tts_h tts, tts_default_voice_changed_cb cal
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to detect default voice change.
  * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -965,7 +965,7 @@ int tts_unset_default_voice_changed_cb(tts_h tts);
 
 
  /**
- * @brief Registers a callback function to detect the engine change.
+ * @brief Sets a callback function to detect the engine change.
  * @since_tizen 3.0
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
@@ -984,7 +984,7 @@ int tts_set_engine_changed_cb(tts_h tts, tts_engine_changed_cb callback, void* u
 
 
 /**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function to detect the engine change.
  * @since_tizen 3.0
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -1000,7 +1000,7 @@ int tts_unset_engine_changed_cb(tts_h tts);
 
 
 /**
- * @brief Registers a callback function to detect the option of screen reader is changed or not.
+ * @brief Sets a callback function to detect the option of screen reader is changed or not.
  * @since_tizen 6.5
  * @remarks If TTS mode is #TTS_MODE_SCREEN_READER, you should set the callback to check the option of screen reader is changed or not.
  * @param[in] tts The TTS handle
@@ -1020,7 +1020,7 @@ int tts_set_screen_reader_changed_cb(tts_h tts, tts_screen_reader_changed_cb cal
 
 
 /**
- * @brief Unregisters the callback function to detect the option of screen reader is changed or not.
+ * @brief Unsets the callback function to detect the option of screen reader is changed or not.
  * @since_tizen 6.5
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -1055,7 +1055,7 @@ int tts_set_service_state_changed_cb(tts_h tts, tts_service_state_changed_cb cal
 
 
 /**
- * @brief Unsets the callback function.
+ * @brief Unsets the callback function to be called when the TTS service state changes.
  * @since_tizen 7.0
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
@@ -1098,6 +1098,7 @@ int tts_set_playing_mode(tts_h tts, tts_playing_mode_e mode);
  *         otherwise a negative error value
  * @retval #TTS_ERROR_NONE Successful
  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
+ * @retval #TTS_ERROR_PERMISSION_DENIED Permission denied
  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TTS_ERROR_INVALID_STATE Invalid state
  * @pre The TTS state should be #TTS_STATE_CREATED.
@@ -1124,11 +1125,11 @@ int tts_unset_synthesized_pcm_cb(tts_h tts);
 
 
 /**
- * @brief Add silence for the specified amount of time
+ * @brief Adds silence for the specified amount of time
  * @since_tizen 9.0
  * @remarks The maximum silent time is 5000 msec. If you want to perform a silent time of more than 5000 msec, call this function several times.
  * @param[in] tts The TTS handle
- * @param[in] duration_in_ms The duration of the silence
+ * @param[in] duration_in_msec The duration of the silence
  * @param[out] utt_id The utterance ID passed to the callback function
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -1137,9 +1138,10 @@ int tts_unset_synthesized_pcm_cb(tts_h tts);
  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TTS_ERROR_INVALID_STATE Invalid state
  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
+ * @retval #TTS_ERROR_SCREEN_READER_OFF Screen reader is turned off
  * @pre The state should be #TTS_STATE_READY, #TTS_STATE_PLAYING, or #TTS_STATE_PAUSED.
 */
-int tts_add_silent_utterance(tts_h tts, unsigned int duration_in_ms, int* utt_id);
+int tts_add_silent_utterance(tts_h tts, unsigned int duration_in_msec, int* utt_id);
 
 #ifdef __cplusplus
 }