include/SDL_error.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
--- a/include/SDL_error.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_error.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,8 +21,9 @@
 */
 
 /**
- * \file SDL_error.h
- * Simple error message routines for SDL
+ *  \file SDL_error.h
+ *  
+ *  Simple error message routines for SDL.
  */
 
 #ifndef _SDL_error_h
@@ -43,7 +44,13 @@
 extern DECLSPEC char *SDLCALL SDL_GetError(void);
 extern DECLSPEC void SDLCALL SDL_ClearError(void);
 
-/* Private error message function - used internally */
+/**
+ *  \name Internal error functions
+ *  
+ *  \internal 
+ *  Private error message function - used internally.
+ */
+/*@{*/
 #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
 #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
 typedef enum
@@ -56,7 +63,7 @@
     SDL_LASTERROR
 } SDL_errorcode;
 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
-
+/*@}*//*Internal error functions*/
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus