efl_util: Remove version branching by profile

[platform/core/api/efl-util.git] / include / efl_util.h

diff --git a/include/efl_util.h b/include/efl_util.h
index ed8755d..5e15849 100644 (file)
--- a/include/efl_util.h
+++ b/include/efl_util.h
@@ -44,7 +44,7 @@ extern "C" {
 
 /**
  * @brief Enumeration for EFL UTIL ERROR.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum
 {
@@ -52,31 +52,31 @@ typedef enum
    EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
    EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
    EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
-   EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+   EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: 2.4) */
+   EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: 2.4) */
+   EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: 2.4) */
    EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01, /**< Window type not supported */
-   EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL = TIZEN_ERROR_EFL_UTIL | 0x02,  /**< @platform Screenshot initialization fail (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03,  /**< @platform Screenshot execution fail (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+   EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL = TIZEN_ERROR_EFL_UTIL | 0x02,  /**< @platform Screenshot initialization fail (@b Since: 2.4) */
+   EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03,  /**< @platform Screenshot execution fail (@b Since: 2.4) */
    EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE = TIZEN_ERROR_EFL_UTIL | 0x04 /**< Resource is not available (@b Since: 4.0) */
 } efl_util_error_e;
 
 /**
  * @brief Enumeration of notification window's priority level.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  */
 typedef enum
 {
-   EFL_UTIL_NOTIFICATION_LEVEL_NONE    = -1, /**< No (reset) notification level. This value makes the window place in normal layer. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM  = 20, /**< Higher notification level than default. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_NOTIFICATION_LEVEL_HIGH    = 30, /**< Higher notification level than medium. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
-   EFL_UTIL_NOTIFICATION_LEVEL_TOP     = 40  /**< The highest notification level. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+   EFL_UTIL_NOTIFICATION_LEVEL_NONE    = -1, /**< No (reset) notification level. This value makes the window place in normal layer. (@b Since: 2.4) */
+   EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: 2.4) */
+   EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM  = 20, /**< Higher notification level than default. (@b Since: 2.4) */
+   EFL_UTIL_NOTIFICATION_LEVEL_HIGH    = 30, /**< Higher notification level than medium. (@b Since: 2.4) */
+   EFL_UTIL_NOTIFICATION_LEVEL_TOP     = 40  /**< The highest notification level. (@b Since: 2.4) */
 } efl_util_notification_level_e;
 
 /**
  * @brief Enumeration of screen mode.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  */
 typedef enum
 {
@@ -86,11 +86,11 @@ typedef enum
 
 /**
  * @brief Sets the priority level for the specified notification window.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/window.priority.set
  * @remarks This API can be used for a notification type window only.
- *          Up to the version @if WEARABLE 2.3.1 @else 2.4 @endif, it supports as async APIs.
+ *          Up to the version 2.4, it supports as async APIs.
  *          But it is synchronous call since Tizen 3.0
  * @param[in] window The EFL window
  * @param[in] level The notification window level
@@ -104,10 +104,10 @@ API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_not
 
 /**
  * @brief Gets the priority level for the specified notification window.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks This API can be used for a notification type window only.
- *          Up to the version @if WEARABLE 2.3.1 @else 2.4 @endif, it supports as async APIs.
+ *          Up to the version 2.4, it supports as async APIs.
  *          But it is synchronous call since Tizen 3.0
  * @param[in] window The EFL window
  * @param[out] level The notification window level
@@ -124,7 +124,7 @@ API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_not
  *          If the alpha window sets the visual state to the opaque,
  *          then the window manager could handle it as the opaque window while calculating visibility.
  *          This API will have no effect when used by a non-alpha window.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @param[in] window The EFL window
  * @param[in] opaque The value that indicates whether the window has set a visual state to opaque (0: unset, 1: set)
  * @return @c 0 on success, otherwise a negative error value
@@ -140,7 +140,7 @@ API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
  *          the window manager requests the display system to keep the display on as long as the window is shown.
  *          If the window is no longer shown, then the window manger request the display system to go back to normal operation.
  *          Default screen mode of window is #EFL_UTIL_SCREEN_MODE_DEFAULT.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/display
  * @remarks This API needs the privilege.
@@ -156,7 +156,7 @@ API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mod
 
 /**
  * @brief Gets the screen mode of the specified window.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @param[in] window The EFL window
  * @param[out] mode The screen mode
  * @return @c 0 on success, otherwise a negative error value
@@ -213,7 +213,7 @@ API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
  /**
   * @platform
   * @brief Definition for the input generator handle.
-  * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+  * @since_tizen 2.4
   */
 
  typedef struct _efl_util_inputgen_h * efl_util_inputgen_h;
@@ -221,7 +221,7 @@ API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
 /**
  * @platform
  * @brief Enumeration of device type generated events.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  */
 typedef enum
 {
@@ -237,7 +237,7 @@ typedef enum
 /**
  * @platform
  * @brief Enumeration of touch event types.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  */
 typedef enum
 {
@@ -274,7 +274,7 @@ typedef enum
 /**
    * @platform
    * @brief Initializes system and check input generate functions are supported, open devices generated events.
-   * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+   * @since_tizen 2.4
    * @privlevel platform
    * @privilege %http://tizen.org/privilege/inputgenerator
    * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
@@ -361,7 +361,7 @@ API int efl_util_input_set_touch_count(int max_count);
 /**
    * @platform
    * @brief Deinitializes system and close opened devices.
-   * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+   * @since_tizen 2.4
    * @privlevel platform
    * @privilege %http://tizen.org/privilege/inputgenerator
    * @param[in] inputgen_h The #efl_util_inputgen_h handle
@@ -376,7 +376,7 @@ API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h);
 /**
    * @platform
    * @brief Generates all of key events using a opened device.
-   * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+   * @since_tizen 2.4
    * @privlevel platform
    * @privilege %http://tizen.org/privilege/inputgenerator
    * @param[in] inputgen_h The #efl_util_inputgen_h handle
@@ -392,7 +392,7 @@ API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *
 /**
    * @platform
    * @brief Generates a touch event using a opened device.
-   * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+   * @since_tizen 2.4
    * @privlevel platform
    * @privilege %http://tizen.org/privilege/inputgenerator
    * @param[in] inputgen_h The #efl_util_inputgen_h handle
@@ -500,14 +500,14 @@ API int efl_util_input_generate_touch_axis(efl_util_inputgen_h inputgen_h, int i
 /**
  * @platform
  * @brief Definition for the screenshot handle.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  */
 typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
 
 /**
  * @platform
  * @brief Initializes the screenshot.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/screenshot
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -528,7 +528,7 @@ API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
 /**
  * @platform
  * @brief Takes a screenshot and get a tbm_surface handle.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/screenshot
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -548,7 +548,7 @@ API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h scr
 /**
  * @platform
  * @brief Deinitializes the screenshot.
- * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @since_tizen 2.4
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/screenshot
  * @param[in]  screenshot  #efl_util_screenshot_h handle