[libhandy/swipe-tracker-public: 13/16] swipeable: Fix get_snap_points() docs



commit 52d7a920922f42c77a279cc40b1738a5d589daa3
Author: Alexander Mikhaylenko <alexm gnome org>
Date:   Mon Jun 15 01:36:05 2020 +0500

    swipeable: Fix get_snap_points() docs
    
    Add an annotation so that it's registered as a caller for the vfunc,
    add a description for n_snap_points, mention that the returned array
    must be freed.
    
    Signed-off-by: Alexander Mikhaylenko <alexm gnome org>

 src/hdy-swipeable.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
---
diff --git a/src/hdy-swipeable.c b/src/hdy-swipeable.c
index af3e9b73..3c470bd9 100644
--- a/src/hdy-swipeable.c
+++ b/src/hdy-swipeable.c
@@ -353,9 +353,9 @@ get_snap_points_from_range (HdySwipeable *self,
 }
 
 /**
- * hdy_swipeable_get_snap_points:
+ * hdy_swipeable_get_snap_points: (virtual get_snap_points)
  * @self: a #HdySwipeable
- * @n_snap_points: (out)
+ * @n_snap_points: (out): location to return the number of the snap points
  *
  * Gets the snap points of @self. Each snap point represents a progress value
  * that is considered acceptable to end the swipe on.
@@ -363,7 +363,8 @@ get_snap_points_from_range (HdySwipeable *self,
  * If not implemented, the default implementation returns one snap point for
  * each end of the range, or just one snap point if they are equal.
  *
- * Returns: (array length=n_snap_points) (transfer full): the snap points of @self
+ * Returns: (array length=n_snap_points) (transfer full): the snap points of
+ *     @self. The array must be freed with g_free().
  *
  * Since: 1.0
  */


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