From 66f7d43dc98df96c8b19cfd2aef6dcdd4187316c Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Fri, 5 Aug 2022 05:15:41 +0200
Subject: Write missing documentation in `iced_native`

---
 native/src/widget/scrollable.rs | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'native/src/widget/scrollable.rs')

diff --git a/native/src/widget/scrollable.rs b/native/src/widget/scrollable.rs
index b7a0b6ee..4ebb07a0 100644
--- a/native/src/widget/scrollable.rs
+++ b/native/src/widget/scrollable.rs
@@ -316,19 +316,26 @@ where
     }
 }
 
+/// The identifier of a [`Scrollable`].
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 pub struct Id(widget::Id);
 
 impl Id {
+    /// Creates a custom [`Id`].
     pub fn new(id: impl Into<std::borrow::Cow<'static, str>>) -> Self {
         Self(widget::Id::new(id))
     }
 
+    /// Creates a unique [`Id`].
+    ///
+    /// This function produces a different [`Id`] every time it is called.
     pub fn unique() -> Self {
         Self(widget::Id::unique())
     }
 }
 
+/// Produces a [`Command`] that snaps the [`Scrollable`] with the given [`Id`]
+/// to the provided `percentage`.
 pub fn snap_to<Message: 'static>(id: Id, percentage: f32) -> Command<Message> {
     Command::widget(operation::scrollable::snap_to(id.0, percentage))
 }
-- 
cgit