Commit ff0c30b5 authored by Daniel Boles's avatar Daniel Boles

GSimpleAction: Slightly improve docs for new()s

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
parent 21348867
......@@ -600,7 +600,8 @@ g_simple_action_set_state_hint (GSimpleAction *simple,
*
* 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
*
......@@ -627,10 +628,10 @@ g_simple_action_new (const gchar *name,
*
* Creates a new stateful action.
*
* @state is the initial state of the action. All future state values
* must have the same #GVariantType as the initial state.
* All future state values must have the same #GVariantType as the initial
* @state.
*
* If the @state GVariant is floating, it is consumed.
* If the @state #GVariant is floating, it is consumed.
*
* Returns: a new #GSimpleAction
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment