From 8a42721d718e9921a7f92b94766f984059de225a Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Thu, 29 Jul 2010 20:24:05 -0700 Subject: [PATCH] Documentation updates --- include/SDL.h | 8 ++++---- include/SDL_version.h | 14 +++++++------- src/SDL_error.c | 3 +-- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/include/SDL.h b/include/SDL.h index 349010d39..2f009cf9c 100644 --- a/include/SDL.h +++ b/include/SDL.h @@ -139,16 +139,16 @@ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); /** - * This function returns mask of the specified subsystems which have - * been initialized. + * This function returns a mask of the specified subsystems which have + * previously been initialized. * * If \c 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 - * dynamically linked library. You should call it upon all exit conditions. + * This function cleans up all initialized subsystems. You should + * call it upon all exit conditions. */ extern DECLSPEC void SDLCALL SDL_Quit(void); diff --git a/include/SDL_version.h b/include/SDL_version.h index a2ab71c2a..d334b9034 100644 --- a/include/SDL_version.h +++ b/include/SDL_version.h @@ -112,12 +112,11 @@ typedef struct SDL_version /** * \brief Get the version of SDL that is linked against your program. - * - * If you are using a shared library (DLL) version of SDL, then it is - * possible that it will be different than the version you compiled against. * - * This is a real function; the macro SDL_VERSION() tells you what version - * of SDL you compiled against: + * If you are linking to SDL dynamically, then it is possible that the + * current version will be different than the version you compiled against. + * This function returns the current version, while SDL_VERSION() is a + * macro that tells you what version you compiled with. * * \code * SDL_version compiled; @@ -140,8 +139,9 @@ extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver); /** * \brief Get the code revision of SDL that is linked against your program. * - * This is an arbitrary string (a hash value, actually), and is only useful - * in comparing against other revisions. It is NOT an incrementing number. + * Returns an arbitrary string (a hash value) uniquely identifying the + * exact revision of the SDL library in use, and is only useful in comparing + * against other revisions. It is NOT an incrementing number. */ extern DECLSPEC const char *SDLCALL SDL_GetRevision(void); diff --git a/src/SDL_error.c b/src/SDL_error.c index 35bf7703d..99ac09cdc 100644 --- a/src/SDL_error.c +++ b/src/SDL_error.c @@ -30,8 +30,7 @@ /* Routine to get the thread-specific error variable */ #if SDL_THREADS_DISABLED -/* !!! FIXME: what does this comment mean? Victim of Search and Replace? */ -/* The SDL_arraysize(The ),default (non-thread-safe) global error variable */ +/* The default (non-thread-safe) global error variable */ static SDL_error SDL_global_error; #define SDL_GetErrBuf() (&SDL_global_error) #else