summaryrefslogtreecommitdiff
path: root/gio
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2009-02-27 21:02:19 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2009-02-27 21:02:19 +0000
commit474db07f6a5fe0fadc352948b12798635e419fdd (patch)
tree1891a344bafd5b09c7eb2b17249fa2d3c9f2b29d /gio
parent24440f7c8693f48a053efa04206f4c2ef1be3f35 (diff)
downloadglib-474db07f6a5fe0fadc352948b12798635e419fdd.tar.gz
Clarify docs
svn path=/trunk/; revision=7923
Diffstat (limited to 'gio')
-rw-r--r--gio/ChangeLog7
-rw-r--r--gio/gmountoperation.c22
2 files changed, 22 insertions, 7 deletions
diff --git a/gio/ChangeLog b/gio/ChangeLog
index 2d3c57cd3..9b3ea5046 100644
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,10 @@
+2009-02-27 Matthias Clasen <mclasen@redhat.com>
+
+ Bug 573421 – Clarify message format in GMountOperation
+
+ * gmountoperation.c: Document that the first line of a
+ multi-line message should be interpreted as a heading.
+
2009-02-27 David Zeuthen <davidz@redhat.com>
Bug 573462 – GEmblemedIcon leak
diff --git a/gio/gmountoperation.c b/gio/gmountoperation.c
index 0635e7594..18311f9d1 100644
--- a/gio/gmountoperation.c
+++ b/gio/gmountoperation.c
@@ -248,8 +248,12 @@ g_mount_operation_class_init (GMountOperationClass *klass)
* @default_user: string containing the default user name.
* @default_domain: string containing the default domain.
* @flags: a set of #GAskPasswordFlags.
- *
+ *
* Emitted when a mount operation asks the user for a password.
+ *
+ * If the message contains a line break, the first line should be
+ * presented as a heading. For example, it may be used as the
+ * primary text in a #GtkMessageDialog.
*/
signals[ASK_PASSWORD] =
g_signal_new (I_("ask-password"),
@@ -266,9 +270,13 @@ g_mount_operation_class_init (GMountOperationClass *klass)
* @op: a #GMountOperation asking a question.
* @message: string containing a message to display to the user.
* @choices: an array of strings for each possible choice.
- *
- * Emitted when asking the user a question and gives a list of
- * choices for the user to choose from.
+ *
+ * Emitted when asking the user a question and gives a list of
+ * choices for the user to choose from.
+ *
+ * If the message contains a line break, the first line should be
+ * presented as a heading. For example, it may be used as the
+ * primary text in a #GtkMessageDialog.
*/
signals[ASK_QUESTION] =
g_signal_new (I_("ask-question"),
@@ -284,7 +292,7 @@ g_mount_operation_class_init (GMountOperationClass *klass)
* GMountOperation::reply:
* @op: a #GMountOperation.
* @result: a #GMountOperationResult indicating how the request was handled
- *
+ *
* Emitted when the user has replied to the mount operation.
*/
signals[REPLY] =
@@ -301,14 +309,14 @@ g_mount_operation_class_init (GMountOperationClass *klass)
* GMountOperation::aborted:
*
* Emitted by the backend when e.g. a device becomes unavailable
- * while a mount operation is in progress.
+ * while a mount operation is in progress.
*
* Implementations of GMountOperation should handle this signal
* by dismissing open password dialogs.
*
* Since: 2.20
*/
- signals[ABORTED] =
+ signals[ABORTED] =
g_signal_new (I_("aborted"),
G_TYPE_FROM_CLASS (object_class),
G_SIGNAL_RUN_LAST,