[gtk/iter-is-valid-docs] docs: Fix iter_is_valid() description




commit 95c032f531a99e72b99d7d5a42207375b37241fa
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sat Jul 31 13:41:13 2021 +0100

    docs: Fix iter_is_valid() description
    
    Drop the "WARNING" and the block quote, and follow the existing
    documentation style guidelines.

 gtk/gtkliststore.c | 10 +++++-----
 gtk/gtktreestore.c | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)
---
diff --git a/gtk/gtkliststore.c b/gtk/gtkliststore.c
index df38e404fa..b425a0c92e 100644
--- a/gtk/gtkliststore.c
+++ b/gtk/gtkliststore.c
@@ -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
diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c
index 0d0ac54c0a..f41bfaadef 100644
--- a/gtk/gtktreestore.c
+++ b/gtk/gtktreestore.c
@@ -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


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