Mercurial > sdl-ios-xcode
diff include/SDL.h @ 3348:c02af6912b3c
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.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Tue, 06 Oct 2009 03:34:10 +0000 |
parents | 1ed5d432e468 |
children | d3baf5ac4e37 |
line wrap: on
line diff
--- a/include/SDL.h Tue Oct 06 03:33:10 2009 +0000 +++ b/include/SDL.h Tue Oct 06 03:34:10 2009 +0000 @@ -114,26 +114,31 @@ #define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */ #define SDL_INIT_EVERYTHING 0x0000FFFF -/* This function loads the SDL dynamically linked library and initializes +/** + * This function loads the SDL dynamically linked library and initializes * the subsystems specified by 'flags' (and those satisfying dependencies) * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup * signal handlers for some commonly ignored fatal signals (like SIGSEGV) */ extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags); -/* This function initializes specific SDL subsystems */ +/** + * This function initializes specific SDL subsystems + */ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); -/* This function cleans up specific SDL subsystems */ +/** This function cleans up specific SDL subsystems */ extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); -/* This function returns mask of the specified subsystems which have +/** + This function returns mask of the specified subsystems which have been initialized. If 'flags' is 0, it returns a mask of all initialized subsystems. */ extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); -/* This function cleans up all initialized subsystems and unloads the +/** + * This function cleans up all initialized subsystems and unloads the * dynamically linked library. You should call it upon all exit conditions. */ extern DECLSPEC void SDLCALL SDL_Quit(void);