include/SDL_version.h
changeset 3407 d3baf5ac4e37
parent 2996 972a69e47cd9
child 3697 f7b03b6838cb
     1.1 --- a/include/SDL_version.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_version.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,9 +21,9 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_version.h
     1.8 - *
     1.9 - * This header defines the current SDL version
    1.10 + *  \file SDL_version.h
    1.11 + *  
    1.12 + *  This header defines the current SDL version.
    1.13   */
    1.14  
    1.15  #ifndef _SDL_version_h
    1.16 @@ -41,17 +41,16 @@
    1.17  #endif
    1.18  
    1.19  /**
    1.20 - * \struct SDL_version
    1.21 - * \brief Information the version of SDL in use.
    1.22 - *
    1.23 - * Represents the library's version as three levels: major revision
    1.24 + *  \brief Information the version of SDL in use.
    1.25 + *  
    1.26 + *  Represents the library's version as three levels: major revision
    1.27   *  (increments with massive changes, additions, and enhancements),
    1.28   *  minor revision (increments with backwards-compatible changes to the
    1.29   *  major revision), and patchlevel (increments with fixes to the minor
    1.30   *  revision).
    1.31 - *
    1.32 - * \sa SDL_VERSION
    1.33 - * \sa SDL_GetVersion
    1.34 + *  
    1.35 + *  \sa SDL_VERSION
    1.36 + *  \sa SDL_GetVersion
    1.37   */
    1.38  typedef struct SDL_version
    1.39  {
    1.40 @@ -67,20 +66,19 @@
    1.41  #define SDL_PATCHLEVEL		0
    1.42  
    1.43  /**
    1.44 - * \def SDL_VERSION(x)
    1.45 - * \brief Macro to determine SDL version program was compiled against.
    1.46 - *
    1.47 - * This macro fills in a SDL_version structure with the version of the
    1.48 + *  \brief Macro to determine SDL version program was compiled against.
    1.49 + *  
    1.50 + *  This macro fills in a SDL_version structure with the version of the
    1.51   *  library you compiled against. This is determined by what header the
    1.52   *  compiler uses. Note that if you dynamically linked the library, you might
    1.53   *  have a slightly newer or older version at runtime. That version can be
    1.54 - *  determined with SDL_GetVersion(), which, unlike SDL_VERSION,
    1.55 + *  determined with SDL_GetVersion(), which, unlike SDL_VERSION(),
    1.56   *  is not a macro.
    1.57 - *
    1.58 - * \param x A pointer to a SDL_version struct to initialize.
    1.59 - *
    1.60 - * \sa SDL_version
    1.61 - * \sa SDL_GetVersion
    1.62 + *  
    1.63 + *  \param x A pointer to a SDL_version struct to initialize.
    1.64 + *  
    1.65 + *  \sa SDL_version
    1.66 + *  \sa SDL_GetVersion
    1.67   */
    1.68  #define SDL_VERSION(x)							\
    1.69  {									\
    1.70 @@ -89,52 +87,58 @@
    1.71  	(x)->patch = SDL_PATCHLEVEL;					\
    1.72  }
    1.73  
    1.74 -/* This macro turns the version numbers into a numeric value:
    1.75 -   (1,2,3) -> (1203)
    1.76 -   This assumes that there will never be more than 100 patchlevels
    1.77 -*/
    1.78 +/**
    1.79 + *  This macro turns the version numbers into a numeric value:
    1.80 + *  \verbatim
    1.81 +    (1,2,3) -> (1203)
    1.82 +    \endverbatim
    1.83 + *  
    1.84 + *  This assumes that there will never be more than 100 patchlevels.
    1.85 + */
    1.86  #define SDL_VERSIONNUM(X, Y, Z)						\
    1.87  	((X)*1000 + (Y)*100 + (Z))
    1.88  
    1.89 -/* This is the version number macro for the current SDL version */
    1.90 +/**
    1.91 + *  This is the version number macro for the current SDL version.
    1.92 + */
    1.93  #define SDL_COMPILEDVERSION \
    1.94  	SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
    1.95  
    1.96 -/* This macro will evaluate to true if compiled with SDL at least X.Y.Z */
    1.97 +/**
    1.98 + *  This macro will evaluate to true if compiled with SDL at least X.Y.Z.
    1.99 + */
   1.100  #define SDL_VERSION_ATLEAST(X, Y, Z) \
   1.101  	(SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
   1.102  
   1.103  /**
   1.104 - * \fn void SDL_GetVersion(SDL_version *ver)
   1.105 - * \brief Get the version of SDL that is linked against your program.
   1.106 - *
   1.107 - * If you are using a shared library (DLL) version of SDL, then it is
   1.108 + *  \brief Get the version of SDL that is linked against your program.
   1.109 + *  
   1.110 + *  If you are using a shared library (DLL) version of SDL, then it is
   1.111   *  possible that it will be different than the version you compiled against.
   1.112   *
   1.113 - * This is a real function; the macro SDL_VERSION tells you what version
   1.114 + *  This is a real function; the macro SDL_VERSION() tells you what version
   1.115   *  of SDL you compiled against:
   1.116 - *
   1.117 - * \code
   1.118 - * SDL_version compiled;
   1.119 - * SDL_version linked;
   1.120 - *
   1.121 - * SDL_VERSION(&compiled);
   1.122 - * SDL_GetVersion(&linked);
   1.123 - * printf("We compiled against SDL version %d.%d.%d ...\n",
   1.124 - *           compiled.major, compiled.minor, compiled.patch);
   1.125 - * printf("But we linked against SDL version %d.%d.%d.\n",
   1.126 - *           linked.major, linked.minor, linked.patch);
   1.127 - * \endcode
   1.128 - *
   1.129 - * This function may be called safely at any time, even before SDL_Init().
   1.130 - *
   1.131 - * \sa SDL_VERSION
   1.132 + *  
   1.133 + *  \code
   1.134 + *  SDL_version compiled;
   1.135 + *  SDL_version linked;
   1.136 + *  
   1.137 + *  SDL_VERSION(&compiled);
   1.138 + *  SDL_GetVersion(&linked);
   1.139 + *  printf("We compiled against SDL version %d.%d.%d ...\n",
   1.140 + *         compiled.major, compiled.minor, compiled.patch);
   1.141 + *  printf("But we linked against SDL version %d.%d.%d.\n",
   1.142 + *         linked.major, linked.minor, linked.patch);
   1.143 + *  \endcode
   1.144 + *  
   1.145 + *  This function may be called safely at any time, even before SDL_Init().
   1.146 + *  
   1.147 + *  \sa SDL_VERSION
   1.148   */
   1.149  extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver);
   1.150  
   1.151  /**
   1.152 - * \fn int SDL_GetRevision(void)
   1.153 - * \brief Get the code revision of SDL that is linked against your program.
   1.154 + *  \brief Get the code revision of SDL that is linked against your program.
   1.155   */
   1.156  extern DECLSPEC int SDLCALL SDL_GetRevision(void);
   1.157