From 8583c92ee68c848b376d957422299d4b43eb00ac Mon Sep 17 00:00:00 2001 From: Jiyoung Yun Date: Fri, 22 May 2015 12:57:09 +0900 Subject: [PATCH] capi-system-device: Update since_tizen string for Tizen 2.3.1 APIs Change-Id: I322d445af6a2abe5334d199a31a2506c37abe964 Signed-off-by: Jiyoung Yun --- include/battery.h | 10 +++++----- include/callback.h | 8 ++++---- include/device-error.h | 1 + include/display.h | 14 +++++++------- include/haptic.h | 10 +++++----- include/led.h | 12 ++++++------ include/power.h | 8 ++++---- 7 files changed, 32 insertions(+), 31 deletions(-) diff --git a/include/battery.h b/include/battery.h index 4449e4d..6692181 100755 --- a/include/battery.h +++ b/include/battery.h @@ -33,7 +33,7 @@ extern "C" { /** * @brief Enumeration for the battery level status. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -49,8 +49,8 @@ typedef enum * @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 2.3 - * + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * * @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) @@ -68,7 +68,7 @@ int device_battery_get_percent(int *percent); /** * @brief Gets the charging state. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[out] charging The battery charging state * @@ -88,7 +88,7 @@ int device_battery_is_charging(bool *charging); /** * @brief Gets the battery level status. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[out] status The battery level status * diff --git a/include/callback.h b/include/callback.h index 3394862..45f6cf7 100755 --- a/include/callback.h +++ b/include/callback.h @@ -33,7 +33,7 @@ extern "C" { /** * @brief Enumeration for the device state callback. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -54,7 +54,7 @@ typedef enum * DEVICE_CALLBACK_BATTERY_CHARGING bool \n * DEVICE_CALLBACK_DISPLAY_STATE int * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[out] type The device type to monitor * @param[out] value The changed value \n @@ -65,7 +65,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] type The device type to monitor * @param[in] callback The callback function to add @@ -84,7 +84,7 @@ int device_add_callback(device_callback_e type, device_changed_cb callback, void /** * @brief Removes a device callback function. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @param[in] type The device type to monitor * @param[in] callback The callback function to remove diff --git a/include/device-error.h b/include/device-error.h index 08dd5b8..cfdaa52 100755 --- a/include/device-error.h +++ b/include/device-error.h @@ -32,6 +32,7 @@ extern "C" { /** * @brief Enumerations of error code for Device. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { diff --git a/include/display.h b/include/display.h index 6d47413..c613949 100755 --- a/include/display.h +++ b/include/display.h @@ -33,7 +33,7 @@ extern "C" { /** * @brief Gets the number of display devices. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -83,7 +83,7 @@ int device_display_get_max_brightness(int display_index, int *max_brightness); /** * @brief Gets the display brightness value. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -110,7 +110,7 @@ int device_display_get_brightness(int display_index, int *brightness); /** * @brief Sets the display brightness value. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -138,7 +138,7 @@ int device_display_set_brightness(int display_index, int brightness); /** * @brief Enumeration for the available display states. * @details An application cannot put the device into the power off state or the suspend state. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -150,7 +150,7 @@ typedef enum /** * @brief Gets the current display state. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -172,7 +172,7 @@ int device_display_get_state(display_state_e *state); /** * @brief Changes the display state by force. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * diff --git a/include/haptic.h b/include/haptic.h index 307b632..fb5a233 100755 --- a/include/haptic.h +++ b/include/haptic.h @@ -43,7 +43,7 @@ typedef void* haptic_effect_h; /** * @brief Gets the number of vibrators. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/haptic * @@ -64,7 +64,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/haptic * @@ -91,7 +91,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/haptic * @@ -114,7 +114,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/haptic * @@ -145,7 +145,7 @@ int device_haptic_vibrate(haptic_device_h device_handle, * @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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/haptic * diff --git a/include/led.h b/include/led.h index 718a4bf..7a659af 100755 --- a/include/led.h +++ b/include/led.h @@ -33,7 +33,7 @@ extern "C" { /** * @brief Gets the max brightness value of a LED that is located next to the camera. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/led * @@ -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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/led * @@ -73,7 +73,7 @@ int device_flash_get_brightness(int *brightness); /** * @brief Sets the brightness value of a LED that is located next to the camera. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/led * @@ -92,7 +92,7 @@ int device_flash_set_brightness(int brightness); /** * @brief Enumeration for custom LED flags. - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { LED_CUSTOM_DUTY_ON = 1 << 0, /**< blink LED */ @@ -102,7 +102,7 @@ typedef enum { /** * @brief Plays the custom effect of the service LED that is located to the front of a device. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/led * @@ -126,7 +126,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/led * diff --git a/include/power.h b/include/power.h index 48d9483..7e1f9a3 100755 --- a/include/power.h +++ b/include/power.h @@ -40,7 +40,7 @@ extern "C" { * POWER_LOCK_DISPLAY ON ON(normal) \n * POWER_LOCK_DISPLAY_DIM ON ON(dim) * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @remarks An application can lock the specific type. * @remarks These enums are mutually exclusive. @@ -58,7 +58,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 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -83,7 +83,7 @@ int device_power_request_lock(power_lock_e type, int timeout_ms); /** * @brief Releases the given lock state locked before. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * @@ -104,7 +104,7 @@ int device_power_release_lock(power_lock_e type); /** * @brief Changes the current power state to the normal/dim state. * - * @since_tizen 2.3 + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/display * -- 2.7.4