include/SDL_main.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
     1.1 --- a/include/SDL_main.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_main.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -25,7 +25,9 @@
     1.4  
     1.5  #include "SDL_stdinc.h"
     1.6  
     1.7 -/* Redefine main() on Win32 and MacOS so that it is called by winmain.c */
     1.8 +/** @file SDL_main.h
     1.9 + *  Redefine main() on Win32 and MacOS so that it is called by winmain.c
    1.10 + */
    1.11  
    1.12  #if defined(__WIN32__) || \
    1.13      (defined(__MWERKS__) && !defined(__BEOS__)) || \
    1.14 @@ -38,22 +40,25 @@
    1.15  #define C_LINKAGE
    1.16  #endif /* __cplusplus */
    1.17  
    1.18 -/* The application's main() function must be called with C linkage,
    1.19 -   and should be declared like this:
    1.20 -#ifdef __cplusplus
    1.21 -extern "C"
    1.22 -#endif
    1.23 -	int main(int argc, char *argv[])
    1.24 -	{
    1.25 -	}
    1.26 +/** The application's main() function must be called with C linkage,
    1.27 + *  and should be declared like this:
    1.28 + *      @code
    1.29 + *      #ifdef __cplusplus
    1.30 + *      extern "C"
    1.31 + *      #endif
    1.32 + *	int main(int argc, char *argv[])
    1.33 + *	{
    1.34 + *	}
    1.35 + *      @endcode
    1.36   */
    1.37  #define main	SDL_main
    1.38  
    1.39 -/* The prototype for the application's main() function */
    1.40 +/** The prototype for the application's main() function */
    1.41  extern C_LINKAGE int SDL_main(int argc, char *argv[]);
    1.42  
    1.43  
    1.44 -/* From the SDL library code -- needed for registering the app on Win32 */
    1.45 +/** @name From the SDL library code -- needed for registering the app on Win32 */
    1.46 +/*@{*/
    1.47  #ifdef __WIN32__
    1.48  
    1.49  #include "begin_code.h"
    1.50 @@ -61,19 +66,21 @@
    1.51  extern "C" {
    1.52  #endif
    1.53  
    1.54 -/* This should be called from your WinMain() function, if any */
    1.55 +/** This should be called from your WinMain() function, if any */
    1.56  extern DECLSPEC void SDLCALL SDL_SetModuleHandle(void *hInst);
    1.57 -/* This can also be called, but is no longer necessary */
    1.58 +/** This can also be called, but is no longer necessary */
    1.59  extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style, void *hInst);
    1.60 -/* This can also be called, but is no longer necessary (SDL_Quit calls it) */
    1.61 +/** This can also be called, but is no longer necessary (SDL_Quit calls it) */
    1.62  extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);
    1.63  #ifdef __cplusplus
    1.64  }
    1.65  #endif
    1.66  #include "close_code.h"
    1.67  #endif
    1.68 +/*@}*/
    1.69  
    1.70 -/* From the SDL library code -- needed for registering QuickDraw on MacOS */
    1.71 +/** @name From the SDL library code -- needed for registering QuickDraw on MacOS */
    1.72 +/*@{*/
    1.73  #if defined(__MACOS__)
    1.74  
    1.75  #include "begin_code.h"
    1.76 @@ -81,10 +88,10 @@
    1.77  extern "C" {
    1.78  #endif
    1.79  
    1.80 -/* Forward declaration so we don't need to include QuickDraw.h */
    1.81 +/** Forward declaration so we don't need to include QuickDraw.h */
    1.82  struct QDGlobals;
    1.83  
    1.84 -/* This should be called from your main() function, if any */
    1.85 +/** This should be called from your main() function, if any */
    1.86  extern DECLSPEC void SDLCALL SDL_InitQuickDraw(struct QDGlobals *the_qd);
    1.87  
    1.88  #ifdef __cplusplus
    1.89 @@ -92,6 +99,7 @@
    1.90  #endif
    1.91  #include "close_code.h"
    1.92  #endif
    1.93 +/*@}*/
    1.94  
    1.95  #endif /* Need to redefine main()? */
    1.96