AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Fix iter_is_valid() description

Browse Source 
Drop the "WARNING" and the block quote, and follow the existing
documentation style guidelines.
This commit is contained in:
Emmanuele Bassi 2021-07-31 13:41:13 +01:00
parent cc6ecc8b62
commit 95c032f531
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
gtk/gtkliststore.c
View File

@ -1433,14 +1433,14 @@ gtk_list_store_clear (GtkListStore *list_store)
/** /**
* gtk_list_store_iter_is_valid: * gtk_list_store_iter_is_valid:
* @list_store: A `GtkListStore`. * @list_store: a list store
* @iter: A `GtkTreeIter` * @iter: the iterator to check
*
* > This function is slow. Only use it for debugging and/or testing
* > purposes.
* *
* Checks if the given iter is a valid iter for this `GtkListStore`. * Checks if the given iter is a valid iter for this `GtkListStore`.
* *
* This function is slow. Only use it for debugging and/or testing
* purposes.
*
* Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid.
**/ **/
gboolean gboolean

10
gtk/gtktreestore.c
View File

@ -1908,14 +1908,14 @@ gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
/** /**
* gtk_tree_store_iter_is_valid: * gtk_tree_store_iter_is_valid:
* @tree_store: A `GtkTreeStore`. * @tree_store: a tree store
* @iter: A `GtkTreeIter`. * @iter: the iterator to check
*
* WARNING: This function is slow. Only use it for debugging and/or testing
* purposes.
* *
* Checks if the given iter is a valid iter for this `GtkTreeStore`. * Checks if the given iter is a valid iter for this `GtkTreeStore`.
* *
* This function is slow. Only use it for debugging and/or testing
* purposes.
*
* Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid.
**/ **/
gboolean gboolean