include/SDL_error.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
     1.1 --- a/include/SDL_error.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_error.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,7 +20,10 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* Simple error message routines for SDL */
     1.8 +/**
     1.9 + *  @file SDL_error.h
    1.10 + *  Simple error message routines for SDL
    1.11 + */
    1.12  
    1.13  #ifndef _SDL_error_h
    1.14  #define _SDL_error_h
    1.15 @@ -33,12 +36,20 @@
    1.16  extern "C" {
    1.17  #endif
    1.18  
    1.19 -/* Public functions */
    1.20 +/** 
    1.21 + *  @name Public functions
    1.22 + */
    1.23 +/*@{*/
    1.24  extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...);
    1.25  extern DECLSPEC char * SDLCALL SDL_GetError(void);
    1.26  extern DECLSPEC void SDLCALL SDL_ClearError(void);
    1.27 +/*@}*/
    1.28  
    1.29 -/* Private error message function - used internally */
    1.30 +/**
    1.31 + *  @name Private functions
    1.32 + *  @internal Private error message function - used internally
    1.33 + */
    1.34 +/*@{*/
    1.35  #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    1.36  #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    1.37  typedef enum {
    1.38 @@ -50,7 +61,7 @@
    1.39  	SDL_LASTERROR
    1.40  } SDL_errorcode;
    1.41  extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
    1.42 -
    1.43 +/*@}*/
    1.44  
    1.45  /* Ends C function definitions when using C++ */
    1.46  #ifdef __cplusplus