As profiles are integrated, there is no need to mark versions separately.
Thus, the version has been changed based on mobile.
Change-Id: I22bdc4c1910f9d890a4c28fbea82b2e2a4f2faf4
Signed-off-by: Yunhee Seo <yuni.seo@samsung.com>
/**
* @brief Enumeration for the battery level status.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
DEVICE_BATTERY_LEVEL_EMPTY = 0, /**< The battery goes empty. Prepare for the safe termination of the application, because the device starts a shutdown process soon after entering this level. */
* @brief Gets the battery charge percentage.
* @details It returns an integer value from @c 0 to @c 100 that indicates remaining battery charge
* as a percentage of the maximum level.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks In order to be notified when the battery state changes, use system_info_set_changed_cb().
* @param[out] percent The remaining battery charge percentage (@c 0 ~ @c 100)
* @return @c 0 on success,
/**
* @brief Gets the charging state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[out] charging The battery charging state
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the battery level status.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[out] status The battery level status
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Enumeration for the device state callback.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
DEVICE_CALLBACK_BATTERY_CAPACITY, /**< Called when a battery charge percentage is changed */
DEVICE_CALLBACK_BATTERY_LEVEL, /**< Called when a battery level is changed */
DEVICE_CALLBACK_BATTERY_CHARGING, /**< Called when battery charging state is changed */
DEVICE_CALLBACK_DISPLAY_STATE, /**< Called when a display state is changed */
- DEVICE_CALLBACK_FLASH_BRIGHTNESS, /**< Called when a flash brightness is changed (Since Tizen @if Mobile 2.4 @elseif WEARABLE 3.0 @endif) */
+ DEVICE_CALLBACK_FLASH_BRIGHTNESS, /**< Called when a flash brightness is changed (Since Tizen 2.4) */
DEVICE_CALLBACK_MAX,
} device_callback_e;
* DEVICE_CALLBACK_BATTERY_CHARGING bool \n
* DEVICE_CALLBACK_DISPLAY_STATE int \n
* DEVICE_CALLBACK_FLASH_BRIGHTNESS int
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks DEVICE_CALLBACK_FLASH_BRIGHTNESS callback invoked when user set flash brightness by using device_flash_set_brightness(). It does not work by camera flash operation. To register DEVICE_CALLBACK_FLASH_BRIGHTNESS callback, you need to declare the LED privilege (%http://tizen.org/privilege/led).
* @param[out] type The device type to monitor
* @param[out] value The changed value
/**
* @brief Adds a callback to the observing device state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The following feature should be supported for #DEVICE_CALLBACK_DISPLAY_STATE: %http://tizen.org/feature/display. Otherwise #DEVICE_ERROR_NOT_SUPPORTED is returned.
* @param[in] type The device type to monitor
* @param[in] callback The callback function to add
/**
* @brief Removes a device callback function.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The following feature should be supported for #DEVICE_CALLBACK_DISPLAY_STATE: %http://tizen.org/feature/display. Otherwise #DEVICE_ERROR_NOT_SUPPORTED is returned.
* @param[in] type The device type to monitor
* @param[in] callback The callback function to remove
/**
* @brief Enumeration for device's error code.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
DEVICE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
*/
/**
* @brief Enumeration for the available display states.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks #DISPLAY_STATE_SCREEN_DIM may be ignored if the DIM state is disabled on the platform.
*/
/**
* @brief Gets the display brightness value.
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @param[in] display_index The index of the display \n
/**
* @brief Gets the maximum brightness value that can be set.
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @param[in] display_index The index of the display \n
/**
* @brief Sets the display brightness value.
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @param[in] display_index The index of the display \n
/**
* @brief Change display state by a specific reason
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @param[in] type The type is display state to change\n
/**
* @brief Gets the number of display devices.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display
/**
* @brief Gets the maximum brightness value that can be set.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
/**
* @brief Gets the display brightness value.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
/**
* @brief Sets the display brightness value.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display \n
/**
* @brief Gets the current display state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks #DEVICE_ERROR_NOT_SUPPORTED is returned, when the following feature is not supported: %http://tizen.org/feature/display
* @param[out] state The display state
* @return @c 0 on success,
/**
* @brief Changes the display state by force.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks This API triggers display change process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.
/**
* @brief The haptic device handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* haptic_device_h;
/**
* @brief The haptic effect handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* haptic_effect_h;
/**
* @brief Gets the number of vibrators.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
* @param[in] device_number The number of vibrators
/**
* @brief Opens a haptic-vibration device.
* @details Internally, it makes a connection to the vibrator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
* @remarks You must close the Haptic API using device_haptic_close().
/**
* @brief Closes a haptic-vibration device.
* @details Internally, it disconnects the connection to the vibrator.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
* @param[in] device_handle The device handle from device_haptic_open()
/**
* @brief Vibrates during the specified time with a constant intensity.
* @details This function can be used to start monotonous vibration for the specified time.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
* @remarks @a feedback level is reserved for auto changing to save variable in the settings.
/**
* @brief Stops all vibration effects which are being played.
* @details This function can be used to stop all effects started by device_haptic_vibrate().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/haptic
* @param[in] device_handle The device handle from device_haptic_open()
/**
* @brief Gets the total number of LEDs in the device.
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
/**
* @brief Plays multiple LEDs at the same time.
- * @since_tizen @if MOBILE 5.0 @elseif WEARABLE 5.0 @endif
+ * @since_tizen 5.0
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
/**
* @brief Gets the max brightness value of a LED that is located next to the camera.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
/**
* @brief Gets the brightness value of a LED that is located next to the camera.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
/**
* @brief Sets the brightness value of a LED that is located next to the camera.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/led
- * @remarks Since @if Mobile 2.4 @elseif WEARABLE 3.0 @endif, this API check camera flash status whether camera API preempted flash or not, so it could be failed if flash was preempted by camera API. In this case, API will return #DEVICE_ERROR_RESOURCE_BUSY error.
+ * @remarks Since 2.4, this API check camera flash status whether camera API preempted flash or not, so it could be failed if flash was preempted by camera API. In this case, API will return #DEVICE_ERROR_RESOURCE_BUSY error.
* This API is related to the following feature: %http://tizen.org/feature/camera.back.flash
* @param[in] brightness The brightness value of LED (@c 0 ~ MAX)
* @return @c 0 on success,
/**
* @brief Enumeration for custom LED flags.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
LED_CUSTOM_DUTY_ON = 1 << 0, /**< blink LED */
/**
* @brief Plays the custom effect of the service LED that is located to the front of a device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
/**
* @brief Stops the custom effect of the service LED that is located to the front of a device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/led
* @remarks This API is related to the following feature: %http://tizen.org/feature/led
* <TR><TD>POWER_LOCK_DISPLAY</TD><TD>ON</TD><TD>ON(Normal)</TD></TR>
* <TR><TD>POWER_LOCK_DISPLAY_DIM</TD><TD>ON</TD><TD>ON(Dim)</TD></TR>
* </TABLE>
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks An application can lock the specific type.
* @remarks These enums are mutually exclusive.
* @remarks You cannot combine with an enum below.
/**
* @brief Locks the given lock state for a specified time.
* @details After the given @a timeout_ms (in milliseconds), unlock the given lock state automatically.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks If the process dies, then every lock will be removed.
/**
* @brief Releases the given lock state which was locked before.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @param[in] type The power type to release lock
/**
- * @deprecated Deprecated Since @if WEARABLE 3.0 @else 2.4 @endif
+ * @deprecated Deprecated Since 2.4
* @brief Changes the current power state to the normal/dim state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/display
* @remarks This API triggers turn on process and then updates the status when it completes. While the operation is on-going, the device_display_get_state() function returns previous display state.