From ad840e8796ad2560d5cbe2144200dac69050cb5d Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Tue, 25 Feb 2025 08:38:39 -0800
Subject: [PATCH] Better document that main functionality is in SDL_main.h
Fixes https://github.com/libsdl-org/SDL/issues/12159
---
include/SDL3/SDL_main.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h
index 2e7a2ebb6c67e..518b0ac129866 100644
--- a/include/SDL3/SDL_main.h
+++ b/include/SDL3/SDL_main.h
@@ -28,6 +28,9 @@
* should look like this:
*
* ```c
+ * #include <SDL3/SDL.h>
+ * #include <SDL3/SDL_main.h>
+ *
* int main(int argc, char *argv[])
* {
* }
@@ -38,7 +41,7 @@
* This is also where an app can be configured to use the main callbacks, via
* the SDL_MAIN_USE_CALLBACKS macro.
*
- * This is a "single-header library," which is to say that including this
+ * SDL_main.h is a "single-header library," which is to say that including this
* header inserts code into your program, and you should only include it once
* in most cases. SDL.h does not include this header automatically.
*