mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-09-09 06:50:28 +00:00
parent 050aa4d084
commit 301f3ffa9d
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/SDL3/SDL_stdinc.h
View File

@ -124,6 +124,7 @@ void *alloca(size_t);
/* @{ */ /* @{ */
#ifdef SDL_WIKI_DOCUMENTATION_SECTION #ifdef SDL_WIKI_DOCUMENTATION_SECTION
/** /**
* Handle a Reinterpret Cast properly whether using C or C++. * Handle a Reinterpret Cast properly whether using C or C++.
* *
@ -135,7 +136,6 @@ void *alloca(size_t);
* *
* \param type the type to cast the expression to. * \param type the type to cast the expression to.
* \param expression the expression to cast to a different type. * \param expression the expression to cast to a different type.
*
* \returns `expression`, cast to `type`. * \returns `expression`, cast to `type`.
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
@ -158,7 +158,6 @@ void *alloca(size_t);
* *
* \param type the type to cast the expression to. * \param type the type to cast the expression to.
* \param expression the expression to cast to a different type. * \param expression the expression to cast to a different type.
*
* \returns `expression`, cast to `type`. * \returns `expression`, cast to `type`.
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
@ -181,7 +180,6 @@ void *alloca(size_t);
* *
* \param type the type to cast the expression to. * \param type the type to cast the expression to.
* \param expression the expression to cast to a different type. * \param expression the expression to cast to a different type.
*
* \returns `expression`, cast to `type`. * \returns `expression`, cast to `type`.
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
@ -212,8 +210,8 @@ void *alloca(size_t);
* \param B the second ASCII character. * \param B the second ASCII character.
* \param C the third ASCII character. * \param C the third ASCII character.
* \param D the fourth ASCII character. * \param D the fourth ASCII character.
* * \returns the four characters converted into a Uint32, one character
* \returns the four characters converted into a Uint32, one character per-byte. * per-byte.
* *
* \threadsafety It is safe to call this macro from any thread. * \threadsafety It is safe to call this macro from any thread.
* *
@ -3313,14 +3311,15 @@ SDL_FORCE_INLINE SDL_bool SDL_size_add_check_overflow_builtin(size_t a, size_t b
/* This is a generic function pointer which should be cast to the type you expect */ /* This is a generic function pointer which should be cast to the type you expect */
#ifdef SDL_WIKI_DOCUMENTATION_SECTION #ifdef SDL_WIKI_DOCUMENTATION_SECTION
/** /**
* A generic function pointer. * A generic function pointer.
* *
* In theory, generic function pointers should use this, instead of `void *`, * In theory, generic function pointers should use this, instead of `void *`,
* since some platforms could treat code addresses differently than data * since some platforms could treat code addresses differently than data
* addresses. Although in current times no popular platforms make this * addresses. Although in current times no popular platforms make this
* distinction, it is more correct and portable to use the correct type for * distinction, it is more correct and portable to use the correct type for a
* a generic pointer. * generic pointer.
* *
* If for some reason you need to force this typedef to be an actual `void *`, * If for some reason you need to force this typedef to be an actual `void *`,
* perhaps to work around a compiler or existing code, you can define * perhaps to work around a compiler or existing code, you can define