luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 03:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

GSimpleAction: Slightly improve docs for new()s

Browse Source 
Explain why we say "See new_stateful()" (although it's pretty obvious).
Drop a redundant copy of the argument description in the body text.
Add a # to the GVariant type name so that we can have a nice link.

https://bugzilla.gnome.org/show_bug.cgi?id=795070
This commit is contained in:
Daniel Boles 2018-04-08 11:41:17 +01:00
parent 21348867fe
commit ff0c30b516
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gio/gsimpleaction.c
View File

@ -600,7 +600,8 @@ g_simple_action_set_state_hint (GSimpleAction *simple,
* *
* Creates a new action. * Creates a new action.
* *
* The created action is stateless. See g_simple_action_new_stateful(). * The created action is stateless. See g_simple_action_new_stateful() to create
* an action that has state.
* *
* Returns: a new #GSimpleAction * Returns: a new #GSimpleAction
* *
@ -627,10 +628,10 @@ g_simple_action_new (const gchar *name,
* *
* Creates a new stateful action. * Creates a new stateful action.
* *
* @state is the initial state of the action. All future state values * All future state values must have the same #GVariantType as the initial
* must have the same #GVariantType as the initial state. * @state.
* *
* If the @state GVariant is floating, it is consumed. * If the @state #GVariant is floating, it is consumed.
* *
* Returns: a new #GSimpleAction * Returns: a new #GSimpleAction
* *