From 30970780a91fec7e4203e1abe098e798e589c6d8 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Tue, 23 Apr 2024 14:37:44 -0400
Subject: [PATCH] include: Fixed some old Doxygen markup to be Markdown
instead.
---
include/SDL3/SDL_iostream.h | 8 ++++----
include/SDL3/SDL_main.h | 5 +++--
include/SDL3/SDL_sensor.h | 3 ++-
include/SDL3/SDL_test_common.h | 2 +-
4 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h
index 05170595822d6..5f38b3d8372ec 100644
--- a/include/SDL3/SDL_iostream.h
+++ b/include/SDL3/SDL_iostream.h
@@ -73,7 +73,7 @@ typedef struct SDL_IOStreamInterface
Sint64 (SDLCALL *size)(void *userdata);
/**
- * Seek to \c offset relative to \c whence, one of stdio's whence values:
+ * Seek to `offset` relative to `whence`, one of stdio's whence values:
* SDL_IO_SEEK_SET, SDL_IO_SEEK_CUR, SDL_IO_SEEK_END
*
* \return the final offset in the data stream, or -1 on error.
@@ -81,8 +81,8 @@ typedef struct SDL_IOStreamInterface
Sint64 (SDLCALL *seek)(void *userdata, Sint64 offset, int whence);
/**
- * Read up to \c size bytes from the data stream to the area pointed
- * at by \c ptr.
+ * Read up to `size` bytes from the data stream to the area pointed
+ * at by `ptr`.
*
* On an incomplete read, you should set `*status` to a value from the
* SDL_IOStatus enum. You do not have to explicitly set this on
@@ -93,7 +93,7 @@ typedef struct SDL_IOStreamInterface
size_t (SDLCALL *read)(void *userdata, void *ptr, size_t size, SDL_IOStatus *status);
/**
- * Write exactly \c size bytes from the area pointed at by \c ptr
+ * Write exactly `size` bytes from the area pointed at by `ptr`
* to data stream.
*
* On an incomplete write, you should set `*status` to a value from the
diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h
index eed24f8693627..6f214faac9b78 100644
--- a/include/SDL3/SDL_main.h
+++ b/include/SDL3/SDL_main.h
@@ -140,14 +140,15 @@
*
* The application's main() function must be called with C linkage,
* and should be declared like this:
- * \code
+ *
+ * ```c
* #ifdef __cplusplus
* extern "C"
* #endif
* int main(int argc, char *argv[])
* {
* }
- * \endcode
+ * ```
*/
#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE) || defined(SDL_MAIN_USE_CALLBACKS)
diff --git a/include/SDL3/SDL_sensor.h b/include/SDL3/SDL_sensor.h
index a65c954ab7153..d729d02bf26ed 100644
--- a/include/SDL3/SDL_sensor.h
+++ b/include/SDL3/SDL_sensor.h
@@ -79,7 +79,8 @@ typedef Uint32 SDL_SensorID;
*
* Additional sensors may be available, using platform dependent semantics.
*
- * Hare are the additional Android sensors:
+ * Here are the additional Android sensors:
+ *
* https://developer.android.com/reference/android/hardware/SensorEvent.html#values
*
* Accelerometer sensor notes:
diff --git a/include/SDL3/SDL_test_common.h b/include/SDL3/SDL_test_common.h
index 5697c5648c8c0..d8f2af3f42326 100644
--- a/include/SDL3/SDL_test_common.h
+++ b/include/SDL3/SDL_test_common.h
@@ -27,7 +27,7 @@
* This code is a part of the SDL test library, not the main SDL library.
*/
-/* Ported from original test\common.h file. */
+/* Ported from original test/common.h file. */
#ifndef SDL_test_common_h_
#define SDL_test_common_h_