From c43b976e5b7deeb46d581153522ecbc03ec0d5cf Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sat, 21 Sep 2024 13:17:38 +0000
Subject: [PATCH] Sync SDL2 wiki -> header
---
include/SDL_events.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/include/SDL_events.h b/include/SDL_events.h
index 81fd6e41b6350..33d6da4b7eda1 100644
--- a/include/SDL_events.h
+++ b/include/SDL_events.h
@@ -637,6 +637,14 @@ typedef struct SDL_SysWMEvent
/**
* General event structure
+ *
+ * The SDL_Event structure is the core of all event handling in SDL. SDL_Event
+ * is a union of all event structures used in SDL. Using it is a simple matter
+ * of knowing which event type corresponds to which union member. The table
+ * below lists these relationships.
+ *
+ * The SDL_Event structure has two uses: * Reading events from the event queue
+ * * Placing events on the event queue
*/
typedef union SDL_Event
{