diff include/SDL_version.h @ 3407:d3baf5ac4e37

Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents 972a69e47cd9
children f7b03b6838cb
line wrap: on
line diff
--- a/include/SDL_version.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_version.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,9 +21,9 @@
 */
 
 /**
- * \file SDL_version.h
- *
- * This header defines the current SDL version
+ *  \file SDL_version.h
+ *  
+ *  This header defines the current SDL version.
  */
 
 #ifndef _SDL_version_h
@@ -41,17 +41,16 @@
 #endif
 
 /**
- * \struct SDL_version
- * \brief Information the version of SDL in use.
- *
- * Represents the library's version as three levels: major revision
+ *  \brief Information the version of SDL in use.
+ *  
+ *  Represents the library's version as three levels: major revision
  *  (increments with massive changes, additions, and enhancements),
  *  minor revision (increments with backwards-compatible changes to the
  *  major revision), and patchlevel (increments with fixes to the minor
  *  revision).
- *
- * \sa SDL_VERSION
- * \sa SDL_GetVersion
+ *  
+ *  \sa SDL_VERSION
+ *  \sa SDL_GetVersion
  */
 typedef struct SDL_version
 {
@@ -67,20 +66,19 @@
 #define SDL_PATCHLEVEL		0
 
 /**
- * \def SDL_VERSION(x)
- * \brief Macro to determine SDL version program was compiled against.
- *
- * This macro fills in a SDL_version structure with the version of the
+ *  \brief Macro to determine SDL version program was compiled against.
+ *  
+ *  This macro fills in a SDL_version structure with the version of the
  *  library you compiled against. This is determined by what header the
  *  compiler uses. Note that if you dynamically linked the library, you might
  *  have a slightly newer or older version at runtime. That version can be
- *  determined with SDL_GetVersion(), which, unlike SDL_VERSION,
+ *  determined with SDL_GetVersion(), which, unlike SDL_VERSION(),
  *  is not a macro.
- *
- * \param x A pointer to a SDL_version struct to initialize.
- *
- * \sa SDL_version
- * \sa SDL_GetVersion
+ *  
+ *  \param x A pointer to a SDL_version struct to initialize.
+ *  
+ *  \sa SDL_version
+ *  \sa SDL_GetVersion
  */
 #define SDL_VERSION(x)							\
 {									\
@@ -89,52 +87,58 @@
 	(x)->patch = SDL_PATCHLEVEL;					\
 }
 
-/* This macro turns the version numbers into a numeric value:
-   (1,2,3) -> (1203)
-   This assumes that there will never be more than 100 patchlevels
-*/
+/**
+ *  This macro turns the version numbers into a numeric value:
+ *  \verbatim
+    (1,2,3) -> (1203)
+    \endverbatim
+ *  
+ *  This assumes that there will never be more than 100 patchlevels.
+ */
 #define SDL_VERSIONNUM(X, Y, Z)						\
 	((X)*1000 + (Y)*100 + (Z))
 
-/* This is the version number macro for the current SDL version */
+/**
+ *  This is the version number macro for the current SDL version.
+ */
 #define SDL_COMPILEDVERSION \
 	SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL)
 
-/* This macro will evaluate to true if compiled with SDL at least X.Y.Z */
+/**
+ *  This macro will evaluate to true if compiled with SDL at least X.Y.Z.
+ */
 #define SDL_VERSION_ATLEAST(X, Y, Z) \
 	(SDL_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
 
 /**
- * \fn void SDL_GetVersion(SDL_version *ver)
- * \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
+ *  \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
+ *  This is a real function; the macro SDL_VERSION() tells you what version
  *  of SDL you compiled against:
- *
- * \code
- * SDL_version compiled;
- * SDL_version linked;
- *
- * SDL_VERSION(&compiled);
- * SDL_GetVersion(&linked);
- * printf("We compiled against SDL version %d.%d.%d ...\n",
- *           compiled.major, compiled.minor, compiled.patch);
- * printf("But we linked against SDL version %d.%d.%d.\n",
- *           linked.major, linked.minor, linked.patch);
- * \endcode
- *
- * This function may be called safely at any time, even before SDL_Init().
- *
- * \sa SDL_VERSION
+ *  
+ *  \code
+ *  SDL_version compiled;
+ *  SDL_version linked;
+ *  
+ *  SDL_VERSION(&compiled);
+ *  SDL_GetVersion(&linked);
+ *  printf("We compiled against SDL version %d.%d.%d ...\n",
+ *         compiled.major, compiled.minor, compiled.patch);
+ *  printf("But we linked against SDL version %d.%d.%d.\n",
+ *         linked.major, linked.minor, linked.patch);
+ *  \endcode
+ *  
+ *  This function may be called safely at any time, even before SDL_Init().
+ *  
+ *  \sa SDL_VERSION
  */
 extern DECLSPEC void SDLCALL SDL_GetVersion(SDL_version * ver);
 
 /**
- * \fn int SDL_GetRevision(void)
- * \brief Get the code revision of SDL that is linked against your program.
+ *  \brief Get the code revision of SDL that is linked against your program.
  */
 extern DECLSPEC int SDLCALL SDL_GetRevision(void);