Added some documentation on the behavior of SDL_ShowMessageBox()

libsdl-org · Oct 30, 2012 · 1eeaace · 1eeaace
1 parent aed432b
commit 1eeaace
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/include/SDL_messagebox.h b/include/SDL_messagebox.h
@@ -111,6 +111,11 @@ typedef struct
  *
  *  \return -1 on error, otherwise 0 and buttonid contains user id of button
  *          hit or -1 if dialog was closed.
+ *
+ *  \note This function should be called on the thread that created the parent
+ *        window, or on the main thread if the messagebox has no parent.  It will
+ *        block execution of that thread until the user clicks a button or
+ *        closes the messagebox.
  */
 extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid);
 
@@ -123,6 +128,8 @@ extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *message
  *  \param window   The parent window, or NULL for no parent
  *
  *  \return 0 on success, -1 on error
+ *
+ *  \sa SDL_ShowMessageBox
  */
 extern DECLSPEC int SDLCALL SDL_ShowSimpleMessageBox(Uint32 flags, const char *title, const char *message, SDL_Window *window);