Added some documentation on the behavior of SDL_ShowMessageBox()
authorSam Lantinga <slouken@libsdl.org>
Tue, 30 Oct 2012 10:07:32 -0700
changeset 6613 0a8672b04b00
parent 6612 9a22ac8befa9
child 6614 92925281e7ca
Added some documentation on the behavior of SDL_ShowMessageBox()
include/SDL_messagebox.h
--- a/include/SDL_messagebox.h	Sun Oct 28 19:28:44 2012 -0700
+++ b/include/SDL_messagebox.h	Tue Oct 30 10:07:32 2012 -0700
@@ -111,6 +111,11 @@
  *
  *  \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 @@
  *  \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);