[libhandy] swipeable: Fix get_snap_points() docs
- From: Adrien Plazas <aplazas src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libhandy] swipeable: Fix get_snap_points() docs
- Date: Sat, 20 Jun 2020 07:06:28 +0000 (UTC)
commit d6ac50b78c095ec6ca4e1704cae5615c0417c095
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 8b5eb361..da05e751 100644
--- a/src/hdy-swipeable.c
+++ b/src/hdy-swipeable.c
@@ -341,9 +341,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.
@@ -351,7 +351,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]