From 474db07f6a5fe0fadc352948b12798635e419fdd Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 27 Feb 2009 21:02:19 +0000 Subject: [PATCH] Clarify docs svn path=/trunk/; revision=7923 --- gio/ChangeLog | 7 +++++++ gio/gmountoperation.c | 22 +++++++++++++++------- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/gio/ChangeLog b/gio/ChangeLog index 2d3c57c..9b3ea50 100644 --- a/gio/ChangeLog +++ b/gio/ChangeLog @@ -1,3 +1,10 @@ +2009-02-27 Matthias Clasen + + 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 Bug 573462 – GEmblemedIcon leak diff --git a/gio/gmountoperation.c b/gio/gmountoperation.c index 0635e75..18311f9 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, -- 2.7.4