From 9347307f211620aa74eda0d0e84e72d7fcb2e47d Mon Sep 17 00:00:00 2001 From: "huiyu.eun" Date: Thu, 27 Jul 2017 13:16:22 +0900 Subject: [PATCH] [SDL_Tizen] Modify SDL-Tizen docs Modify SDL-Tizen docs Change-Id: I868d401457daa6c94a147e49861a1e3e974cc156 Signed-off-by: huiyu.eun --- doc/sdl-tizen_docs.h | 77 ++++++++++++++-------------------------------------- 1 file changed, 21 insertions(+), 56 deletions(-) diff --git a/doc/sdl-tizen_docs.h b/doc/sdl-tizen_docs.h index d6307b9..e00c36a 100644 --- a/doc/sdl-tizen_docs.h +++ b/doc/sdl-tizen_docs.h @@ -55,7 +55,7 @@ /** * @brief The types of events that can be delivered. -.* @since_tizen 3.0 + * @since_tizen 3.0 */ typedef enum { @@ -65,63 +65,28 @@ typedef enum SDL_QUIT = 0x100, /**< User-requested quit */ /* These application events have special meaning on iOS, see README-ios.md for details */ - SDL_APP_TERMINATING, /**< The application is being terminated by the OS - Called on iOS in applicationWillTerminate() - Called on Android in onDestroy() - */ - SDL_APP_LOWMEMORY, /**< The application is low on memory, free memory if possible. - Called on iOS in applicationDidReceiveMemoryWarning() - Called on Android in onLowMemory() - */ - SDL_APP_WILLENTERBACKGROUND, /**< The application is about to enter the background - Called on iOS in applicationWillResignActive() - Called on Android in onPause() - */ - SDL_APP_DIDENTERBACKGROUND, /**< The application did enter the background and may not get CPU for some time - Called on iOS in applicationDidEnterBackground() - Called on Android in onPause() - */ - SDL_APP_WILLENTERFOREGROUND, /**< The application is about to enter the foreground - Called on iOS in applicationWillEnterForeground() - Called on Android in onResume() - */ - SDL_APP_DIDENTERFOREGROUND, /**< The application is now interactive - Called on iOS in applicationDidBecomeActive() - Called on Android in onResume() - */ - SDL_APP_CONTROL, /**< The application is launching with some arguments. - Called on Tizen in _tizen_sdl_control(). - @since_tizen 3.0 - */ - SDL_APP_LOWBATTERY, /**< The application is low on battery, reduce power consumption if possible. - Called on Tizen in _tizen_app_low_battery(). - @since_tizen 3.0 - */ - SDL_APP_LANGUAGE_CHANGED, /**< The application receives this event, when displayed language is changed by system. - Called on Tizen in _tizen_app_lang_changed(). - @since_tizen 3.0 - */ - SDL_APP_REGION_CHANGED, /**< The application will receive this event, when displayed language is changed by system. - Called on Tizen in _tizen_app_region_changed(). - @since_tizen 3.0 - */ + SDL_APP_TERMINATING, /**< The application is being terminated by the OS */ + SDL_APP_LOWMEMORY, /**< The application is low on memory, free memory if possible. */ + SDL_APP_WILLENTERBACKGROUND, /**< The application is about to enter the background */ + SDL_APP_DIDENTERBACKGROUND, /**< The application did enter the background and may not get CPU for some time */ + SDL_APP_WILLENTERFOREGROUND, /**< The application is about to enter the foreground */ + SDL_APP_DIDENTERFOREGROUND, /**< The application is now interactive */ + SDL_APP_CONTROL, /**< The application is launching with some arguments. */ + SDL_APP_LOWBATTERY, /**< The application is low on battery, reduce power consumption if possible. */ + SDL_APP_LANGUAGE_CHANGED, /**< The application receives this event, when displayed language is changed by system. */ + SDL_APP_REGION_CHANGED, /**< The application will receive this event, when displayed language is changed by system. */ /* Window events */ SDL_WINDOWEVENT = 0x200, /**< Window state change */ SDL_SYSWMEVENT, /**< System specific event */ - SDL_ROTATEEVENT, /**< Orientation change - Called on Tizen in _tizen_app_orient_changed(). - @since_tizen 3.0 - */ + SDL_ROTATEEVENT, /**< Orientation change */ /* Keyboard events */ SDL_KEYDOWN = 0x300, /**< Key pressed */ SDL_KEYUP, /**< Key released */ SDL_TEXTEDITING, /**< Keyboard text editing (composition) */ SDL_TEXTINPUT, /**< Keyboard text input */ - SDL_KEYMAPCHANGED, /**< Keymap changed due to a system event such as an - input language or keyboard layout change. - */ + SDL_KEYMAPCHANGED, /**< Keymap changed due to a system event such as an input language or keyboard layout change. */ /* Mouse events */ SDL_MOUSEMOTION = 0x400, /**< Mouse moved */ @@ -147,14 +112,14 @@ typedef enum SDL_CONTROLLERDEVICEREMAPPED, /**< The controller mapping was updated */ /* Touch events */ - SDL_FINGERDOWN = 0x700, - SDL_FINGERUP, - SDL_FINGERMOTION, + SDL_FINGERDOWN = 0x700, /**< User has touched input device */ + SDL_FINGERUP, /**< User stopped touching input device */ + SDL_FINGERMOTION, /**< User is dragging finger on input device */ /* Gesture events */ - SDL_DOLLARGESTURE = 0x800, - SDL_DOLLARRECORD, - SDL_MULTIGESTURE, + SDL_DOLLARGESTURE = 0x800, /**< User made a dollar gesture. */ + SDL_DOLLARRECORD, /**< When recording a gesture with SDL_RecordGesture, the user made a dollar gesture that was recorded. */ + SDL_MULTIGESTURE, /**< Multiple finger gesture event */ /* Clipboard events */ SDL_CLIPBOARDUPDATE = 0x900, /**< The clipboard changed */ @@ -237,7 +202,7 @@ typedef enum } SDL_SYSWM_TYPE; /** - * @brief Set opacity of Tizen-specific indicator. + * @brief Sets opacity of Tizen-specific indicator. * * @details The variable can be one of * "#opaque" - Opacifies the indicator @@ -279,7 +244,7 @@ extern DECLSPEC int SDLCALL SDL_tizen_app_init(int argc, char *argv[]); extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions(SDL_Window* window, unsigned* count, char** names); /** - * @brief Creates Vulkan surface + * @brief Creates Vulkan surface. * * @since_tizen 3.0 * -- 2.7.4