luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-05-16 10:51:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

GSimpleAction: Clarify/fix @parameter(_type) docs

Browse Source 
If something is nullable, it's always helpful to identify what NULL
means. Also, this is not the parameter for the .activate() vfunc, as we
take that over: rather, it is the parameter for the ::activate signal.

https://bugzilla.gnome.org/show_bug.cgi?id=795070
This commit is contained in:
Daniel Boles 2018-04-08 11:39:32 +01:00
parent 19ffd365ff
commit 75021c6c6e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gio/gsimpleaction.c
View File

@ -371,7 +371,8 @@ g_simple_action_class_init (GSimpleActionClass *class)
/** /**
* GSimpleAction::activate: * GSimpleAction::activate:
* @simple: the #GSimpleAction * @simple: the #GSimpleAction
* @parameter: (nullable): the parameter to the activation * @parameter: (nullable): the parameter to the activation, or %NULL if it has
* no parameter
* *
* Indicates that the action was just activated. * Indicates that the action was just activated.
* *
@ -591,7 +592,8 @@ g_simple_action_set_state_hint (GSimpleAction *simple,
/** /**
* g_simple_action_new: * g_simple_action_new:
* @name: the name of the action * @name: the name of the action
* @parameter_type: (nullable): the type of parameter to the activate function * @parameter_type: (nullable): the type of parameter that will be passed to
* handlers for the #GSimpleAction::activate signal, or %NULL for no parameter
* *
* Creates a new action. * Creates a new action.
* *
@ -616,7 +618,8 @@ g_simple_action_new (const gchar *name,
/** /**
* g_simple_action_new_stateful: * g_simple_action_new_stateful:
* @name: the name of the action * @name: the name of the action
* @parameter_type: (nullable): the type of the parameter to the activate function * @parameter_type: (nullable): the type of the parameter that will be passed to
* handlers for the #GSimpleAction::activate signal, or %NULL for no parameter
* @state: the initial state of the action * @state: the initial state of the action
* *
* Creates a new stateful action. * Creates a new stateful action.