Mercurial > sdl-ios-xcode
diff include/SDL_main.h @ 3407:d3baf5ac4e37
Partial fix for bug #859
Header file update from Ken for improved doxygen output
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 19 Oct 2009 13:31:58 +0000 |
parents | 99210400e8b9 |
children | f7b03b6838cb |
line wrap: on
line diff
--- a/include/SDL_main.h Sun Oct 18 23:21:15 2009 +0000 +++ b/include/SDL_main.h Mon Oct 19 13:31:58 2009 +0000 @@ -25,7 +25,11 @@ #include "SDL_stdinc.h" -/* Redefine main() on some platforms so that it is called by SDL */ +/** + * \file SDL_main.h + * + * Redefine main() on some platforms so that it is called by SDL. + */ #if defined(__WIN32__) || \ (defined(__MWERKS__) && !defined(__BEOS__)) || \ @@ -37,18 +41,26 @@ #define C_LINKAGE #endif /* __cplusplus */ -/* The application's main() function must be called with C linkage, - and should be declared like this: -#ifdef __cplusplus -extern "C" -#endif - int main(int argc, char *argv[]) - { - } +/** + * \file SDL_main.h + * + * The application's main() function must be called with C linkage, + * and should be declared like this: + * \code + * #ifdef __cplusplus + * extern "C" + * #endif + * int main(int argc, char *argv[]) + * { + * } + * \endcode */ + #define main SDL_main -/* The prototype for the application's main() function */ +/** + * The prototype for the application's main() function + */ extern C_LINKAGE int SDL_main(int argc, char *argv[]); @@ -62,7 +74,9 @@ /* *INDENT-ON* */ #endif -/* This can be called to set the application class at startup */ +/** + * This can be called to set the application class at startup + */ extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style, void *hInst); extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);