Eric Wing to Sam
authorSam Lantinga <slouken@libsdl.org>
Tue, 06 Oct 2009 03:34:10 +0000
changeset 3348c02af6912b3c
parent 3347 0dc3d85ce0ac
child 3349 8f80081f5ab8
Eric Wing to Sam

Also noticed the SDL.h header in 1.3 didn't have the /** for the methods while testing. Attached is a quick fix patch.
include/SDL.h
     1.1 --- a/include/SDL.h	Tue Oct 06 03:33:10 2009 +0000
     1.2 +++ b/include/SDL.h	Tue Oct 06 03:34:10 2009 +0000
     1.3 @@ -114,26 +114,31 @@
     1.4  #define SDL_INIT_EVENTTHREAD    0x01000000      /* Not supported on all OS's */
     1.5  #define SDL_INIT_EVERYTHING     0x0000FFFF
     1.6  
     1.7 -/* This function loads the SDL dynamically linked library and initializes 
     1.8 +/**
     1.9 + * This function loads the SDL dynamically linked library and initializes 
    1.10   * the subsystems specified by 'flags' (and those satisfying dependencies)
    1.11   * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
    1.12   * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
    1.13   */
    1.14  extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
    1.15  
    1.16 -/* This function initializes specific SDL subsystems */
    1.17 +/**
    1.18 + * This function initializes specific SDL subsystems
    1.19 + */
    1.20  extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
    1.21  
    1.22 -/* This function cleans up specific SDL subsystems */
    1.23 +/** This function cleans up specific SDL subsystems */
    1.24  extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
    1.25  
    1.26 -/* This function returns mask of the specified subsystems which have
    1.27 +/**
    1.28 +   This function returns mask of the specified subsystems which have
    1.29     been initialized.
    1.30     If 'flags' is 0, it returns a mask of all initialized subsystems.
    1.31  */
    1.32  extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
    1.33  
    1.34 -/* This function cleans up all initialized subsystems and unloads the
    1.35 +/**
    1.36 + * This function cleans up all initialized subsystems and unloads the
    1.37   * dynamically linked library.  You should call it upon all exit conditions.
    1.38   */
    1.39  extern DECLSPEC void SDLCALL SDL_Quit(void);