From: sooyeon <sooyeon.kim@samsung.com>
Date: Wed, 6 Dec 2023 01:58:05 +0000 (+0900)
Subject: Update since_tizen in header files
X-Git-Tag: accepted/tizen/unified/20240207.171607~6
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=be6c756260345c999055a62b1130c9798c9b01c1;p=platform%2Fcore%2Fuifw%2Ftts.git

Update since_tizen in header files

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

diff --git a/include/tts.h b/include/tts.h
index 95430aef..bd4e452b 100644
--- a/include/tts.h
+++ b/include/tts.h
@@ -40,7 +40,7 @@ extern "C" {
 
 /**
  * @brief Enumeration for error code.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef enum {
 	TTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
@@ -56,15 +56,15 @@ typedef enum {
 	TTS_ERROR_ENGINE_NOT_FOUND = TIZEN_ERROR_TTS | 0x03, /**< No available engine */
 	TTS_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */
 	TTS_ERROR_AUDIO_POLICY_BLOCKED = TIZEN_ERROR_TTS | 0x05, /**< Audio policy blocked */
-	TTS_ERROR_NOT_SUPPORTED_FEATURE	= TIZEN_ERROR_TTS | 0x06, /**< Not supported feature of current engine @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */
-	TTS_ERROR_SERVICE_RESET = TIZEN_ERROR_TTS | 0x07, /**< Service reset @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */
+	TTS_ERROR_NOT_SUPPORTED_FEATURE	= TIZEN_ERROR_TTS | 0x06, /**< Not supported feature of current engine (Since 3.0) */
+	TTS_ERROR_SERVICE_RESET = TIZEN_ERROR_TTS | 0x07, /**< Service reset (Since 3.0) */
 	TTS_ERROR_SCREEN_READER_OFF = TIZEN_ERROR_TTS | 0x08 /**< Screen reader is off (Since 6.5) */
 } tts_error_e;
 
 
 /**
  * @brief Enumeration for TTS mode.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef enum {
 	TTS_MODE_DEFAULT = 0, /**< Default mode for normal application */
@@ -75,7 +75,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef enum {
 	TTS_STATE_CREATED = 0, /**< 'CREATED' state */
@@ -132,42 +132,42 @@ typedef enum {
 
 /**
  * @brief Definition for automatic speaking speed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 #define TTS_SPEED_AUTO		0
 
 
 /**
  * @brief Definition for automatic voice type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 #define TTS_VOICE_TYPE_AUTO	0
 
 
 /**
  * @brief Definition for male voice type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 #define TTS_VOICE_TYPE_MALE	1
 
 
 /**
  * @brief Definition for female voice type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 #define TTS_VOICE_TYPE_FEMALE	2
 
 
 /**
  * @brief Definition for child voice type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 #define TTS_VOICE_TYPE_CHILD	3
 
 
 /**
  * @brief The TTS handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
 */
 typedef struct tts_s *tts_h;
 
@@ -176,7 +176,7 @@ typedef struct tts_s *tts_h;
  * @brief Called when the state of TTS is changed.
  * @details If the daemon must stop player because of changing engine and
  *          the daemon must pause player because of other requests, this callback function is called.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] previous The previous state
  * @param[in] current The current state
@@ -190,7 +190,7 @@ typedef void (*tts_state_changed_cb)(tts_h tts, tts_state_e previous, tts_state_
 
 /**
  * @brief Called when utterance has started.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] utt_id The utterance ID passed from the add text function
  * @param[in] user_data The user data passed from the callback registration function
@@ -204,7 +204,7 @@ typedef void (*tts_utterance_started_cb)(tts_h tts, int utt_id, void* user_data)
 
 /**
  * @brief Called when utterance is finished.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] utt_id The utterance ID passed from the add text function
  * @param[in] user_data The user data passed from the callback registration function
@@ -218,7 +218,7 @@ typedef void (*tts_utterance_completed_cb)(tts_h tts, int utt_id, void *user_dat
 
 /**
  * @brief Called when an error occurs.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] utt_id The utterance ID passed from the add text function
  * @param[in] reason The error code
@@ -235,7 +235,7 @@ typedef void (*tts_error_cb)(tts_h tts, int utt_id, tts_error_e reason, void* us
 
 /**
  * @brief Called to retrieve the supported voice.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] language Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
  * @param[in] voice_type A voice type (e.g. #TTS_VOICE_TYPE_MALE, #TTS_VOICE_TYPE_FEMALE)
@@ -250,7 +250,7 @@ typedef bool(*tts_supported_voice_cb)(tts_h tts, const char* language, int voice
 
 /**
  * @brief Called when the default voice is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] previous_language The previous language
  * @param[in] previous_voice_type The previous voice type
@@ -265,7 +265,7 @@ typedef void (*tts_default_voice_changed_cb)(tts_h tts, const char* previous_lan
 
 /**
  * @brief Called when the engine is changed.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @param[in] tts The TTS handle
  * @param[in] engine_id Engine ID
  * @param[in] language The default language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
@@ -324,7 +324,7 @@ typedef void (*tts_synthesized_pcm_cb)(tts_h tts, int utt_id, tts_synthesized_pc
 
 /**
  * @brief Creates a handle for TTS.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks If the function succeeds, @a tts handle must be released with tts_destroy().
  * @param[out] tts The TTS handle
  * @return @c 0 on success,
@@ -343,7 +343,7 @@ int tts_create(tts_h* tts);
 
 /**
  * @brief Destroys the handle and disconnects the daemon.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -358,7 +358,7 @@ int tts_destroy(tts_h tts);
 
 /**
  * @brief Sets the TTS mode.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] mode The mode
  * @return @c 0 on success,
@@ -376,7 +376,7 @@ int tts_set_mode(tts_h tts, tts_mode_e mode);
 
 /**
  * @brief Gets the TTS mode.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[out] mode The mode
  * @return @c 0 on success,
@@ -396,7 +396,7 @@ int tts_get_mode(tts_h tts, tts_mode_e* mode);
  * @details Using this API, the application can set a credential.
  *          The credential is a key to verify the authorization about using the engine.
  *          If the application sets the credential, it will be able to use functions of the engine entirely.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @remarks The necessity of the credential depends on the engine. In case of the engine which is basically embedded in Tizen, the credential is not necessary so far.
  *          However, if the user wants to apply the 3rd party's engine, the credential may be necessary. In that case, please follow the policy provided by the corresponding engine.
  * @param[in] tts The TTS handle
@@ -415,7 +415,7 @@ int tts_set_credential(tts_h tts, const char* credential);
 
 /**
  * @brief Connects the daemon asynchronously.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -434,7 +434,7 @@ int tts_prepare(tts_h tts);
 
 /**
  * @brief Disconnects the daemon.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -469,7 +469,7 @@ int tts_prepare_sync(tts_h tts);
 
 /**
  * @brief Retrieves all supported voices of the current engine using callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to invoke
  * @param[in] user_data The user data to be passed to the callback function
@@ -488,7 +488,7 @@ int tts_foreach_supported_voices(tts_h tts, tts_supported_voice_cb callback, voi
 
 /**
  * @brief Gets the default voice set by the user.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks If the function succeeds, @a language must be released with free().
  * @param[in] tts The TTS handle
  * @param[out] language Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
@@ -511,7 +511,7 @@ int tts_get_default_voice(tts_h tts, char** language, int* voice_type);
  *          Using this API, the application can set the private data and use the corresponding key of the engine.
  *          For example, if the engine provides 'girl's voice' as a voice type, the application can set the private data as the following.
  *          int ret = tts_set_private_data(#tts_h, "voice_type", "GIRL");
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @remarks If the engine is replaced with the other engine, the key may be ignored.
  * @param[in] tts The TTS handle
  * @param[in] key The field name of private data
@@ -534,7 +534,7 @@ int tts_set_private_data(tts_h tts, const char* key, const char* data);
  * @brief Gets the private data from tts engine.
  * @details The private data is the information provided by the engine.
  *          Using this API, the application can get the private data which corresponds to the key from the engine.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @remarks The @a data must be released using free() when it is no longer required.
  *          If the engine is replaced with the other engine, the key may be ignored.
  * @param[in] tts The TTS handle
@@ -556,7 +556,7 @@ int tts_get_private_data(tts_h tts, const char* key, char** data);
 
 /**
  * @brief Gets the maximum byte size for text.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[out] size The maximum byte size for text
  * @return @c 0 on success,
@@ -574,7 +574,7 @@ int tts_get_max_text_size(tts_h tts, unsigned int* size);
 
 /**
  * @brief Gets the current state of TTS.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[out] state The current state of TTS
  * @return @c 0 on success,
@@ -591,7 +591,7 @@ int tts_get_state(tts_h tts, tts_state_e* state);
 
 /**
  * @brief Gets the speed range.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[out] min The minimum speed value
  * @param[out] normal The normal speed value
@@ -611,7 +611,7 @@ int tts_get_speed_range(tts_h tts, int* min, int* normal, int* max);
 
 /**
  * @brief Gets the current error message.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @remarks This function should be called from a tts error callback. Calling in any other context will result in an Operation failed error.
  *          A successful call will allocate @a err_msg, which must be released by calling free() when it is no longer required.
  * @param[in] tts The TTS handle
@@ -669,7 +669,7 @@ int tts_check_screen_reader_on(tts_h tts, bool* is_on);
 
 /**
  * @brief Adds a text to the queue.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @remarks Locale(e.g. setlocale()) MUST be set for utf8 text validation check.
  * @param[in] tts The TTS handle
  * @param[in] text An input text based utf8
@@ -696,7 +696,7 @@ int tts_add_text(tts_h tts, const char* text, const char* language, int voice_ty
 
 /**
  * @brief Starts synthesizing voice from the text and plays the synthesized audio data.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -723,7 +723,7 @@ int tts_play(tts_h tts);
 
 /**
  * @brief Stops playing the utterance and clears the queue.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -744,7 +744,7 @@ int tts_stop(tts_h tts);
 
 /**
  * @brief Pauses the currently playing utterance.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -791,7 +791,7 @@ 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.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -810,7 +810,7 @@ int tts_set_state_changed_cb(tts_h tts, tts_state_changed_cb callback, void* use
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -826,7 +826,7 @@ int tts_unset_state_changed_cb(tts_h tts);
 
 /**
  * @brief Registers a callback function to detect utterance start.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -845,7 +845,7 @@ int tts_set_utterance_started_cb(tts_h tts, tts_utterance_started_cb callback, v
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -861,7 +861,7 @@ int tts_unset_utterance_started_cb(tts_h tts);
 
 /**
  * @brief Registers a callback function to detect utterance completion.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -880,7 +880,7 @@ int tts_set_utterance_completed_cb(tts_h tts, tts_utterance_completed_cb callbac
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -896,7 +896,7 @@ int tts_unset_utterance_completed_cb(tts_h tts);
 
 /**
  * @brief Registers a callback function to detect errors.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -915,7 +915,7 @@ int tts_set_error_cb(tts_h tts, tts_error_cb callback, void* user_data);
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -931,7 +931,7 @@ int tts_unset_error_cb(tts_h tts);
 
 /**
  * @brief Registers a callback function to detect default voice change.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -950,7 +950,7 @@ int tts_set_default_voice_changed_cb(tts_h tts, tts_default_voice_changed_cb cal
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -966,7 +966,7 @@ int tts_unset_default_voice_changed_cb(tts_h tts);
 
  /**
  * @brief Registers a callback function to detect the engine change.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @param[in] tts The TTS handle
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
@@ -985,7 +985,7 @@ int tts_set_engine_changed_cb(tts_h tts, tts_engine_changed_cb callback, void* u
 
 /**
  * @brief Unregisters the callback function.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
  * @param[in] tts The TTS handle
  * @return @c 0 on success,
  *         otherwise a negative error value
diff --git a/include/tts_internal.h b/include/tts_internal.h
index 11850c33..d92275e2 100644
--- a/include/tts_internal.h
+++ b/include/tts_internal.h
@@ -39,7 +39,7 @@ extern "C"
  * @details Using this API, the application can ask server tts with a credential.
  *  The credential is a key to verify the authorization about using the engine based on server, not embedded engine.
  *  If the application sets the credential, it will be able to use functions of the server engine entirely.
- * @since_tizen @if MOBILE 3.0
+ * @since_tizen 3.0
  *
  * @remarks The necessity of the credential depends on the engine. In case of the engine which is basically embedded in Tizen, the credential is not necessary so far.
  *  However, if the user wants to apply the 3rd party's engine, the credential may be necessary. In that case, please follow the policy provided by the corresponding engine.