[SDL_tizen] add remarks tag and links 00/95400/1
authorDaeKwang Ryu <dkdk.ryu@samsung.com>
Thu, 3 Nov 2016 06:16:02 +0000 (15:16 +0900)
committerDaeKwang Ryu <dkdk.ryu@samsung.com>
Thu, 3 Nov 2016 06:16:02 +0000 (15:16 +0900)
Change-Id: I4856c6845a18ea4250541c71d552d8e8fd1195c2

doc/sdl-tizen_docs.h

index 0516442..0507bde 100644 (file)
  *
  * Remarks :\n
  *   - 5 event types are added for Tizen application framework.\n
- *   - 2 functions are added for Vulkan.
+ *     @remarks #SDL_APP_CONTROL\n
+ *              #SDL_APP_LOWBATTERY\n
+ *              #SDL_APP_LANGUAGE_CHANGED\n
+ *              #SDL_APP_RIGION_CHANGED\n
+ *              #SDL_ROTATEEVENT\n
+ *   - 2 functions are added for Vulkan.\n
+ *     @remarks #SDL_Vulkan_GetInstanceExtensions\n
+ *              #SDL_Vulkan_CreateSurface
  */
 
 /**
@@ -55,19 +62,19 @@ typedef enum
                                      Called on Android in onResume()
                                 */
     SDL_APP_CONTROL,           /**< The application is launching with some arguments.
-                                    @remark Called on Tizen in _tizen_sdl_control().
+                                    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.
-                                    @reamrk Called on Tizen in _tizen_app_low_battery().
+                                    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.
-                                    @remark Called on Tizen in _tizen_app_lang_changed().
+                                    Called on Tizen in _tizen_app_lang_changed().
                                     @since_tizen 3.0
                                 */
     SDL_APP_RIGION_CHANGED,    /**< The application will receive this event, when displayed language is changed by system.
-                                    @remark Called on Tizen in _tizen_app_region_changed().
+                                    Called on Tizen in _tizen_app_region_changed().
                                     @since_tizen 3.0
                                 */
 
@@ -75,7 +82,7 @@ typedef enum
     SDL_WINDOWEVENT    = 0x200, /**< Window state change */
     SDL_SYSWMEVENT,             /**< System specific event */
     SDL_ROTATEEVENT,            /**< Orientation change
-                                     @remark Called on Tizen in _tizen_app_orient_changed().
+                                     Called on Tizen in _tizen_app_orient_changed().
                                      @since_tizen 3.0
                                  */