summaryrefslogtreecommitdiff
path: root/src/SDL12/include/SDL_quit.h
diff options
context:
space:
mode:
authorTim Angus <tim@ngus.net>2009-10-26 00:10:07 +0000
committerTim Angus <tim@ngus.net>2013-01-03 00:17:05 +0000
commit0fed3b1c32d99560482ea162b197531439df76e5 (patch)
treedd5f74d3124715a538462aa474f9af294f79bbbd /src/SDL12/include/SDL_quit.h
parentaf6fd4fa5aaa4dc7c59ae54ead20d5ef0fbcc946 (diff)
* Merge ioq3-r1708
Diffstat (limited to 'src/SDL12/include/SDL_quit.h')
-rw-r--r--src/SDL12/include/SDL_quit.h39
1 files changed, 22 insertions, 17 deletions
diff --git a/src/SDL12/include/SDL_quit.h b/src/SDL12/include/SDL_quit.h
index fcf40fbd..6d82e7e0 100644
--- a/src/SDL12/include/SDL_quit.h
+++ b/src/SDL12/include/SDL_quit.h
@@ -1,6 +1,6 @@
/*
SDL - Simple DirectMedia Layer
- Copyright (C) 1997-2006 Sam Lantinga
+ Copyright (C) 1997-2009 Sam Lantinga
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
@@ -20,7 +20,9 @@
slouken@libsdl.org
*/
-/* Include file for SDL quit event handling */
+/** @file SDL_quit.h
+ * Include file for SDL quit event handling
+ */
#ifndef _SDL_quit_h
#define _SDL_quit_h
@@ -28,22 +30,25 @@
#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_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
+ * There are no functions directly affecting the quit event
+ */
-/* There are no functions directly affecting the quit event */
#define SDL_QuitRequested() \
(SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))