luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-09-28 01:57:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

GNotification: Some small documentation fixes

Browse Source 
Use #GVariant instead of GVariant.

g_notification_add_button_with_target,
g_notification_set_default_action_and_target:
Replace 'format_string' with 'target_format'.

g_notification_set_default_action_and_target_value:
Remove paragraph that apparently had been accidentally copied from
g_notification_set_default_action_and_target.

https://bugzilla.gnome.org/show_bug.cgi?id=727123
This commit is contained in:
Volker Sobek
2014-03-26 23:10:00 +01:00
parent 3f8f040349
commit 14d436f526
1 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
gio/gnotification.c
View File

@@ -366,15 +366,15 @@ g_notification_add_button (GNotification *notification,
* @notification: a #GNotification * @notification: a #GNotification
* @label: label of the button * @label: label of the button
* @action: an action name * @action: an action name
* @target_format: (allow-none): a GVariant format string, or %NULL * @target_format: (allow-none): a #GVariant format string, or %NULL
* @...: positional parameters, as determined by @format_string * @...: positional parameters, as determined by @target_format
* *
* Adds a button to @notification that activates @action when clicked. * Adds a button to @notification that activates @action when clicked.
* @action must be an application-wide action (it must start with "app."). * @action must be an application-wide action (it must start with "app.").
* *
* If @target_format is given, it is used to collect remaining * If @target_format is given, it is used to collect remaining
* positional parameters into a GVariant instance, similar to * positional parameters into a #GVariant instance, similar to
* g_variant_new(). @action will be activated with that GVariant as its * g_variant_new(). @action will be activated with that #GVariant as its
* parameter. * parameter.
* *
* Since: 2.40 * Since: 2.40
@@ -404,7 +404,7 @@ g_notification_add_button_with_target (GNotification *notification,
* @notification: a #GNotification * @notification: a #GNotification
* @label: label of the button * @label: label of the button
* @action: an action name * @action: an action name
* @target: (allow-none): a GVariant to use as @action's parameter, or %NULL * @target: (allow-none): a #GVariant to use as @action's parameter, or %NULL
* *
* Adds a button to @notification that activates @action when clicked. * Adds a button to @notification that activates @action when clicked.
* @action must be an application-wide action (it must start with "app."). * @action must be an application-wide action (it must start with "app.").
@@ -594,16 +594,16 @@ g_notification_set_default_action (GNotification *notification,
* g_notification_set_default_action_and_target: (skip) * g_notification_set_default_action_and_target: (skip)
* @notification: a #GNotification * @notification: a #GNotification
* @action: an action name * @action: an action name
* @target_format: (allow-none): a GVariant format string, or %NULL * @target_format: (allow-none): a #GVariant format string, or %NULL
* @...: positional parameters, as determined by @format_string * @...: positional parameters, as determined by @target_format
* *
* Sets the default action of @notification to @action. This action is * Sets the default action of @notification to @action. This action is
* activated when the notification is clicked on. It must be an * activated when the notification is clicked on. It must be an
* application-wide action (it must start with "app."). * application-wide action (it must start with "app.").
* *
* If @target_format is given, it is used to collect remaining * If @target_format is given, it is used to collect remaining
* positional parameters into a GVariant instance, similar to * positional parameters into a #GVariant instance, similar to
* g_variant_new(). @action will be activated with that GVariant as its * g_variant_new(). @action will be activated with that #GVariant as its
* parameter. * parameter.
* *
* When no default action is set, the application that the notification * When no default action is set, the application that the notification
@@ -634,16 +634,12 @@ g_notification_set_default_action_and_target (GNotification *notification,
* g_notification_set_default_action_and_target_value: (rename-to g_notification_set_default_action_and_target) * g_notification_set_default_action_and_target_value: (rename-to g_notification_set_default_action_and_target)
* @notification: a #GNotification * @notification: a #GNotification
* @action: an action name * @action: an action name
* @target: (allow-none): a GVariant to use as @action's parameter, or %NULL * @target: (allow-none): a #GVariant to use as @action's parameter, or %NULL
* *
* Sets the default action of @notification to @action. This action is * Sets the default action of @notification to @action. This action is
* activated when the notification is clicked on. It must be an * activated when the notification is clicked on. It must be an
* application-wide action (start with "app."). * application-wide action (start with "app.").
* *
* If @target_format is given, it is used to collect remaining
* positional parameters into a GVariant instance, similar to
* g_variant_new().
*
* If @target is non-%NULL, @action will be activated with @target as * If @target is non-%NULL, @action will be activated with @target as
* its parameter. * its parameter.
* *