Commit 7685a189 authored by Sam Lantinga's avatar Sam Lantinga

Documentation updates

parent 4f5f8647
...@@ -139,16 +139,16 @@ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags); ...@@ -139,16 +139,16 @@ extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags); extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
/** /**
* This function returns mask of the specified subsystems which have * This function returns a mask of the specified subsystems which have
* been initialized. * previously been initialized.
* *
* If \c flags is 0, it returns a mask of all initialized subsystems. * If \c flags is 0, it returns a mask of all initialized subsystems.
*/ */
extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags); 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. You should
* dynamically linked library. You should call it upon all exit conditions. * call it upon all exit conditions.
*/ */
extern DECLSPEC void SDLCALL SDL_Quit(void); extern DECLSPEC void SDLCALL SDL_Quit(void);
......
...@@ -112,12 +112,11 @@ typedef struct SDL_version ...@@ -112,12 +112,11 @@ typedef struct SDL_version
/** /**
* \brief Get the version of SDL that is linked against your program. * \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 * If you are linking to SDL dynamically, then it is possible that the
* of SDL you compiled against: * 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 * \code
* SDL_version compiled; * SDL_version compiled;
...@@ -140,8 +139,9 @@ extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver); ...@@ -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. * \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 * Returns an arbitrary string (a hash value) uniquely identifying the
* in comparing against other revisions. It is NOT an incrementing number. * 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); extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
......
...@@ -30,8 +30,7 @@ ...@@ -30,8 +30,7 @@
/* Routine to get the thread-specific error variable */ /* Routine to get the thread-specific error variable */
#if SDL_THREADS_DISABLED #if SDL_THREADS_DISABLED
/* !!! FIXME: what does this comment mean? Victim of Search and Replace? */ /* The default (non-thread-safe) global error variable */
/* The SDL_arraysize(The ),default (non-thread-safe) global error variable */
static SDL_error SDL_global_error; static SDL_error SDL_global_error;
#define SDL_GetErrBuf() (&SDL_global_error) #define SDL_GetErrBuf() (&SDL_global_error)
#else #else
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment