include/SDL_quit.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
     1.1 --- a/include/SDL_quit.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_quit.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,7 +20,9 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* Include file for SDL quit event handling */
     1.8 +/** @file SDL_quit.h
     1.9 + *  Include file for SDL quit event handling
    1.10 + */
    1.11  
    1.12  #ifndef _SDL_quit_h
    1.13  #define _SDL_quit_h
    1.14 @@ -28,22 +30,25 @@
    1.15  #include "SDL_stdinc.h"
    1.16  #include "SDL_error.h"
    1.17  
    1.18 -/* 
    1.19 -  An SDL_QUITEVENT is generated when the user tries to close the application
    1.20 -  window.  If it is ignored or filtered out, the window will remain open.
    1.21 -  If it is not ignored or filtered, it is queued normally and the window
    1.22 -  is allowed to close.  When the window is closed, screen updates will 
    1.23 -  complete, but have no effect.
    1.24 +/** @file SDL_quit.h
    1.25 + *  An SDL_QUITEVENT is generated when the user tries to close the application
    1.26 + *  window.  If it is ignored or filtered out, the window will remain open.
    1.27 + *  If it is not ignored or filtered, it is queued normally and the window
    1.28 + *  is allowed to close.  When the window is closed, screen updates will 
    1.29 + *  complete, but have no effect.
    1.30 + *
    1.31 + *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    1.32 + *  and SIGTERM (system termination request), if handlers do not already
    1.33 + *  exist, that generate SDL_QUITEVENT events as well.  There is no way
    1.34 + *  to determine the cause of an SDL_QUITEVENT, but setting a signal
    1.35 + *  handler in your application will override the default generation of
    1.36 + *  quit events for that signal.
    1.37 + */
    1.38  
    1.39 -  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    1.40 -  and SIGTERM (system termination request), if handlers do not already
    1.41 -  exist, that generate SDL_QUITEVENT events as well.  There is no way
    1.42 -  to determine the cause of an SDL_QUITEVENT, but setting a signal
    1.43 -  handler in your application will override the default generation of
    1.44 -  quit events for that signal.
    1.45 -*/
    1.46 +/** @file SDL_quit.h
    1.47 + *  There are no functions directly affecting the quit event 
    1.48 + */
    1.49  
    1.50 -/* There are no functions directly affecting the quit event */
    1.51  #define SDL_QuitRequested() \
    1.52          (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    1.53