include/SDL_endian.h
changeset 3407 d3baf5ac4e37
parent 3067 bcd41b269091
child 3630 efb79807afe1
     1.1 --- a/include/SDL_endian.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_endian.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_endian.h
     1.8 - *
     1.9 - * Functions for reading and writing endian-specific values
    1.10 + *  \file SDL_endian.h
    1.11 + *  
    1.12 + *  Functions for reading and writing endian-specific values
    1.13   */
    1.14  
    1.15  #ifndef _SDL_endian_h
    1.16 @@ -31,9 +31,13 @@
    1.17  
    1.18  #include "SDL_stdinc.h"
    1.19  
    1.20 -/* The two types of endianness */
    1.21 +/**
    1.22 + *  \name The two types of endianness
    1.23 + */
    1.24 +/*@{*/
    1.25  #define SDL_LIL_ENDIAN	1234
    1.26  #define SDL_BIG_ENDIAN	4321
    1.27 +/*@}*/
    1.28  
    1.29  #ifndef SDL_BYTEORDER           /* Not defined in SDL_config.h? */
    1.30  #if defined(__hppa__) || \
    1.31 @@ -56,11 +60,14 @@
    1.32  /* *INDENT-ON* */
    1.33  #endif
    1.34  
    1.35 -/* Use inline functions for compilers that support them, and static
    1.36 -   functions for those that do not.  Because these functions become
    1.37 -   static for compilers that do not support inline functions, this
    1.38 -   header should only be included in files that actually use them.
    1.39 -*/
    1.40 +/**
    1.41 + *  \file SDL_endian.h
    1.42 + *  
    1.43 + *  Uses inline functions for compilers that support them, and static
    1.44 + *  functions for those that do not.  Because these functions become
    1.45 + *  static for compilers that do not support inline functions, this
    1.46 + *  header should only be included in files that actually use them.
    1.47 + */
    1.48  #if defined(__GNUC__) && defined(__i386__) && \
    1.49     !(__GNUC__ == 2 && __GNUC_MINOR__ == 95 /* broken gcc version */)
    1.50  static __inline__ Uint16
    1.51 @@ -184,10 +191,11 @@
    1.52  }
    1.53  #endif
    1.54  #else
    1.55 -/* This is mainly to keep compilers from complaining in SDL code.
    1.56 -   If there is no real 64-bit datatype, then compilers will complain about
    1.57 -   the fake 64-bit datatype that SDL provides when it compiles user code.
    1.58 -*/
    1.59 +/**
    1.60 + *  This is mainly to keep compilers from complaining in SDL code.
    1.61 + *  If there is no real 64-bit datatype, then compilers will complain about
    1.62 + *  the fake 64-bit datatype that SDL provides when it compiles user code.
    1.63 + */
    1.64  #define SDL_Swap64(X)	(X)
    1.65  #endif /* SDL_HAS_64BIT_TYPE */
    1.66  
    1.67 @@ -206,7 +214,11 @@
    1.68  }
    1.69  
    1.70  
    1.71 -/* Byteswap item from the specified endianness to the native endianness */
    1.72 +/**
    1.73 + *  \name Swap to native
    1.74 + *  Byteswap item from the specified endianness to the native endianness.
    1.75 + */
    1.76 +/*@{*/
    1.77  #if SDL_BYTEORDER == SDL_LIL_ENDIAN
    1.78  #define SDL_SwapLE16(X)	(X)
    1.79  #define SDL_SwapLE32(X)	(X)
    1.80 @@ -226,6 +238,7 @@
    1.81  #define SDL_SwapBE64(X)	(X)
    1.82  #define SDL_SwapFloatBE(X)	(X)
    1.83  #endif
    1.84 +/*@}*//*Swap to native*/
    1.85  
    1.86  /* Ends C function definitions when using C++ */
    1.87  #ifdef __cplusplus