include/SDL_version.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4208 453587d6dc87
child 6112 60dfd25009b0
     1.1 --- a/include/SDL_version.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_version.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,7 +20,9 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* This header defines the current SDL version */
     1.8 +/** @file SDL_version.h
     1.9 + *  This header defines the current SDL version
    1.10 + */
    1.11  
    1.12  #ifndef _SDL_version_h
    1.13  #define _SDL_version_h
    1.14 @@ -33,11 +35,14 @@
    1.15  extern "C" {
    1.16  #endif
    1.17  
    1.18 -/* Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
    1.19 -*/
    1.20 +/** @name Version Number
    1.21 + *  Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
    1.22 + */
    1.23 +/*@{*/
    1.24  #define SDL_MAJOR_VERSION	1
    1.25  #define SDL_MINOR_VERSION	2
    1.26  #define SDL_PATCHLEVEL		14
    1.27 +/*@}*/
    1.28  
    1.29  typedef struct SDL_version {
    1.30  	Uint8 major;
    1.31 @@ -45,7 +50,8 @@
    1.32  	Uint8 patch;
    1.33  } SDL_version;
    1.34  
    1.35 -/* This macro can be used to fill a version structure with the compile-time
    1.36 +/**
    1.37 + * This macro can be used to fill a version structure with the compile-time
    1.38   * version of the SDL library.
    1.39   */
    1.40  #define SDL_VERSION(X)							\
    1.41 @@ -55,24 +61,24 @@
    1.42  	(X)->patch = SDL_PATCHLEVEL;					\
    1.43  }
    1.44  
    1.45 -/* This macro turns the version numbers into a numeric value:
    1.46 -   (1,2,3) -> (1203)
    1.47 -   This assumes that there will never be more than 100 patchlevels
    1.48 -*/
    1.49 +/** This macro turns the version numbers into a numeric value:
    1.50 + *  (1,2,3) -> (1203)
    1.51 + *  This assumes that there will never be more than 100 patchlevels
    1.52 + */
    1.53  #define SDL_VERSIONNUM(X, Y, Z)						\
    1.54  	((X)*1000 + (Y)*100 + (Z))
    1.55  
    1.56 -/* This is the version number macro for the current SDL version */
    1.57 +/** This is the version number macro for the current SDL version */
    1.58  #define SDL_COMPILEDVERSION \
    1.59  	SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
    1.60  
    1.61 -/* This macro will evaluate to true if compiled with SDL at least X.Y.Z */
    1.62 +/** This macro will evaluate to true if compiled with SDL at least X.Y.Z */
    1.63  #define SDL_VERSION_ATLEAST(X, Y, Z) \
    1.64  	(SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
    1.65  
    1.66 -/* This function gets the version of the dynamically linked SDL library.
    1.67 -   it should NOT be used to fill a version structure, instead you should
    1.68 -   use the SDL_Version() macro.
    1.69 +/** This function gets the version of the dynamically linked SDL library.
    1.70 + *  it should NOT be used to fill a version structure, instead you should
    1.71 + *  use the SDL_Version() macro.
    1.72   */
    1.73  extern DECLSPEC const SDL_version * SDLCALL SDL_Linked_Version(void);
    1.74