Improved SDL_main documentation and remove extern "C" comment.

It turns out that this is incorrect and any C linkage is already taken care of by SDL when redefining SDL_main.

Fixes https://github.com/libsdl-org/SDL/issues/11068
This commit is contained in:
Sam Lantinga 2024-10-08 08:07:54 -07:00
parent 03fa9ff0b0
commit fb07ab91c6

View file

@ -22,13 +22,22 @@
/**
* # CategoryMain
*
* Redefine main() on some platforms so that it is called by SDL.
* Redefine main() if necessary so that it is called by SDL.
*
* For details on how SDL_main works, and how to use it, please refer to:
* In order to make this consistent on all platforms, the application's main()
* should look like this:
*
* ```c
* int main(int argc, char *argv[])
* {
* }
* ```
*
* SDL will take care of platform specific details on how it gets called.
*
* For more information, see:
*
* https://wiki.libsdl.org/SDL3/README/main-functions
*
* (or docs/README-main-functions.md in the SDL source tree)
*/
#ifndef SDL_main_h_
@ -129,22 +138,6 @@
#define SDLMAIN_DECLSPEC
#endif
/**
* \file SDL_main.h
*
* The application's main() function must be called with C linkage,
* and should be declared like this:
*
* ```c
* #ifdef __cplusplus
* extern "C"
* #endif
* int main(int argc, char *argv[])
* {
* }
* ```
*/
#ifdef SDL_WIKI_DOCUMENTATION_SECTION
/**