docs: Fix iter_is_valid() description
authorEmmanuele Bassi <ebassi@gnome.org>
Sat, 31 Jul 2021 12:41:13 +0000 (13:41 +0100)
committerEmmanuele Bassi <ebassi@gnome.org>
Sat, 31 Jul 2021 12:41:13 +0000 (13:41 +0100)
Drop the "WARNING" and the block quote, and follow the existing
documentation style guidelines.

gtk/gtkliststore.c
gtk/gtktreestore.c

index df38e404fac6ae6c7784b7276d7e59dafe72b260..b425a0c92ecf9475913702ced8ab502dba1a620e 100644 (file)
@@ -1433,14 +1433,14 @@ gtk_list_store_clear (GtkListStore *list_store)
 
 /**
  * gtk_list_store_iter_is_valid:
- * @list_store: A `GtkListStore`.
- * @iter: A `GtkTreeIter`
- *
- * > This function is slow. Only use it for debugging and/or testing
- * > purposes.
+ * @list_store: a list store
+ * @iter: the iterator to check
  *
  * 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.
  **/
 gboolean
index 0d0ac54c0a4fcab3f79d9f4334386b3c38064099..f41bfaadef5823e2d58a5867786738f349299273 100644 (file)
@@ -1908,14 +1908,14 @@ gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
 
 /**
  * gtk_tree_store_iter_is_valid:
- * @tree_store: A `GtkTreeStore`.
- * @iter: A `GtkTreeIter`.
- *
- * WARNING: This function is slow. Only use it for debugging and/or testing
- * purposes.
+ * @tree_store: a tree store 
+ * @iter: the iterator to check
  *
  * 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.
  **/
 gboolean