include/SDL_quit.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
     1.1 --- a/include/SDL_quit.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_quit.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,9 +21,9 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_quit.h
     1.8 - *
     1.9 - * Include file for SDL quit event handling
    1.10 + *  \file SDL_quit.h
    1.11 + *  
    1.12 + *  Include file for SDL quit event handling.
    1.13   */
    1.14  
    1.15  #ifndef _SDL_quit_h
    1.16 @@ -32,22 +32,27 @@
    1.17  #include "SDL_stdinc.h"
    1.18  #include "SDL_error.h"
    1.19  
    1.20 -/* 
    1.21 -  An SDL_QUITEVENT is generated when the user tries to close the application
    1.22 -  window.  If it is ignored or filtered out, the window will remain open.
    1.23 -  If it is not ignored or filtered, it is queued normally and the window
    1.24 -  is allowed to close.  When the window is closed, screen updates will 
    1.25 -  complete, but have no effect.
    1.26 -
    1.27 -  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    1.28 -  and SIGTERM (system termination request), if handlers do not already
    1.29 -  exist, that generate SDL_QUITEVENT events as well.  There is no way
    1.30 -  to determine the cause of an SDL_QUITEVENT, but setting a signal
    1.31 -  handler in your application will override the default generation of
    1.32 -  quit events for that signal.
    1.33 -*/
    1.34 +/**
    1.35 + *  \file SDL_quit.h
    1.36 + *  
    1.37 + *  An ::SDL_QUIT event is generated when the user tries to close the application
    1.38 + *  window.  If it is ignored or filtered out, the window will remain open.
    1.39 + *  If it is not ignored or filtered, it is queued normally and the window
    1.40 + *  is allowed to close.  When the window is closed, screen updates will 
    1.41 + *  complete, but have no effect.
    1.42 + *
    1.43 + *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    1.44 + *  and SIGTERM (system termination request), if handlers do not already
    1.45 + *  exist, that generate ::SDL_QUIT events as well.  There is no way
    1.46 + *  to determine the cause of an ::SDL_QUIT event, but setting a signal
    1.47 + *  handler in your application will override the default generation of
    1.48 + *  quit events for that signal.
    1.49 + *  
    1.50 + *  \sa SDL_Quit()
    1.51 + */
    1.52  
    1.53  /* There are no functions directly affecting the quit event */
    1.54 +
    1.55  #define SDL_QuitRequested() \
    1.56          (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    1.57