From: Gilbok Lee Date: Tue, 5 Dec 2023 08:44:36 +0000 (+0900) Subject: Remove profile tag from API description X-Git-Tag: accepted/tizen/9.0/unified/20241030.232422^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=618e7bfe397e7485ed39167fa6f7fecf5e90443a;p=platform%2Fcore%2Fapi%2Fradio.git Remove profile tag from API description [Version] 0.1.19 [Issue Type] update description Change-Id: Ie42176e08c6c32a0c8033a3928ccb49f7fc9d49e --- diff --git a/include/radio.h b/include/radio.h index 679c3e7..a8a65d0 100644 --- a/include/radio.h +++ b/include/radio.h @@ -26,7 +26,7 @@ extern "C" { /** * @file radio.h * @brief This file contains the radio API. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ /** @@ -36,13 +36,13 @@ extern "C" { /** * @brief Radio type handle. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef struct radio_s *radio_h; /** * @brief Enumeration of radio state. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { RADIO_STATE_READY, /**< Ready to play or scan */ @@ -52,7 +52,7 @@ typedef enum { /** * @brief Enumeration of error codes for the radio. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { RADIO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -61,14 +61,14 @@ typedef enum { RADIO_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */ RADIO_ERROR_INVALID_STATE = TIZEN_ERROR_RADIO | 0x01 , /**< Invalid state */ RADIO_ERROR_SOUND_POLICY = TIZEN_ERROR_RADIO | 0x02 , /**< Sound policy error */ - RADIO_ERROR_NO_ANTENNA = TIZEN_ERROR_RADIO | 0x03 , /**< No Antenna error (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */ + RADIO_ERROR_NO_ANTENNA = TIZEN_ERROR_RADIO | 0x03 , /**< No Antenna error (Since 2.4) */ RADIO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ RADIO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ } radio_error_e; /** * @brief Enumeration of radio interrupted type. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 */ typedef enum { RADIO_INTERRUPTED_BY_RESOURCE_CONFLICT = 4, /**< Interrupted by a resource conflict */ @@ -76,7 +76,7 @@ typedef enum { /** * @brief Called when the scan information is updated. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] frequency The tuned radio frequency [87500 ~ 108000] (kHz) * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked by radio_scan_start(). @@ -86,7 +86,7 @@ typedef void (*radio_scan_updated_cb)(int frequency, void *user_data); /** * @brief Called when the radio scan is stopped. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked when the scan is stopped by radio_scan_stop(). * @see radio_scan_stop() @@ -95,7 +95,7 @@ typedef void (*radio_scan_stopped_cb)(void *user_data); /** * @brief Called when the radio scan is completed. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked when the scan is completed by registering this callback using radio_set_scan_completed_cb(). * @see radio_scan_start() @@ -106,7 +106,7 @@ typedef void (*radio_scan_completed_cb)(void *user_data); /** * @brief Called when the radio seek is completed. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] frequency The current frequency [87500 ~ 108000] (kHz) * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked when the radio seek is completed by registering this callback using radio_seek_up() or radio_seek_down(). @@ -117,7 +117,7 @@ typedef void (*radio_seek_completed_cb)(int frequency, void *user_data); /** * @brief Called when the radio is interrupted. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] code The interrupted error code * @param[in] user_data The user data passed from the callback registration function * @see radio_set_interrupted_cb() @@ -127,7 +127,7 @@ typedef void (*radio_interrupted_cb)(radio_interrupted_code_e code, void *user_d /** * @brief Creates a radio handle. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @remarks You must release @a radio using radio_destroy(). * @param[out] radio A new handle to radio * @return @c 0 on success, @@ -143,7 +143,7 @@ int radio_create(radio_h *radio); /** * @brief Destroys the radio handle and releases all its resources. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @remarks To completely shutdown the radio operation, call this function with a valid radio handle. * * @param[in] radio The handle to radio to be destroyed @@ -159,7 +159,7 @@ int radio_destroy(radio_h radio); /** * @brief Gets the radio's current state. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[out] state The current state of the radio * @return @c 0 on success, @@ -172,7 +172,7 @@ int radio_get_state(radio_h radio, radio_state_e *state); /** * @brief Starts playing the radio. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @return @c 0 on success, * otherwise a negative error value @@ -190,7 +190,7 @@ int radio_start(radio_h radio); /** * @brief Stops playing the radio. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @return @c 0 on success, * otherwise a negative error value @@ -207,7 +207,7 @@ int radio_stop(radio_h radio); /** * @brief Seeks up the effective frequency of the radio, asynchronously. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -226,7 +226,7 @@ int radio_seek_up(radio_h radio, radio_seek_completed_cb callback, void *user_da /** * @brief Seeks down the effective frequency of the radio, asynchronously. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -245,7 +245,7 @@ int radio_seek_down(radio_h radio, radio_seek_completed_cb callback, void *user_ /** * @brief Sets the radio frequency. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] frequency The frequency to set [87500 ~ 108000] (kHz) * @return @c 0 on success, @@ -260,7 +260,7 @@ int radio_set_frequency(radio_h radio, int frequency); /** * @brief Gets the current frequency of the radio. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[out] frequency The current frequency [87500 ~ 108000] (kHz) * @return @c 0 on success, @@ -275,7 +275,7 @@ int radio_get_frequency(radio_h radio, int *frequency); /** * @brief Gets the current signal strength of the radio. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[out] strength The current signal strength [-128 ~ 128] (dBm) * @return @c 0 on success, @@ -289,7 +289,7 @@ int radio_get_signal_strength(radio_h radio, int *strength); /** * @brief Starts scanning radio signals, asynchronously. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -312,7 +312,7 @@ int radio_scan_start(radio_h radio, radio_scan_updated_cb callback, void *user_d /** * @brief Stops scanning radio signals, asynchronously. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -333,7 +333,7 @@ int radio_scan_stop(radio_h radio, radio_scan_stopped_cb callback, void *user_da /** * @brief Sets the radio's mute status. * @details If the mute status is @c true, no sounds will be played. If @c false, sounds will be played. Until this function is called, by default the radio is not muted. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] muted The new mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -349,7 +349,7 @@ int radio_set_mute(radio_h radio, bool muted); /** * @brief Gets the radio's mute status. * @details If the mute status is @c true, no sounds are played. If @c false, sounds are played. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[out] muted The current mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -364,7 +364,7 @@ int radio_is_muted(radio_h radio, bool *muted); /** * @brief Sets a callback function to be invoked when the scan finishes. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -382,7 +382,7 @@ int radio_set_scan_completed_cb(radio_h radio, radio_scan_completed_cb callback, /** * @brief Unsets the scan completed callback function. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @return @c 0 on success, * otherwise a negative error value @@ -396,7 +396,7 @@ int radio_unset_scan_completed_cb(radio_h radio); /** * @brief Sets a callback function to be invoked when the radio is interrupted. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -415,7 +415,7 @@ int radio_set_interrupted_cb(radio_h radio, radio_interrupted_cb callback, void /** * @brief Unsets the interrupted callback function. - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @since_tizen 2.3 * @param[in] radio The handle to radio * @return @c 0 on success, * otherwise a negative error value @@ -429,7 +429,7 @@ int radio_unset_interrupted_cb(radio_h radio); /** * @brief Gets the min, max frequency of the region. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @since_tizen 2.4 * @param[in] radio The handle to radio * @param[out] min_freq The min frequency [87500 ~ 108000] (kHz) * @param[out] max_freq The max frequency [87500 ~ 108000] (kHz) @@ -444,7 +444,7 @@ int radio_get_frequency_range(radio_h radio, int *min_freq, int *max_freq); /** * @brief Gets channel spacing. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @since_tizen 2.4 * @param[in] radio The handle to radio * @param[out] channel_spacing The channel spacing value * @return @c 0 on success, diff --git a/packaging/capi-media-radio.spec b/packaging/capi-media-radio.spec index b60aea9..e1a2f4b 100644 --- a/packaging/capi-media-radio.spec +++ b/packaging/capi-media-radio.spec @@ -1,7 +1,7 @@ Name: capi-media-radio Summary: A Radio library in Tizen Native API -Version: 0.1.18 -Release: 1 +Version: 0.1.19 +Release: 0 Group: API/C API License: Apache-2.0 Source0: %{name}-%{version}.tar.gz