diff options
author | Sam Lantinga <slouken@libsdl.org> | 2009-10-19 13:31:58 +0000 |
---|---|---|
committer | Sam Lantinga <slouken@libsdl.org> | 2009-10-19 13:31:58 +0000 |
commit | d4f444417f1274e1a995416b3504cadcd1d6c8d9 (patch) | |
tree | 957742d59a17333fc3b91de2582ded7a885f21d6 /include/SDL_quit.h | |
parent | 40cb1b33b63d7a2177ed0b0eda8adfc6481186c5 (diff) | |
download | sdl-d4f444417f1274e1a995416b3504cadcd1d6c8d9.tar.gz |
Partial fix for bug #859
Header file update from Ken for improved doxygen output
Diffstat (limited to 'include/SDL_quit.h')
-rw-r--r-- | include/SDL_quit.h | 39 |
1 files changed, 22 insertions, 17 deletions
diff --git a/include/SDL_quit.h b/include/SDL_quit.h index bcf6e3c45..20ff29a19 100644 --- a/include/SDL_quit.h +++ b/include/SDL_quit.h @@ -21,9 +21,9 @@ */ /** - * \file SDL_quit.h - * - * Include file for SDL quit event handling + * \file SDL_quit.h + * + * Include file for SDL quit event handling. */ #ifndef _SDL_quit_h @@ -32,22 +32,27 @@ #include "SDL_stdinc.h" #include "SDL_error.h" -/* - An SDL_QUITEVENT is generated when the user tries to close the application - window. If it is ignored or filtered out, the window will remain open. - If it is not ignored or filtered, it is queued normally and the window - is allowed to close. When the window is closed, screen updates will - complete, but have no effect. - - SDL_Init() installs signal handlers for SIGINT (keyboard interrupt) - and SIGTERM (system termination request), if handlers do not already - exist, that generate SDL_QUITEVENT events as well. There is no way - to determine the cause of an SDL_QUITEVENT, but setting a signal - handler in your application will override the default generation of - quit events for that signal. -*/ +/** + * \file SDL_quit.h + * + * An ::SDL_QUIT event is generated when the user tries to close the application + * window. If it is ignored or filtered out, the window will remain open. + * If it is not ignored or filtered, it is queued normally and the window + * is allowed to close. When the window is closed, screen updates will + * complete, but have no effect. + * + * SDL_Init() installs signal handlers for SIGINT (keyboard interrupt) + * and SIGTERM (system termination request), if handlers do not already + * exist, that generate ::SDL_QUIT events as well. There is no way + * to determine the cause of an ::SDL_QUIT event, but setting a signal + * handler in your application will override the default generation of + * quit events for that signal. + * + * \sa SDL_Quit() + */ /* There are no functions directly affecting the quit event */ + #define SDL_QuitRequested() \ (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK)) |