[libadwaita/wip/exalm/gi-docgen: 3/45] animation: Convert docs
- From: Alexander Mikhaylenko <alexm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libadwaita/wip/exalm/gi-docgen: 3/45] animation: Convert docs
- Date: Thu, 13 May 2021 08:47:19 +0000 (UTC)
commit 7100e3b8f39573d049a0a720b5194889672c7a6f
Author: Alexander Mikhaylenko <alexm gnome org>
Date: Fri May 7 22:24:20 2021 +0500
animation: Convert docs
Remove (skip) from adw_lerp(), it's already private.
src/adw-animation.c | 26 +++++++++-----------------
1 file changed, 9 insertions(+), 17 deletions(-)
---
diff --git a/src/adw-animation.c b/src/adw-animation.c
index 0ec6bad8..3d9d272f 100644
--- a/src/adw-animation.c
+++ b/src/adw-animation.c
@@ -8,16 +8,6 @@
#include "adw-animation-private.h"
-/**
- * SECTION:adwanimation
- * @short_description: Animation helpers
- * @title: Animation Helpers
- *
- * Animation helpers.
- *
- * Since: 1.0
- */
-
G_DEFINE_BOXED_TYPE (AdwAnimation, adw_animation, adw_animation_ref, adw_animation_unref)
struct _AdwAnimation
@@ -215,12 +205,14 @@ adw_animation_get_widget (AdwAnimation *self)
/**
* adw_get_enable_animations:
- * @widget: a #GtkWidget
+ * @widget: a `GtkWidget`
+ *
+ * Checks whether animations are enabled for @widget.
*
- * Returns whether animations are enabled for that widget. This should be used
- * when implementing an animated widget to know whether to animate it or not.
+ * This should be used when implementing an animated widget to know whether to
+ * animate it or not.
*
- * Returns: %TRUE if animations are enabled for @widget.
+ * Returns: %TRUE if animations are enabled for @widget
*
* Since: 1.0
*/
@@ -239,14 +231,14 @@ adw_get_enable_animations (GtkWidget *widget)
}
/**
- * adw_lerp: (skip)
+ * adw_lerp:
* @a: the start
* @b: the end
* @t: the interpolation rate
*
* Computes the linear interpolation between @a and @b for @t.
*
- * Returns: the linear interpolation between @a and @b for @t.
+ * Returns: the linear interpolation between @a and @b for @t
*
* Since: 1.0
*/
@@ -266,7 +258,7 @@ adw_lerp (double a, double b, double t)
*
* Computes the ease out for @t.
*
- * Returns: the ease out for @t.
+ * Returns: the ease out for @t
*
* Since: 1.0
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]