device: Change profile version from header files 47/303247/1 accepted/tizen_unified_riscv accepted/tizen/unified/20231228.165729 accepted/tizen/unified/riscv/20240103.054549
authorYunhee Seo <yuni.seo@samsung.com>
Fri, 22 Dec 2023 05:07:22 +0000 (14:07 +0900)
committerYunhee Seo <yuni.seo@samsung.com>
Fri, 22 Dec 2023 05:19:47 +0000 (14:19 +0900)
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>
include/battery.h
include/callback.h
include/device-error.h
include/display-enum.h
include/display-internal.h
include/display.h
include/haptic.h
include/led-internal.h
include/led.h
include/power.h

index 44961bdbdadd988101e1b672dae287771f9c855c..46f8a5c029f8ded87d97ccdc6423a90606613359 100644 (file)
@@ -36,7 +36,7 @@ extern "C" {
 
 /**
  * @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. */
@@ -104,7 +104,7 @@ typedef enum {
  * @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,
@@ -120,7 +120,7 @@ int device_battery_get_percent(int *percent);
 
 /**
  * @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
@@ -137,7 +137,7 @@ int device_battery_is_charging(bool *charging);
 
 /**
  * @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
index 662a87d78d2ac3e0a4832614d602bb60bf68c31d..887855a705dd614c13f31c729517cc6e7543f3b4 100644 (file)
@@ -36,14 +36,14 @@ extern "C" {
 
 /**
  * @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;
 
@@ -58,7 +58,7 @@ typedef enum {
  *          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
@@ -69,7 +69,7 @@ typedef void (*device_changed_cb)(device_callback_e type, void *value, void *use
 
 /**
  * @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
@@ -87,7 +87,7 @@ int device_add_callback(device_callback_e type, device_changed_cb callback, void
 
 /**
  * @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
index 9b7036776863e9afc87bc98630b7fd6654c52cb1..37d2bace65a908401d56fff311b9ecac967e35a6 100644 (file)
@@ -35,7 +35,7 @@ extern "C" {
 
 /**
  * @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 */
index fc455275e41b261cefbcb71d3bfe7fd97ae53001..579c665d18af5208737575a54ca1e91de93080a6 100644 (file)
@@ -10,7 +10,7 @@ extern "C" {
  */
 /**
  * @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.
  */
 
index 58334ed0d4602c05886880619fcd552ac9f1933d..204552904d1e3bb97703e2d0fede0e6b6c28a504 100644 (file)
@@ -86,7 +86,7 @@ typedef enum
 
 /**
  * @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
@@ -109,7 +109,7 @@ int device_display_get_brightness_state(int display_index, display_state_e state
 
 /**
  * @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
@@ -132,7 +132,7 @@ int device_display_get_max_brightness_state(int display_index, display_state_e s
 
 /**
  * @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
@@ -155,7 +155,7 @@ int device_display_set_brightness_state(int display_index, display_state_e state
 
 /**
  * @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
index 7c93b710bf25ce1cf537b758da689a83f56a3461..8aefc13f82ade6e8da8b0990a4b4b9ccbe9eb963 100644 (file)
@@ -35,7 +35,7 @@ extern "C" {
 
 /**
  * @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
@@ -56,7 +56,7 @@ int device_display_get_numbers(int *device_number);
 
 /**
  * @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
@@ -81,7 +81,7 @@ int device_display_get_max_brightness(int display_index, int *max_brightness);
 
 /**
  * @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
@@ -106,7 +106,7 @@ int device_display_get_brightness(int display_index, int *brightness);
 
 /**
  * @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
@@ -132,7 +132,7 @@ int device_display_set_brightness(int display_index, int brightness);
 
 /**
  * @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,
@@ -150,7 +150,7 @@ int device_display_get_state(display_state_e *state);
 
 /**
  * @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.
index 08800fb88a985465a9a80f1f57613354551aa456..58bd052a79c49d09d4a2b53b83302fa2caa44114 100644 (file)
@@ -35,21 +35,21 @@ extern "C" {
 
 /**
  * @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
@@ -67,7 +67,7 @@ int device_haptic_get_count(int *device_number);
 /**
  * @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().
@@ -89,7 +89,7 @@ int device_haptic_open(int device_index, haptic_device_h *device_handle);
 /**
  * @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()
@@ -108,7 +108,7 @@ int device_haptic_close(haptic_device_h device_handle);
 /**
  * @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.
@@ -133,7 +133,7 @@ int device_haptic_vibrate(haptic_device_h device_handle, int duration, int feedb
 /**
  * @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()
index 7a13455f05cbfa2c2bc17eb6cc7f755a174e99a1..0550b35a7cae4a587de4a0959a7fd1ed45072d4d 100644 (file)
@@ -29,7 +29,7 @@ extern "C" {
 
 /**
  * @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
@@ -46,7 +46,7 @@ int device_multi_led_get_number(int *num_of_leds);
 
 /**
  * @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
index 2463f2d1fb4df7c9858d2a5645e9323052bb9103..511c5ae0eeaef2976311edf453daa2a921c615b2 100644 (file)
@@ -35,7 +35,7 @@ extern "C" {
 
 /**
  * @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
@@ -53,7 +53,7 @@ int device_flash_get_max_brightness(int *max_brightness);
 
 /**
  * @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
@@ -71,10 +71,10 @@ int device_flash_get_brightness(int *brightness);
 
 /**
  * @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,
@@ -91,7 +91,7 @@ int device_flash_set_brightness(int brightness);
 
 /**
  * @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 */
@@ -101,7 +101,7 @@ typedef enum {
 
 /**
  * @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
@@ -123,7 +123,7 @@ int device_led_play_custom(int on, int off, unsigned int color, unsigned int fla
 
 /**
  * @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
index f049bf95834b5d326ea6b996413ff3c9cb34fccf..404bb5cc22162c3ff16692516afddc137f69e0d2 100644 (file)
@@ -43,7 +43,7 @@ extern "C" {
  * <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.
@@ -59,7 +59,7 @@ typedef enum {
 /**
  * @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.
@@ -79,7 +79,7 @@ int device_power_request_lock(power_lock_e type, int timeout_ms);
 
 /**
  * @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
@@ -95,9 +95,9 @@ int device_power_release_lock(power_lock_e type);
 
 
 /**
- * @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.