From 3d7b6efedd0d2c9cfc6ee0a18906550d6c98d07a Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Thu, 6 Feb 2025 19:25:27 +0000
Subject: [PATCH] Sync SDL3_ttf wiki -> header
[ci skip]
---
include/SDL3_ttf/SDL_ttf.h | 29 +++++++++++++++++++++--------
1 file changed, 21 insertions(+), 8 deletions(-)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index 969cc1be..a3c23350 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -959,8 +959,10 @@ extern SDL_DECLSPEC Uint32 SDLCALL TTF_StringToTag(const char *string);
* Convert from a 32-bit tag to a 4 character string.
*
* \param tag the 32-bit tag to convert.
- * \param string a pointer filled in with the 4 character representation of the tag.
- * \param size the size of the buffer pointed at by string, should be at least 4.
+ * \param string a pointer filled in with the 4 character representation of
+ * the tag.
+ * \param size the size of the buffer pointed at by string, should be at least
+ * 4.
*
* \threadsafety It is safe to call this function from any thread.
*
@@ -978,7 +980,9 @@ extern SDL_DECLSPEC void SDLCALL TTF_TagToString(Uint32 tag, char *string, size_
* This updates any TTF_Text objects using this font.
*
* \param font the font to modify.
- * \param script an [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html).
+ * \param script an
+ * [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html)
+ * .
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
@@ -995,7 +999,9 @@ extern SDL_DECLSPEC bool SDLCALL TTF_SetFontScript(TTF_Font *font, Uint32 script
* Get the script used for text shaping a font.
*
* \param font the font to query.
- * \returns an [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html) or 0 if a script hasn't been set.
+ * \returns an
+ * [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html)
+ * or 0 if a script hasn't been set.
*
* \threadsafety This function should be called on the thread that created the
* font.
@@ -1010,8 +1016,10 @@ extern SDL_DECLSPEC Uint32 SDLCALL TTF_GetFontScript(TTF_Font *font);
* Get the script used by a 32-bit codepoint.
*
* \param ch the character code to check.
- * \returns an [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html) on success, or 0 on
- * failure; call SDL_GetError() for more information.
+ * \returns an
+ * [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html)
+ * on success, or 0 on failure; call SDL_GetError() for more
+ * information.
*
* \threadsafety This function is thread-safe.
*
@@ -2148,7 +2156,9 @@ extern SDL_DECLSPEC TTF_Direction SDLCALL TTF_GetTextDirection(TTF_Text *text);
* This returns false if SDL_ttf isn't built with HarfBuzz support.
*
* \param text the text to modify.
- * \param script an [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html).
+ * \param script an
+ * [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html)
+ * .
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
@@ -2167,7 +2177,10 @@ extern SDL_DECLSPEC bool SDLCALL TTF_SetTextScript(TTF_Text *text, Uint32 script
* This defaults to the script of the font used by the text object.
*
* \param text the text to query.
- * \returns an [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html) or 0 if a script hasn't been set on either the text object or the font.
+ * \returns an
+ * [ISO 15924 code](https://unicode.org/iso15924/iso15924-codes.html)
+ * or 0 if a script hasn't been set on either the text object or the
+ * font.
*
* \threadsafety This function should be called on the thread that created the
* text.