First shot at merging the wiki documentation into the headers.

This commit is contained in:
Ryan C. Gordon
2021-03-21 14:18:39 -04:00
parent 3c78c211d5
commit 3f40396d33
39 changed files with 7487 additions and 3073 deletions

View File

@@ -186,7 +186,22 @@ extern "C" {
#endif
/**
* \brief Gets the name of the platform.
* Get the name of the platform.
*
* Here are the names returned for some (but not all) supported platforms:
*
* - "Windows"
*
* - "Mac OS X"
*
* - "Linux"
*
* - "iOS"
*
* - "Android"
*
* \returns the name of the platform. If the correct platform name is not
* available, returns a string beginning with the text "Unknown".
*/
extern DECLSPEC const char * SDLCALL SDL_GetPlatform (void);