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

docs: Fix the GListModel description

Browse Source 
- Isolate the first meaningful paragraph, for gi-docgen's summary
- Describe get_object() as a binding API
- Fix reference to get_item() inside get_item_type()
This commit is contained in:
Emmanuele Bassi 2021-09-30 09:56:52 +01:00 committed by Philip Withnall
parent e4bb09d8ec
commit 192b3e6c2d
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
gio/glistmodel.c
View File

@ -135,7 +135,7 @@ g_list_model_default_init (GListModelInterface *iface)
* from @list. At @position, @removed items were removed and @added * from @list. At @position, @removed items were removed and @added
* items were added in their place. * items were added in their place.
* *
* Note: If @removed != @added, the positions of all later items * Note: If `removed != added`, the positions of all later items
* in the model change. * in the model change.
* *
* Since: 2.44 * Since: 2.44
@ -157,9 +157,11 @@ g_list_model_default_init (GListModelInterface *iface)
* g_list_model_get_item_type: * g_list_model_get_item_type:
* @list: a #GListModel * @list: a #GListModel
* *
* Gets the type of the items in @list. All items returned from * Gets the type of the items in @list.
* g_list_model_get_type() are of that type or a subtype, or are an *
* implementation of that interface. * All items returned from g_list_model_get_item() are of the type
* returned by this function, or a subtype, or if the type is an
* interface, they are an implementation of that interface.
* *
* The item type of a #GListModel can not change during the life of the * The item type of a #GListModel can not change during the life of the
* model. * model.
@ -203,11 +205,15 @@ g_list_model_get_n_items (GListModel *list)
* @list: a #GListModel * @list: a #GListModel
* @position: the position of the item to fetch * @position: the position of the item to fetch
* *
* Get the item at @position. If @position is greater than the number of * Get the item at @position.
* items in @list, %NULL is returned. *
* If @position is greater than the number of items in @list, %NULL is
* returned.
* *
* %NULL is never returned for an index that is smaller than the length * %NULL is never returned for an index that is smaller than the length
* of the list. See g_list_model_get_n_items(). * of the list.
*
* See also: g_list_model_get_n_items()
* *
* Returns: (transfer full) (nullable): the item at @position. * Returns: (transfer full) (nullable): the item at @position.
* *
@ -227,11 +233,18 @@ g_list_model_get_item (GListModel *list,
* @list: a #GListModel * @list: a #GListModel
* @position: the position of the item to fetch * @position: the position of the item to fetch
* *
* Get the item at @position. If @position is greater than the number of * Get the item at @position.
* items in @list, %NULL is returned. *
* If @position is greater than the number of items in @list, %NULL is
* returned.
* *
* %NULL is never returned for an index that is smaller than the length * %NULL is never returned for an index that is smaller than the length
* of the list. See g_list_model_get_n_items(). * of the list.
*
* This function is meant to be used by language bindings in place
* of g_list_model_get_item().
*
* See also: g_list_model_get_n_items()
* *
* Returns: (transfer full) (nullable): the object at @position. * Returns: (transfer full) (nullable): the object at @position.
* *