[libadwaita/wip/exalm/gi-docgen: 38/50] swipeable: Convert docs

[Adrien Plazas <aplazas src gnome org>]

commit bbf5f61a3f3c7cdc3ee72205c012dec50ffa667c
Author: Alexander Mikhaylenko <alexm gnome org>
Date:   Wed May 12 12:12:11 2021 +0500

    swipeable: Convert docs

 src/adw-swipeable.c | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)
---
diff --git a/src/adw-swipeable.c b/src/adw-swipeable.c
index 5db5e978..390bed0a 100644
--- a/src/adw-swipeable.c
+++ b/src/adw-swipeable.c
@@ -9,14 +9,13 @@
 #include "adw-swipeable.h"
 
 /**
- * SECTION:adwswipeable
- * @short_description: An interface for swipeable widgets.
- * @title: AdwSwipeable
- * @See_also: #AdwCarousel, #AdwLeaflet
+ * AdwSwipeable:
  *
- * The #AdwSwipeable interface is implemented by all swipeable widgets.
+ * An interface for swipeable widgets.
  *
- * See #AdwSwipeTracker for details about implementing it.
+ * The `AdwSwipeable` interface is implemented by all swipeable widgets.
+ *
+ * See [class@Adw.SwipeTracker] for details about implementing it.
  *
  * Since: 1.0
  */
@@ -30,10 +29,11 @@ adw_swipeable_default_init (AdwSwipeableInterface *iface)
 
 /**
  * adw_swipeable_get_distance:
- * @self: a #AdwSwipeable
+ * @self: a `AdwSwipeable`
+ *
+ * Gets the swipe distance of @self.
  *
- * Gets the swipe distance of @self. This corresponds to how many pixels
- * 1 unit represents.
+ * This corresponds to how many pixels 1 unit represents.
  *
  * Returns: the swipe distance in pixels
  *
@@ -54,14 +54,15 @@ adw_swipeable_get_distance (AdwSwipeable *self)
 
 /**
  * adw_swipeable_get_snap_points: (virtual get_snap_points)
- * @self: a #AdwSwipeable
+ * @self: a `AdwSwipeable`
  * @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.
+ * Gets 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().
+ * Each snap point represents a progress value that is considered acceptable to
+ * end the swipe on.
+ *
+ * Returns: (array length=n_snap_points) (transfer full): the snap points
  *
  * Since: 1.0
  */
@@ -81,9 +82,9 @@ adw_swipeable_get_snap_points (AdwSwipeable *self,
 
 /**
  * adw_swipeable_get_progress:
- * @self: a #AdwSwipeable
+ * @self: a `AdwSwipeable`
  *
- * Gets the current progress of @self
+ * Gets the current progress of @self.
  *
  * Returns: the current progress, unitless
  *
@@ -104,7 +105,7 @@ adw_swipeable_get_progress (AdwSwipeable *self)
 
 /**
  * adw_swipeable_get_cancel_progress:
- * @self: a #AdwSwipeable
+ * @self: a `AdwSwipeable`
  *
  * Gets the progress @self will snap back to after the gesture is canceled.
  *
@@ -127,13 +128,14 @@ adw_swipeable_get_cancel_progress (AdwSwipeable *self)
 
 /**
  * adw_swipeable_get_swipe_area:
- * @self: a #AdwSwipeable
+ * @self: a `AdwSwipeable`
  * @navigation_direction: the direction of the swipe
  * @is_drag: whether the swipe is caused by a dragging gesture
- * @rect: (out): a pointer to a #GdkRectangle to store the swipe area
+ * @rect: (out): a pointer to a rectangle to store the swipe area
  *
  * Gets the area @self can start a swipe from for the given direction and
  * gesture type.
+ *
  * This can be used to restrict swipes to only be possible from a certain area,
  * for example, to only allow edge swipes, or to have a draggable element and
  * ignore swipes elsewhere.