# HG changeset patch
# User Will Thompson <will.thompson@collabora.co.uk>
# Date 1193843829 0
# Node ID 821dc8ba9e3f0c9c0ea95a55f2089e91de6b9077
# Parent  5c26dc790c7191e35720c55e5207a5210d2db565
Document that callbacks for mini-dialogs may be NULL.

diff -r 5c26dc790c71 -r 821dc8ba9e3f pidgin/gtkutils.h
--- a/pidgin/gtkutils.h	Wed Oct 31 00:57:26 2007 +0000
+++ b/pidgin/gtkutils.h	Wed Oct 31 15:17:09 2007 +0000
@@ -616,7 +616,11 @@
  *                       <tt>void *</tt> argument, as which @a user_data will
  *                       be passed.  (Strictly speaking a <tt>GtkButton *</tt>
  *                       will be passed as the second argument, but it can
- *                       safely be omitted.)
+ *                       safely be omitted.)  When a button is pressed, the
+ *                       callback will be called; when the callback returns the
+ *                       dialog will evaporate.  Callbacks may be @c NULL, in
+ *                       which case pressing the corresponding button simply
+ *                       dismisses the dialog.
  * @return               A <tt>GtkWidget *</tt> suitable for passing to
  *                       pidgin_blist_add_alert().
  * @see pidginstock.h