Add documentation for `msg'.

diff --git a/msg.c b/msg.c
index ff317e952f8ec1e4fcf3e83104c9f7d331cfd1bf..08a02851248054ef99c8b412fd5074ab2492048b 100644 (file)
--- a/msg.c
+++ b/msg.c
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: msg.c,v 1.3 1999/03/25 23:36:10 mdw Exp $
+ * $Id: msg.c,v 1.4 1999/04/29 20:48:13 mdw Exp $
  *
  * Display a message and get an answer
  *
@@ -29,6 +29,9 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: msg.c,v $
+ * Revision 1.4  1999/04/29 20:48:13  mdw
+ * Add documentation for `msg'.
+ *
  * Revision 1.3  1999/03/25 23:36:10  mdw
  * Compile to nothing in absence of GTK, for the benefit of parent packages
  * which contain non-GTK-dependent parts.
@@ -75,6 +78,14 @@ static int creply;
  *
  * Use:                Displays a message to the user in a nice dialogue box and
  *             returns the index of the button selected.
+ *
+ *             The @msg@ argument is a @printf@-style format string, which
+ *             contains the message to actually be shown.  The @buttons@
+ *             argument is a comma-separated list of buttons to be drawn,
+ *             from right to left.  A button name can be preceded with `:'
+ *             to indicate that it's the default, or `~' if it's the
+ *             `cancel' button.  The return value is the zero-based index
+ *             of the button selected.
  */
 
 static int close(GtkWidget *w, gpointer p)

diff --git a/msg.h b/msg.h
index f4f121481a6d80857b502a6300ffb12a4c9f0dc7..9f7e825a8018d632c2e4e87147f6e34b056f2a57 100644 (file)
--- a/msg.h
+++ b/msg.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: msg.h,v 1.1 1998/12/11 09:44:21 mdw Exp $
+ * $Id: msg.h,v 1.2 1999/04/29 20:48:13 mdw Exp $
  *
  * Display a message and get an answer
  *
@@ -29,6 +29,9 @@
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: msg.h,v $
+ * Revision 1.2  1999/04/29 20:48:13  mdw
+ * Add documentation for `msg'.
+ *
  * Revision 1.1  1998/12/11 09:44:21  mdw
  * Initial version.
  *
@@ -56,6 +59,14 @@
  *
  * Use:                Displays a message to the user in a nice dialogue box and
  *             returns the index of the button selected.
+ *
+ *             The @msg@ argument is a @printf@-style format string, which
+ *             contains the message to actually be shown.  The @buttons@
+ *             argument is a comma-separated list of buttons to be drawn,
+ *             from right to left.  A button name can be preceded with `:'
+ *             to indicate that it's the default, or `~' if it's the
+ *             `cancel' button.  The return value is the zero-based index
+ *             of the button selected.
  */
 
 extern int msg(const char */*buttons*/, const char */*msg*/, ...);