From aefdb46723e1bab8870bc4b80d1f613d96b2d489 Mon Sep 17 00:00:00 2001
From: Ozkan Sezer <[EMAIL REDACTED]>
Date: Wed, 6 Jul 2022 10:25:20 +0300
Subject: [PATCH] added missing \since fields for several public functions
---
SDL_image.h | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 60 insertions(+)
diff --git a/SDL_image.h b/SDL_image.h
index c3c590c3..13586fd3 100644
--- a/SDL_image.h
+++ b/SDL_image.h
@@ -508,6 +508,8 @@ extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTextureTyped_RW(SDL_Renderer *rend
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is FILETYPE data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -550,6 +552,8 @@ extern DECLSPEC int SDLCALL IMG_isAVIF(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is ICO data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isCUR
* \sa IMG_isBMP
@@ -591,6 +595,8 @@ extern DECLSPEC int SDLCALL IMG_isICO(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is CUR data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isBMP
@@ -632,6 +638,8 @@ extern DECLSPEC int SDLCALL IMG_isCUR(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is BMP data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -673,6 +681,8 @@ extern DECLSPEC int SDLCALL IMG_isBMP(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is GIF data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -714,6 +724,8 @@ extern DECLSPEC int SDLCALL IMG_isGIF(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is JPG data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -755,6 +767,8 @@ extern DECLSPEC int SDLCALL IMG_isJPG(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is JXL data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -796,6 +810,8 @@ extern DECLSPEC int SDLCALL IMG_isJXL(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is LBM data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -837,6 +853,8 @@ extern DECLSPEC int SDLCALL IMG_isLBM(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is PCX data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -878,6 +896,8 @@ extern DECLSPEC int SDLCALL IMG_isPCX(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is PNG data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -919,6 +939,8 @@ extern DECLSPEC int SDLCALL IMG_isPNG(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is PNM data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -960,6 +982,8 @@ extern DECLSPEC int SDLCALL IMG_isPNM(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is SVG data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.2.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1001,6 +1025,8 @@ extern DECLSPEC int SDLCALL IMG_isSVG(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is QOI data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1042,6 +1068,8 @@ extern DECLSPEC int SDLCALL IMG_isQOI(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is TIFF data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1083,6 +1111,8 @@ extern DECLSPEC int SDLCALL IMG_isTIF(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is XCF data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1124,6 +1154,8 @@ extern DECLSPEC int SDLCALL IMG_isXCF(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is XPM data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1165,6 +1197,8 @@ extern DECLSPEC int SDLCALL IMG_isXPM(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is XV data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1206,6 +1240,8 @@ extern DECLSPEC int SDLCALL IMG_isXV(SDL_RWops *src);
* \param src a seekable/readable SDL_RWops to provide image data.
* \returns non-zero if this is WEBP data, zero otherwise.
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
@@ -1279,6 +1315,8 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadWEBP_RW(SDL_RWops *src);
* \param width width
* \param height height
* \returns SDL surface, or NULL on error
+ *
+ * \since This function is available since SDL_image 2.6.0.
*/
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadSizedSVG_RW(SDL_RWops *src, int width, int height);
@@ -1289,6 +1327,8 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadSizedSVG_RW(SDL_RWops *src, int wi
* \param xpm null terminated array of strings
* \returns SDL surface, or NULL on error
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_ReadXPMFromArrayToRGB888
*/
extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArray(char **xpm);
@@ -1299,6 +1339,8 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArray(char **xpm);
* \param xpm null terminated array of strings
* \returns SDL surface, or NULL on error
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_ReadXPMFromArray
*/
extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArrayToRGB888(char **xpm);
@@ -1310,6 +1352,8 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArrayToRGB888(char **xpm);
* \param file file name
* \returns 0 if successful, -1 on error
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_SavePNG_RW
* \sa IMG_SaveJPG
* \sa IMG_SaveJPG_RW
@@ -1324,6 +1368,8 @@ extern DECLSPEC int SDLCALL IMG_SavePNG(SDL_Surface *surface, const char *file);
* \param freedst free dst
* \returns 0 if successful, -1 on error
*
+ * \since This function is available since SDL_image 2.0.0.
+ *
* \sa IMG_SavePNG
* \sa IMG_SaveJPG
* \sa IMG_SaveJPG_RW
@@ -1339,6 +1385,8 @@ extern DECLSPEC int SDLCALL IMG_SavePNG_RW(SDL_Surface *surface, SDL_RWops *dst,
* 100] is Highest quality
* \returns 0 if successful, -1 on error
*
+ * \since This function is available since SDL_image 2.0.2.
+ *
* \sa IMG_SavePNG
* \sa IMG_SavePNG_RW
* \sa IMG_SaveJPG_RW
@@ -1355,6 +1403,8 @@ extern DECLSPEC int SDLCALL IMG_SaveJPG(SDL_Surface *surface, const char *file,
* 100] is Highest quality
* \returns 0 if successful, -1 on error
*
+ * \since This function is available since SDL_image 2.0.2.
+ *
* \sa IMG_SavePNG
* \sa IMG_SavePNG_RW
* \sa IMG_SaveJPG
@@ -1379,6 +1429,8 @@ typedef struct
* \param file file name
* \returns IMG Animation, or NULL on error.
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_FreeAnimation
*/
extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation(const char *file);
@@ -1391,6 +1443,8 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation(const char *file);
* called
* \returns IMG Animation, or NULL on error
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_FreeAnimation
*/
extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation_RW(SDL_RWops *src, int freesrc);
@@ -1404,6 +1458,8 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation_RW(SDL_RWops *src, int
* \param type may be one of: "BMP", "GIF", "PNG", etc.
* \returns IMG Animation, or NULL on error
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_FreeAnimation
*/
extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimationTyped_RW(SDL_RWops *src, int freesrc, const char *type);
@@ -1413,6 +1469,8 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimationTyped_RW(SDL_RWops *src
*
* \param anim animation
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_LoadAnimation
* \sa IMG_LoadAnimation_RW
* \sa IMG_LoadAnimationTyped_RW
@@ -1425,6 +1483,8 @@ extern DECLSPEC void SDLCALL IMG_FreeAnimation(IMG_Animation *anim);
* \param src RWops
* \returns IMG Animation, or NULL on error
*
+ * \since This function is available since SDL_image 2.6.0.
+ *
* \sa IMG_FreeAnimation
*/
extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadGIFAnimation_RW(SDL_RWops *src);