From 177026dd71eb4c3fa320619cfc9f526bf34afc52 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Tue, 6 Oct 2009 03:34:10 +0000 Subject: [PATCH] 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 | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/include/SDL.h b/include/SDL.h index a2be84c75..cd5b2c274 100644 --- a/include/SDL.h +++ b/include/SDL.h @@ -114,26 +114,31 @@ extern "C" { #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);