[glib/wip/menus] Fix up some iter confusion in the docs



commit c0e132d395b6fdb21efe410c151d6a96226cc60c
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Nov 1 01:53:29 2011 -0400

    Fix up some iter confusion in the docs

 gio/gmenumodel.c |   36 ++++++++++++++++++------------------
 1 files changed, 18 insertions(+), 18 deletions(-)
---
diff --git a/gio/gmenumodel.c b/gio/gmenumodel.c
index faf6d03..e9f8b95 100644
--- a/gio/gmenumodel.c
+++ b/gio/gmenumodel.c
@@ -611,13 +611,13 @@ g_menu_model_get_item (GMenuModel     *model,
  * @model: a #GMenuModel
  * @item_index: the index of the item
  *
- * Creates a #GMenuLinkIter to iterate over the links of the item at
- * position @item_index in @model.
+ * Creates a #GMenuAttributeIter to iterate over the attributes of
+ * the item at position @item_index in @model.
  *
  * You must free the iterator with g_object_unref() when you are done.
  *
- * Returns: (transfer full): a new #GMenuLinkIter
- **/
+ * Returns: (transfer full): a new #GMenuAttributeIter
+ */
 GMenuAttributeIter *
 g_menu_model_iterate_item_attributes (GMenuModel *model,
                                       gint        item_index)
@@ -632,7 +632,7 @@ g_menu_model_iterate_item_attributes (GMenuModel *model,
  * @item_index: the index of the item
  * @attribute: the attribute to query
  * @expected_type: (allow-none): the expected type of the attribute, or
- *                               %NULL
+ *     %NULL
  *
  * Queries the item at position @item_index in @model for the attribute
  * specified by @attribute.
@@ -791,7 +791,7 @@ struct _GMenuAttributeIterPrivate
 
 /**
  * g_menu_attribute_iter_get_next:
- * @iter: a #GMenuLinkIter
+ * @iter: a #GMenuAttributeIter
  * @name: (out) (allow-none) (transfer none): the name of the attribute
  * @value: (out) (allow-none) (transfer full): the attribute value
  *
@@ -842,7 +842,7 @@ g_menu_attribute_iter_get_next (GMenuAttributeIter  *iter,
 
 /**
  * g_menu_attribute_iter_next:
- * @iter: a #GMenuLinkIter
+ * @iter: a #GMenuAttributeIter
  *
  * Attempts to advance the iterator to the next (possibly first)
  * attribute.
@@ -850,8 +850,8 @@ g_menu_attribute_iter_get_next (GMenuAttributeIter  *iter,
  * %TRUE is returned on success, or %FALSE if there are no more
  * attributes.
  *
- * You must call this function when you first acquire the iterator to
- * advance it to the first attribute (and determine if the first
+ * You must call this function when you first acquire the iterator
+ * to advance it to the first attribute (and determine if the first
  * attribute exists at all).
  *
  * Returns: %TRUE on success, or %FALSE when there are no more attributes
@@ -864,15 +864,15 @@ g_menu_attribute_iter_next (GMenuAttributeIter *iter)
 
 /**
  * g_menu_attribute_iter_get_name:
- * @iter: a #GMenuLinkIter
+ * @iter: a #GMenuAttributeIter
  *
- * Gets the name of the attribute at the current iterator position, as a
- * string.
+ * Gets the name of the attribute at the current iterator position,
+ * as a string.
  *
  * The iterator is not advanced.
  *
- * The string is owned by the iterator and remains valid for as long as
- * the iterator is at the current position.
+ * The string is owned by the iterator and remains valid for as long
+ * as the iterator is at the current position.
  *
  * Returns: (transfer none): the name of the attribute
  **/
@@ -886,7 +886,7 @@ g_menu_attribute_iter_get_name (GMenuAttributeIter *iter)
 
 /**
  * g_menu_attribute_iter_get_value:
- * @iter: a #GMenuLinkIter
+ * @iter: a #GMenuAttributeIter
  *
  * Gets the value of the attribute at the current iterator position.
  *
@@ -1081,7 +1081,7 @@ g_menu_link_iter_class_init (GMenuLinkIterClass *class)
  * g_menu_model_item_iterate_attributes:
  * @item: a #GMenuModelItem
  *
- * Creates a #GMenuLinkIter to iterate over the links of @item.
+ * Creates a #GMenuAttributeIter to iterate over the links of @item.
  *
  * You must free the iterator with g_object_unref() when you are done.
  *
@@ -1188,8 +1188,8 @@ g_menu_model_item_iterate_links (GMenuModelItem *item)
  *
  * Queries @item for the link specified by @link.
  *
- * If the link exists, the linked #GMenuModel is returned.  If the link
- * does not exist, %NULL is returned.
+ * If the link exists, the linked #GMenuModel is returned.
+ * If the link does not exist, %NULL is returned.
  *
  * Returns: (transfer full): the linked #GMenuModel, or %NULL
  **/



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]