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.
libsdl-org · Oct 6, 2009 · 177026d · 177026d
1 parent 6023c29
commit 177026d
Showing 1 changed file with 10 additions and 5 deletions.
diff --git 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);