Sync SDL2_image wiki -> header

libsdl-org · Jun 14, 2024 · 0a08a01 · 0a08a01
1 parent f27ef4b
commit 0a08a01
Showing 1 changed file with 27 additions and 27 deletions.
diff --git a/include/SDL_image.h b/include/SDL_image.h
@@ -85,7 +85,7 @@ extern "C" {
  * it should NOT be used to fill a version structure, instead you should use
  * the SDL_IMAGE_VERSION() macro.
  *
- * \returns SDL_image version
+ * \returns SDL_image version.
  */
 extern DECLSPEC const SDL_version * SDLCALL IMG_Linked_Version(void);
 
@@ -1272,7 +1272,7 @@ extern DECLSPEC int SDLCALL IMG_isWEBP(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.6.0.
  *
@@ -1306,7 +1306,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadAVIF_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1340,7 +1340,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadICO_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1374,7 +1374,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadCUR_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1408,7 +1408,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadBMP_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1442,7 +1442,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadGIF_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1476,7 +1476,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadJPG_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.6.0.
  *
@@ -1510,7 +1510,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadJXL_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1544,7 +1544,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadLBM_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1578,7 +1578,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPCX_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1612,7 +1612,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPNG_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1646,7 +1646,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPNM_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.2.
  *
@@ -1680,7 +1680,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadSVG_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.6.0.
  *
@@ -1714,7 +1714,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadQOI_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1748,7 +1748,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadTGA_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1782,7 +1782,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadTIF_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1816,7 +1816,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXCF_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1850,7 +1850,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXPM_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1884,7 +1884,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXV_RW(SDL_RWops *src);
  * interface available here.
  *
  * \param src an SDL_RWops to load image data from.
- * \returns SDL surface, or NULL on error
+ * \returns SDL surface, or NULL on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1973,9 +1973,9 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArrayToRGB888(char **xpm);
  *
  * If the file already exists, it will be overwritten.
  *
- * \param surface the SDL surface to save
+ * \param surface the SDL surface to save.
  * \param file path on the filesystem to write new file to.
- * \returns 0 if successful, -1 on error
+ * \returns 0 if successful, -1 on error.
  *
  * \since This function is available since SDL_image 2.0.0.
  *
@@ -1990,7 +1990,7 @@ extern DECLSPEC int SDLCALL IMG_SavePNG(SDL_Surface *surface, const char *file);
  *
  * If you just want to save to a filename, you can use IMG_SavePNG() instead.
  *
- * \param surface the SDL surface to save
+ * \param surface the SDL surface to save.
  * \param dst the SDL_RWops to save the image data to.
  * \returns 0 if successful, -1 on error.
  *
@@ -2007,11 +2007,11 @@ extern DECLSPEC int SDLCALL IMG_SavePNG_RW(SDL_Surface *surface, SDL_RWops *dst,
  *
  * If the file already exists, it will be overwritten.
  *
- * \param surface the SDL surface to save
+ * \param surface the SDL surface to save.
  * \param file path on the filesystem to write new file to.
  * \param quality [0; 33] is Lowest quality, [34; 66] is Middle quality, [67;
- *                100] is Highest quality
- * \returns 0 if successful, -1 on error
+ *                100] is Highest quality.
+ * \returns 0 if successful, -1 on error.
  *
  * \since This function is available since SDL_image 2.0.2.
  *
@@ -2026,7 +2026,7 @@ extern DECLSPEC int SDLCALL IMG_SaveJPG(SDL_Surface *surface, const char *file,
  *
  * If you just want to save to a filename, you can use IMG_SaveJPG() instead.
  *
- * \param surface the SDL surface to save
+ * \param surface the SDL surface to save.
  * \param dst the SDL_RWops to save the image data to.
  * \returns 0 if successful, -1 on error.
  *