Minor doc improvements

This commit is contained in:
Matthias Clasen 2011-11-30 19:04:08 -05:00 committed by Ryan Lortie
parent c8e76fdda2
commit eb09099f65
3 changed files with 10 additions and 11 deletions

View File

@ -3651,7 +3651,6 @@ G_IS_MENU_ITEM
GMenuModel GMenuModel
g_menu_model_is_mutable g_menu_model_is_mutable
g_menu_model_get_n_items g_menu_model_get_n_items
g_menu_model_get_item
<SUBSECTION> <SUBSECTION>
G_MENU_ATTRIBUTE_ACTION G_MENU_ATTRIBUTE_ACTION

View File

@ -28,7 +28,7 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
/** /**
* SECTION:gaction * SECTION:gaction
* @title: GAction * @title: GAction
* @short_description: An action * @short_description: An action interface
* *
* #GAction represents a single named action. * #GAction represents a single named action.
* *

View File

@ -633,7 +633,7 @@ g_menu_model_get_item_link (GMenuModel *model,
* @removed: the number of items removed * @removed: the number of items removed
* @added: the number of items added * @added: the number of items added
* *
* Requests emission of the #GMenuMode::items-changed signal on @model. * Requests emission of the #GMenuModel::items-changed signal on @model.
* *
* This function should never be called except by #GMenuModel * This function should never be called except by #GMenuModel
* subclasses. Any other calls to this function will very likely lead * subclasses. Any other calls to this function will very likely lead
@ -820,21 +820,21 @@ struct _GMenuLinkIterPrivate
/** /**
* g_menu_link_iter_get_next: * g_menu_link_iter_get_next:
* @iter: a #GMenuLinkIter * @iter: a #GMenuLinkIter
* @out_name: (out) (allow-none) (transfer none): the name of the link * @out_link: (out) (allow-none) (transfer none): the name of the link
* @value: (out) (allow-none) (transfer full): the linked #GMenuModel * @value: (out) (allow-none) (transfer full): the linked #GMenuModel
* *
* This function combines g_menu_link_iter_next() with * This function combines g_menu_link_iter_next() with
* g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). * g_menu_link_iter_get_name() and g_menu_link_iter_get_value().
* *
* First the iterator is advanced to the next (possibly first) link. If * First the iterator is advanced to the next (possibly first) link.
* that fails, then %FALSE is returned and there are no other effects. * If that fails, then %FALSE is returned and there are no other effects.
* *
* If successful, @out_name and @value are set to the name and #GMenuModel * If successful, @out_link and @value are set to the name and #GMenuModel
* of the link that has just been advanced to. At this point, * of the link that has just been advanced to. At this point,
* g_menu_item_get_name() and g_menu_item_get_value() will return the * g_menu_item_get_name() and g_menu_item_get_value() will return the
* same values again. * same values again.
* *
* The value returned in @out_name remains valid for as long as the iterator * The value returned in @out_link remains valid for as long as the iterator
* remains at the current position. The value returned in @value must * remains at the current position. The value returned in @value must
* be unreffed using g_object_unref() when it is no longer in use. * be unreffed using g_object_unref() when it is no longer in use.
* *
@ -842,7 +842,7 @@ struct _GMenuLinkIterPrivate
**/ **/
gboolean gboolean
g_menu_link_iter_get_next (GMenuLinkIter *iter, g_menu_link_iter_get_next (GMenuLinkIter *iter,
const gchar **out_name, const gchar **out_link,
GMenuModel **value) GMenuModel **value)
{ {
const gchar *name; const gchar *name;
@ -861,8 +861,8 @@ g_menu_link_iter_get_next (GMenuLinkIter *iter,
g_assert (name != NULL); g_assert (name != NULL);
iter->priv->name = g_quark_from_string (name); iter->priv->name = g_quark_from_string (name);
if (out_name) if (out_link)
*out_name = g_quark_to_string (iter->priv->name); *out_link = g_quark_to_string (iter->priv->name);
if (value) if (value)
*value = g_object_ref (iter->priv->value); *value = g_object_ref (iter->priv->value);