Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Documentation updates

  • Loading branch information
slouken committed Jul 30, 2010
1 parent c218d56 commit 8a42721d718e9921a7f92b94766f984059de225a
Showing with 12 additions and 13 deletions.
  1. +4 −4 include/SDL.h
  2. +7 −7 include/SDL_version.h
  3. +1 −2 src/SDL_error.c
@@ -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);

@@ -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);

@@ -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

0 comments on commit 8a42721

Please sign in to comment.