[gtk/prop-list: 20/96] numericsorter: Small documentation improvements



commit e2f78e95b255fd37b6873fce819b00acca4f5baf
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Dec 18 22:36:22 2019 -0500

    numericsorter: Small documentation improvements

 gtk/gtknumericsorter.c | 7 ++++---
 gtk/gtknumericsorter.h | 2 +-
 2 files changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/gtk/gtknumericsorter.c b/gtk/gtknumericsorter.c
index d8575458fe..253fd201d7 100644
--- a/gtk/gtknumericsorter.c
+++ b/gtk/gtknumericsorter.c
@@ -276,7 +276,7 @@ gtk_numeric_sorter_class_init (GtkNumericSorterClass *class)
   /**
    * GtkNumericSorter:expression:
    *
-   * The expression to evalute on item to get a numeric to compare with
+   * The expression to evalute on items to get a number to compare with
    */
   properties[PROP_EXPRESSION] =
       g_param_spec_boxed ("expression",
@@ -310,7 +310,7 @@ gtk_numeric_sorter_init (GtkNumericSorter *self)
 
 /**
  * gtk_numeric_sorter_new:
- * @expression: (transfer full) (nullable): The expression to evaulate
+ * @expression: (transfer full) (nullable): The expression to evaluate
  *
  * Creates a new numeric sorter using the given @expression.
  *
@@ -359,7 +359,8 @@ gtk_numeric_sorter_get_expression (GtkNumericSorter *self)
  * Unless an expression is set on @self, the sorter will always
  * compare items as invalid.
  *
- * The expression must have a return type that can be compared numerically.
+ * The expression must have a return type that can be compared
+ * numerically, such as #G_TYPE_INT or #G_TYPE_DOUBLE.
  */
 void
 gtk_numeric_sorter_set_expression (GtkNumericSorter *self,
diff --git a/gtk/gtknumericsorter.h b/gtk/gtknumericsorter.h
index 6d49614ee4..39bb48e212 100644
--- a/gtk/gtknumericsorter.h
+++ b/gtk/gtknumericsorter.h
@@ -46,7 +46,7 @@ GDK_AVAILABLE_IN_ALL
 GtkSortType             gtk_numeric_sorter_get_sort_order        (GtkNumericSorter       *self);
 GDK_AVAILABLE_IN_ALL
 void                    gtk_numeric_sorter_set_sort_order        (GtkNumericSorter       *self,
-                                                                  GtkSortType             order);
+                                                                  GtkSortType             sort_order);
 
 G_END_DECLS
 


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