Mercurial > sdl-ios-xcode
comparison include/SDL_active.h @ 4217:4c4113c2162c SDL-1.2
Fixed bug #706
Ken Bull 2009-02-25 13:22:02 PST
Adds Doxygen support for all headers (except config and boilerplate headers) in
the include folder for SDL-1.2 revision 4446.
While in general SDL is quite thoroughly commented, none of these comments are
correctly formatted for Doxygen and are generally inconsistent in their
formatting.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 21 Sep 2009 09:38:10 +0000 |
parents | a1b03ba2fcd0 |
children |
comparison
equal
deleted
inserted
replaced
4216:5b99971a27b4 | 4217:4c4113c2162c |
---|---|
18 | 18 |
19 Sam Lantinga | 19 Sam Lantinga |
20 slouken@libsdl.org | 20 slouken@libsdl.org |
21 */ | 21 */ |
22 | 22 |
23 /* Include file for SDL application focus event handling */ | 23 /** |
24 * @file SDL_active.h | |
25 * Include file for SDL application focus event handling | |
26 */ | |
24 | 27 |
25 #ifndef _SDL_active_h | 28 #ifndef _SDL_active_h |
26 #define _SDL_active_h | 29 #define _SDL_active_h |
27 | 30 |
28 #include "SDL_stdinc.h" | 31 #include "SDL_stdinc.h" |
32 /* Set up for C function definitions, even when using C++ */ | 35 /* Set up for C function definitions, even when using C++ */ |
33 #ifdef __cplusplus | 36 #ifdef __cplusplus |
34 extern "C" { | 37 extern "C" { |
35 #endif | 38 #endif |
36 | 39 |
37 /* The available application states */ | 40 /** @name The available application states */ |
38 #define SDL_APPMOUSEFOCUS 0x01 /* The app has mouse coverage */ | 41 /*@{*/ |
39 #define SDL_APPINPUTFOCUS 0x02 /* The app has input focus */ | 42 #define SDL_APPMOUSEFOCUS 0x01 /**< The app has mouse coverage */ |
40 #define SDL_APPACTIVE 0x04 /* The application is active */ | 43 #define SDL_APPINPUTFOCUS 0x02 /**< The app has input focus */ |
44 #define SDL_APPACTIVE 0x04 /**< The application is active */ | |
45 /*@}*/ | |
41 | 46 |
42 /* Function prototypes */ | 47 /* Function prototypes */ |
43 /* | 48 /** |
44 * This function returns the current state of the application, which is a | 49 * This function returns the current state of the application, which is a |
45 * bitwise combination of SDL_APPMOUSEFOCUS, SDL_APPINPUTFOCUS, and | 50 * bitwise combination of SDL_APPMOUSEFOCUS, SDL_APPINPUTFOCUS, and |
46 * SDL_APPACTIVE. If SDL_APPACTIVE is set, then the user is able to | 51 * SDL_APPACTIVE. If SDL_APPACTIVE is set, then the user is able to |
47 * see your application, otherwise it has been iconified or disabled. | 52 * see your application, otherwise it has been iconified or disabled. |
48 */ | 53 */ |