From 22eb09101c00359eebeac95c29a922870dabc351 Mon Sep 17 00:00:00 2001
From: Eduard Gushchin <[EMAIL REDACTED]>
Date: Tue, 31 Dec 2024 18:34:40 +0300
Subject: [PATCH] Added information about the return value and Removed
non-existent methods from the documentation (#453)
---
include/SDL3_ttf/SDL_ttf.h | 10 ++--------
1 file changed, 2 insertions(+), 8 deletions(-)
diff --git a/include/SDL3_ttf/SDL_ttf.h b/include/SDL3_ttf/SDL_ttf.h
index 86a2ad61..f1460b4d 100644
--- a/include/SDL3_ttf/SDL_ttf.h
+++ b/include/SDL3_ttf/SDL_ttf.h
@@ -1705,7 +1705,6 @@ typedef struct TTF_GPUAtlasDrawSequence
*
* \sa TTF_CreateGPUTextEngine
* \sa TTF_CreateText
- * \sa TTF_CreateText_Wrapped
*/
extern SDL_DECLSPEC TTF_GPUAtlasDrawSequence* SDLCALL TTF_GetGPUTextDrawData(TTF_Text *text);
@@ -1851,6 +1850,8 @@ extern SDL_DECLSPEC TTF_TextEngine * SDLCALL TTF_GetTextEngine(TTF_Text *text);
*
* \param text the TTF_Text to modify.
* \param font the font to use, may be NULL.
+ * \returns false if the text pointer is null; otherwise, true.
+ * call SDL_GetError() for more information.
*
* \threadsafety This function should be called on the thread that created the
* text.
@@ -2411,14 +2412,7 @@ extern SDL_DECLSPEC void SDLCALL TTF_DestroyText(TTF_Text *text);
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_OpenFont
- * \sa TTF_OpenFontIndexDPIIO
* \sa TTF_OpenFontIO
- * \sa TTF_OpenFontDPI
- * \sa TTF_OpenFontDPIIO
- * \sa TTF_OpenFontIndex
- * \sa TTF_OpenFontIndexDPI
- * \sa TTF_OpenFontIndexDPIIO
- * \sa TTF_OpenFontIndexIO
*/
extern SDL_DECLSPEC void SDLCALL TTF_CloseFont(TTF_Font *font);