[libadwaita] docs: Standarize how units are declared
- From: Alexander Mikhaylenko <alexm src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libadwaita] docs: Standarize how units are declared
- Date: Thu, 3 Feb 2022 13:12:55 +0000 (UTC)
commit 4aeb37503359b0c1ffab6c697b66eba721282189
Author: Maximiliano Sandoval R <msandova gnome org>
Date: Thu Feb 3 14:07:27 2022 +0100
docs: Standarize how units are declared
Always on `Returns` or `@arg` annotations, or at the end of properties.
src/adw-carousel.c | 2 +-
src/adw-spring-animation.c | 2 +-
src/adw-timed-animation.c | 10 +++++-----
3 files changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/src/adw-carousel.c b/src/adw-carousel.c
index e69cd17a..6b115f03 100644
--- a/src/adw-carousel.c
+++ b/src/adw-carousel.c
@@ -1014,7 +1014,7 @@ adw_carousel_class_init (AdwCarouselClass *klass)
/**
* AdwCarousel:reveal-duration:
*
- * Page reveal duration in milliseconds.
+ * Page reveal duration, in milliseconds.
*
* Since: 1.0
*/
diff --git a/src/adw-spring-animation.c b/src/adw-spring-animation.c
index 7f282de0..fead6895 100644
--- a/src/adw-spring-animation.c
+++ b/src/adw-spring-animation.c
@@ -510,7 +510,7 @@ adw_spring_animation_class_init (AdwSpringAnimationClass *klass)
/**
* AdwSpringAnimation:estimated-duration: (attributes
org.gtk.Property.get=adw_spring_animation_get_estimated_duration)
*
- * Estimated duration of the animation in milliseconds.
+ * Estimated duration of the animation, in milliseconds.
*
* Can be [const@DURATION_INFINITE] if the spring damping is set to 0.
*
diff --git a/src/adw-timed-animation.c b/src/adw-timed-animation.c
index f476be98..3998b835 100644
--- a/src/adw-timed-animation.c
+++ b/src/adw-timed-animation.c
@@ -257,7 +257,7 @@ adw_timed_animation_class_init (AdwTimedAnimationClass *klass)
/**
* AdwTimedAnimation:duration: (attributes org.gtk.Property.get=adw_timed_animation_get_duration
org.gtk.Property.set=adw_timed_animation_set_duration)
*
- * Duration of the animation in milliseconds.
+ * Duration of the animation, in milliseconds.
*
* Describes how much time the animation will take.
*
@@ -474,9 +474,9 @@ adw_timed_animation_set_value_to (AdwTimedAnimation *self,
* adw_timed_animation_get_duration: (attributes org.gtk.Method.get_property=duration)
* @self: a timed animation
*
- * Gets the duration of @self in milliseconds.
+ * Gets the duration of @self.
*
- * Returns: the duration of @self
+ * Returns: the duration of @self, in milliseconds
*
* Since: 1.0
*/
@@ -491,9 +491,9 @@ adw_timed_animation_get_duration (AdwTimedAnimation *self)
/**
* adw_timed_animation_set_duration: (attributes org.gtk.Method.set_property=duration)
* @self: a timed animation
- * @duration: the duration to use
+ * @duration: the duration to use, in milliseconds
*
- * Sets the duration of @self in milliseconds.
+ * Sets the duration of @self.
*
* If the animation repeats more than once, sets the duration of one iteration.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]