Add documentation for `msg'.

[mgLib] / msg.h

diff --git a/msg.h b/msg.h
index f4f1214..9f7e825 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*/, ...);