Documentation updates
authorSam Lantinga <slouken@libsdl.org>
Thu, 29 Jul 2010 20:24:05 -0700
changeset 46273b5f4b3a69e1
parent 4626 2cfd55c58cd9
child 4628 fad859023468
Documentation updates
include/SDL.h
include/SDL_version.h
src/SDL_error.c
     1.1 --- a/include/SDL.h	Wed Jul 28 22:24:13 2010 -0700
     1.2 +++ b/include/SDL.h	Thu Jul 29 20:24:05 2010 -0700
     1.3 @@ -139,16 +139,16 @@
     1.4  extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
     1.5  
     1.6  /**
     1.7 - *  This function returns mask of the specified subsystems which have
     1.8 - *  been initialized.
     1.9 + *  This function returns a mask of the specified subsystems which have
    1.10 + *  previously been initialized.
    1.11   *  
    1.12   *  If \c flags is 0, it returns a mask of all initialized subsystems.
    1.13   */
    1.14  extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
    1.15  
    1.16  /**
    1.17 - *  This function cleans up all initialized subsystems and unloads the
    1.18 - *  dynamically linked library.  You should call it upon all exit conditions.
    1.19 + *  This function cleans up all initialized subsystems. You should
    1.20 + *  call it upon all exit conditions.
    1.21   */
    1.22  extern DECLSPEC void SDLCALL SDL_Quit(void);
    1.23  
     2.1 --- a/include/SDL_version.h	Wed Jul 28 22:24:13 2010 -0700
     2.2 +++ b/include/SDL_version.h	Thu Jul 29 20:24:05 2010 -0700
     2.3 @@ -112,12 +112,11 @@
     2.4  
     2.5  /**
     2.6   *  \brief Get the version of SDL that is linked against your program.
     2.7 - *  
     2.8 - *  If you are using a shared library (DLL) version of SDL, then it is
     2.9 - *  possible that it will be different than the version you compiled against.
    2.10   *
    2.11 - *  This is a real function; the macro SDL_VERSION() tells you what version
    2.12 - *  of SDL you compiled against:
    2.13 + *  If you are linking to SDL dynamically, then it is possible that the
    2.14 + *  current version will be different than the version you compiled against.
    2.15 + *  This function returns the current version, while SDL_VERSION() is a
    2.16 + *  macro that tells you what version you compiled with.
    2.17   *  
    2.18   *  \code
    2.19   *  SDL_version compiled;
    2.20 @@ -140,8 +139,9 @@
    2.21  /**
    2.22   *  \brief Get the code revision of SDL that is linked against your program.
    2.23   *
    2.24 - *  This is an arbitrary string (a hash value, actually), and is only useful
    2.25 - *  in comparing against other revisions. It is NOT an incrementing number.
    2.26 + *  Returns an arbitrary string (a hash value) uniquely identifying the
    2.27 + *  exact revision of the SDL library in use, and is only useful in comparing
    2.28 + *  against other revisions. It is NOT an incrementing number.
    2.29   */
    2.30  extern DECLSPEC const char *SDLCALL SDL_GetRevision(void);
    2.31  
     3.1 --- a/src/SDL_error.c	Wed Jul 28 22:24:13 2010 -0700
     3.2 +++ b/src/SDL_error.c	Thu Jul 29 20:24:05 2010 -0700
     3.3 @@ -30,8 +30,7 @@
     3.4  
     3.5  /* Routine to get the thread-specific error variable */
     3.6  #if SDL_THREADS_DISABLED
     3.7 -/* !!! FIXME: what does this comment mean? Victim of Search and Replace? */
     3.8 -/* The  SDL_arraysize(The ),default (non-thread-safe) global error variable */
     3.9 +/* The default (non-thread-safe) global error variable */
    3.10  static SDL_error SDL_global_error;
    3.11  #define SDL_GetErrBuf()	(&SDL_global_error)
    3.12  #else