include/SDL_error.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
     1.1 --- a/include/SDL_error.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_error.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,8 +21,9 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_error.h
     1.8 - * Simple error message routines for SDL
     1.9 + *  \file SDL_error.h
    1.10 + *  
    1.11 + *  Simple error message routines for SDL.
    1.12   */
    1.13  
    1.14  #ifndef _SDL_error_h
    1.15 @@ -43,7 +44,13 @@
    1.16  extern DECLSPEC char *SDLCALL SDL_GetError(void);
    1.17  extern DECLSPEC void SDLCALL SDL_ClearError(void);
    1.18  
    1.19 -/* Private error message function - used internally */
    1.20 +/**
    1.21 + *  \name Internal error functions
    1.22 + *  
    1.23 + *  \internal 
    1.24 + *  Private error message function - used internally.
    1.25 + */
    1.26 +/*@{*/
    1.27  #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    1.28  #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    1.29  typedef enum
    1.30 @@ -56,7 +63,7 @@
    1.31      SDL_LASTERROR
    1.32  } SDL_errorcode;
    1.33  extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
    1.34 -
    1.35 +/*@}*//*Internal error functions*/
    1.36  
    1.37  /* Ends C function definitions when using C++ */
    1.38  #ifdef __cplusplus