include: filled in category documentation for SDL_messagebox.h.

Reference Issue #11847.
This commit is contained in:
Ryan C. Gordon 2025-01-16 13:16:18 -05:00
parent 21a42d2b0d
commit 22d8e73530
No known key found for this signature in database
GPG key ID: FA148B892AB48044

View file

@ -22,7 +22,18 @@
/**
* # CategoryMessagebox
*
* Message box support routines.
* SDL offers a simple message box API, which is useful for simple alerts,
* such as informing the user when something fatal happens at startup without
* the need to build a UI for it (or informing the user _before_ your UI is
* ready).
*
* These message boxes are native system dialogs where possible.
*
* There is both a customizable function (SDL_ShowMessageBox()) that offers
* lots of options for what to display and reports on what choice the user
* made, and also a much-simplified version (SDL_ShowSimpleMessageBox()),
* merely takes a text message and title, and waits until the user presses
* a single "OK" UI button. Often, this is all that is necessary.
*/
#ifndef SDL_messagebox_h_