include: Fixed copy/paste error in endian-specific SDL_Read function docs.

icculus · icculus · commit b4ac5f43f507 · 2025-06-17T16:41:24.000-04:00
diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h
@@ -823,7 +823,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value);
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -846,7 +846,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -869,7 +869,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -892,7 +892,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -915,7 +915,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -938,7 +938,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -961,7 +961,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -984,7 +984,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -1007,7 +1007,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -1030,7 +1030,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -1053,7 +1053,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.
@@ -1076,7 +1076,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value)
  *
  * \param src the stream from which to read data.
  * \param value a pointer filled in with the data read.
- * \returns true on successful write or false on failure; call SDL_GetError()
+ * \returns true on successful read or false on failure; call SDL_GetError()
  *          for more information.
  *
  * \threadsafety This function is not thread safe.

Original file line number	Diff line number	Diff line change
`@@ -823,7 +823,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream src, Sint8 value);`
`823`	`823`	`*`
`824`	`824`	`* \param src the stream from which to read data.`
`825`	`825`	`* \param value a pointer filled in with the data read.`
`826`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`826`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`827`	`827`	`* for more information.`
`828`	`828`	`*`
`829`	`829`	`* \threadsafety This function is not thread safe.`
`@@ -846,7 +846,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream src, Uint16 value)`
`846`	`846`	`*`
`847`	`847`	`* \param src the stream from which to read data.`
`848`	`848`	`* \param value a pointer filled in with the data read.`
`849`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`849`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`850`	`850`	`* for more information.`
`851`	`851`	`*`
`852`	`852`	`* \threadsafety This function is not thread safe.`
`@@ -869,7 +869,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream src, Sint16 value)`
`869`	`869`	`*`
`870`	`870`	`* \param src the stream from which to read data.`
`871`	`871`	`* \param value a pointer filled in with the data read.`
`872`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`872`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`873`	`873`	`* for more information.`
`874`	`874`	`*`
`875`	`875`	`* \threadsafety This function is not thread safe.`
`@@ -892,7 +892,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream src, Uint16 value)`
`892`	`892`	`*`
`893`	`893`	`* \param src the stream from which to read data.`
`894`	`894`	`* \param value a pointer filled in with the data read.`
`895`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`895`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`896`	`896`	`* for more information.`
`897`	`897`	`*`
`898`	`898`	`* \threadsafety This function is not thread safe.`
`@@ -915,7 +915,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream src, Sint16 value)`
`915`	`915`	`*`
`916`	`916`	`* \param src the stream from which to read data.`
`917`	`917`	`* \param value a pointer filled in with the data read.`
`918`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`918`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`919`	`919`	`* for more information.`
`920`	`920`	`*`
`921`	`921`	`* \threadsafety This function is not thread safe.`
`@@ -938,7 +938,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream src, Uint32 value)`
`938`	`938`	`*`
`939`	`939`	`* \param src the stream from which to read data.`
`940`	`940`	`* \param value a pointer filled in with the data read.`
`941`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`941`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`942`	`942`	`* for more information.`
`943`	`943`	`*`
`944`	`944`	`* \threadsafety This function is not thread safe.`
`@@ -961,7 +961,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream src, Sint32 value)`
`961`	`961`	`*`
`962`	`962`	`* \param src the stream from which to read data.`
`963`	`963`	`* \param value a pointer filled in with the data read.`
`964`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`964`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`965`	`965`	`* for more information.`
`966`	`966`	`*`
`967`	`967`	`* \threadsafety This function is not thread safe.`
`@@ -984,7 +984,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream src, Uint32 value)`
`984`	`984`	`*`
`985`	`985`	`* \param src the stream from which to read data.`
`986`	`986`	`* \param value a pointer filled in with the data read.`
`987`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`987`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`988`	`988`	`* for more information.`
`989`	`989`	`*`
`990`	`990`	`* \threadsafety This function is not thread safe.`
`@@ -1007,7 +1007,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream src, Sint32 value)`
`1007`	`1007`	`*`
`1008`	`1008`	`* \param src the stream from which to read data.`
`1009`	`1009`	`* \param value a pointer filled in with the data read.`
`1010`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`1010`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`1011`	`1011`	`* for more information.`
`1012`	`1012`	`*`
`1013`	`1013`	`* \threadsafety This function is not thread safe.`
`@@ -1030,7 +1030,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream src, Uint64 value)`
`1030`	`1030`	`*`
`1031`	`1031`	`* \param src the stream from which to read data.`
`1032`	`1032`	`* \param value a pointer filled in with the data read.`
`1033`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`1033`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`1034`	`1034`	`* for more information.`
`1035`	`1035`	`*`
`1036`	`1036`	`* \threadsafety This function is not thread safe.`
`@@ -1053,7 +1053,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream src, Sint64 value)`
`1053`	`1053`	`*`
`1054`	`1054`	`* \param src the stream from which to read data.`
`1055`	`1055`	`* \param value a pointer filled in with the data read.`
`1056`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`1056`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`1057`	`1057`	`* for more information.`
`1058`	`1058`	`*`
`1059`	`1059`	`* \threadsafety This function is not thread safe.`
`@@ -1076,7 +1076,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream src, Uint64 value)`
`1076`	`1076`	`*`
`1077`	`1077`	`* \param src the stream from which to read data.`
`1078`	`1078`	`* \param value a pointer filled in with the data read.`
`1079`		`- * \returns true on successful write or false on failure; call SDL_GetError()`
	`1079`	`+ * \returns true on successful read or false on failure; call SDL_GetError()`
`1080`	`1080`	`* for more information.`
`1081`	`1081`	`*`
`1082`	`1082`	`* \threadsafety This function is not thread safe.`