stringlist: Clarify docs for gtk_string_list_get_string()

Make sure it's obvious that it behaves like g_list_model_get_item() and
returns NULL for pos >= n_items.
This commit is contained in:
Benjamin Otte 2020-06-30 19:35:43 +02:00
parent a979daa8ea
commit 67cbb2a7d3

View File

@ -588,8 +588,8 @@ gtk_string_list_remove (GtkStringList *self,
* @self: a #GtkStringList
* @position: the position to get the string for
*
* Gets the string that is at @position in @self. @position
* must be smaller than the current length of the list.
* Gets the string that is at @position in @self. If @self
* does not contain @position items, %NULL is returned.
*
* This function returns the const char *. To get the
* object wrapping it, use g_list_model_get_item().