diff include/SDL_version.h @ 4627:3b5f4b3a69e1

Documentation updates
author Sam Lantinga <slouken@libsdl.org>
date Thu, 29 Jul 2010 20:24:05 -0700
parents 5e7e1f1a4056
children b530ef003506
line wrap: on
line diff
--- a/include/SDL_version.h	Wed Jul 28 22:24:13 2010 -0700
+++ b/include/SDL_version.h	Thu Jul 29 20:24:05 2010 -0700
@@ -112,12 +112,11 @@
 
 /**
  *  \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 @@
 /**
  *  \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);