include/SDL_main.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
     1.1 --- a/include/SDL_main.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_main.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -25,7 +25,11 @@
     1.4  
     1.5  #include "SDL_stdinc.h"
     1.6  
     1.7 -/* Redefine main() on some platforms so that it is called by SDL */
     1.8 +/**
     1.9 + *  \file SDL_main.h
    1.10 + *  
    1.11 + *  Redefine main() on some platforms so that it is called by SDL.
    1.12 + */
    1.13  
    1.14  #if defined(__WIN32__) || \
    1.15      (defined(__MWERKS__) && !defined(__BEOS__)) || \
    1.16 @@ -37,18 +41,26 @@
    1.17  #define C_LINKAGE
    1.18  #endif /* __cplusplus */
    1.19  
    1.20 -/* The application's main() function must be called with C linkage,
    1.21 -   and should be declared like this:
    1.22 -#ifdef __cplusplus
    1.23 -extern "C"
    1.24 -#endif
    1.25 -	int main(int argc, char *argv[])
    1.26 -	{
    1.27 -	}
    1.28 +/**
    1.29 + *  \file SDL_main.h
    1.30 + *
    1.31 + *  The application's main() function must be called with C linkage,
    1.32 + *  and should be declared like this:
    1.33 + *  \code
    1.34 + *  #ifdef __cplusplus
    1.35 + *  extern "C"
    1.36 + *  #endif
    1.37 + *  int main(int argc, char *argv[])
    1.38 + *  {
    1.39 + *  }
    1.40 + *  \endcode
    1.41   */
    1.42 +
    1.43  #define main	SDL_main
    1.44  
    1.45 -/* The prototype for the application's main() function */
    1.46 +/**
    1.47 + *  The prototype for the application's main() function
    1.48 + */
    1.49  extern C_LINKAGE int SDL_main(int argc, char *argv[]);
    1.50  
    1.51  
    1.52 @@ -62,7 +74,9 @@
    1.53  /* *INDENT-ON* */
    1.54  #endif
    1.55  
    1.56 -/* This can be called to set the application class at startup */
    1.57 +/**
    1.58 + *  This can be called to set the application class at startup
    1.59 + */
    1.60  extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style,
    1.61                                              void *hInst);
    1.62  extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);