Commit 0dc57b0f08782b1eae8f74a20f47b61d2ce760b5

Sam Lantinga 2021-10-14T19:42:36

Remove slightly misleading comment in the example code

1
2
3
4
5
6
7
8
9
10
11
12
13
diff --git a/include/SDL_events.h b/include/SDL_events.h
index c1e28f7..e4757ef 100644
--- a/include/SDL_events.h
+++ b/include/SDL_events.h
@@ -811,7 +811,7 @@ extern DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType);
  * while (game_is_still_running) {
  *     SDL_Event event;
  *     SDL_PumpEvents();
- *     while (SDL_PeepEvents(&event, 1, SDL_GETEVENT, 0, SDL_LASTEVENT) == 1) {  // poll until all events are handled!
+ *     while (SDL_PeepEvents(&event, 1, SDL_GETEVENT, 0, SDL_LASTEVENT) == 1) {
  *         // decide what to do with this event.
  *     }
  *