Mercurial > sdl-ios-xcode

comparison include/SDL_error.h @ 4217:4c4113c2162c SDL-1.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed bug #706 Ken Bull 2009-02-25 13:22:02 PST Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446. While in general SDL is quite thoroughly commented, none of these comments are correctly formatted for Doxygen and are generally inconsistent in their formatting.
author Sam Lantinga <slouken@libsdl.org>
date Mon, 21 Sep 2009 09:38:10 +0000
parents a1b03ba2fcd0
children
comparison
equal deleted inserted replaced
4216:5b99971a27b4 4217:4c4113c2162c
18 18
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22 22
23 /* Simple error message routines for SDL */ 23 /**
24 * @file SDL_error.h
25 * Simple error message routines for SDL
26 */
24 27
25 #ifndef _SDL_error_h 28 #ifndef _SDL_error_h
26 #define _SDL_error_h 29 #define _SDL_error_h
27 30
28 #include "SDL_stdinc.h" 31 #include "SDL_stdinc.h"
31 /* Set up for C function definitions, even when using C++ */ 34 /* Set up for C function definitions, even when using C++ */
32 #ifdef __cplusplus 35 #ifdef __cplusplus
33 extern "C" { 36 extern "C" {
34 #endif 37 #endif
35 38
36 /* Public functions */ 39 /**
40 * @name Public functions
41 */
42 /*@{*/
37 extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...); 43 extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...);
38 extern DECLSPEC char * SDLCALL SDL_GetError(void); 44 extern DECLSPEC char * SDLCALL SDL_GetError(void);
39 extern DECLSPEC void SDLCALL SDL_ClearError(void); 45 extern DECLSPEC void SDLCALL SDL_ClearError(void);
46 /*@}*/
40 47
41 /* Private error message function - used internally */ 48 /**
49 * @name Private functions
50 * @internal Private error message function - used internally
51 */
52 /*@{*/
42 #define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM) 53 #define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM)
43 #define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED) 54 #define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED)
44 typedef enum { 55 typedef enum {
45 SDL_ENOMEM, 56 SDL_ENOMEM,
46 SDL_EFREAD, 57 SDL_EFREAD,
48 SDL_EFSEEK, 59 SDL_EFSEEK,
49 SDL_UNSUPPORTED, 60 SDL_UNSUPPORTED,
50 SDL_LASTERROR 61 SDL_LASTERROR
51 } SDL_errorcode; 62 } SDL_errorcode;
52 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code); 63 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
53 64 /*@}*/
54 65
55 /* Ends C function definitions when using C++ */ 66 /* Ends C function definitions when using C++ */
56 #ifdef __cplusplus 67 #ifdef __cplusplus
57 } 68 }
58 #endif 69 #endif