Write docs for iced and iced_native

native/src/widget/checkbox.rs

@@ -166,15 +166,18 @@ where
 /// [`Checkbox`]: struct.Checkbox.html
 /// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer {
+    /// Returns the default size of a [`Checkbox`].
+    ///
+    /// [`Checkbox`]: struct.Checkbox.html
     fn default_size(&self) -> u32;
 
     /// Draws a [`Checkbox`].
     ///
     /// It receives:
-    ///   * the current cursor position
     ///   * the bounds of the [`Checkbox`]
-    ///   * the bounds of the label of the [`Checkbox`]
-    ///   * whether the [`Checkbox`] is checked or not
+    ///   * whether the [`Checkbox`] is selected or not
+    ///   * whether the mouse is over the [`Checkbox`] or not
+    ///   * the drawn label of the [`Checkbox`]
     ///
     /// [`Checkbox`]: struct.Checkbox.html
     fn draw(

native/src/widget/column.rs

@@ -1,3 +1,4 @@
+//! Distribute content vertically.
 use std::hash::Hash;
 
 use crate::{
@@ -189,7 +190,23 @@ where
     }
 }
 
+/// The renderer of a [`Column`].
+///
+/// Your [renderer] will need to implement this trait before being
+/// able to use a [`Column`] in your user interface.
+///
+/// [`Column`]: struct.Column.html
+/// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer + Sized {
+    /// Draws a [`Column`].
+    ///
+    /// It receives:
+    /// - the children of the [`Column`]
+    /// - the [`Layout`] of the [`Column`] and its children
+    /// - the cursor position
+    ///
+    /// [`Column`]: struct.Row.html
+    /// [`Layout`]: ../layout/struct.Layout.html
     fn draw<Message>(
         &mut self,
         content: &[Element<'_, Message, Self>],

native/src/widget/container.rs

@@ -1,3 +1,4 @@
+//! Decorate content and apply alignment.
 use std::hash::Hash;
 
 use crate::{

native/src/widget/image.rs

@@ -116,6 +116,9 @@ where
 /// [`Image`]: struct.Image.html
 /// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer {
+    /// Returns the dimensions of an [`Image`] located on the given path.
+    ///
+    /// [`Image`]: struct.Image.html
     fn dimensions(&self, path: &str) -> (u32, u32);
 
     /// Draws an [`Image`].

native/src/widget/radio.rs

@@ -174,15 +174,18 @@ where
 /// [`Radio`]: struct.Radio.html
 /// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer {
+    /// Returns the default size of a [`Radio`] button.
+    ///
+    /// [`Radio`]: struct.Radio.html
     fn default_size(&self) -> u32;
 
     /// Draws a [`Radio`] button.
     ///
     /// It receives:
-    ///   * the current cursor position
     ///   * the bounds of the [`Radio`]
-    ///   * the bounds of the label of the [`Radio`]
     ///   * whether the [`Radio`] is selected or not
+    ///   * whether the mouse is over the [`Radio`] or not
+    ///   * the drawn label of the [`Radio`]
     ///
     /// [`Radio`]: struct.Radio.html
     fn draw(

native/src/widget/row.rs

@@ -1,3 +1,4 @@
+//! Distribute content horizontally.
 use std::hash::Hash;
 
 use crate::{
@@ -192,7 +193,23 @@ where
     }
 }
 
+/// The renderer of a [`Row`].
+///
+/// Your [renderer] will need to implement this trait before being
+/// able to use a [`Row`] in your user interface.
+///
+/// [`Row`]: struct.Row.html
+/// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer + Sized {
+    /// Draws a [`Row`].
+    ///
+    /// It receives:
+    /// - the children of the [`Row`]
+    /// - the [`Layout`] of the [`Row`] and its children
+    /// - the cursor position
+    ///
+    /// [`Row`]: struct.Row.html
+    /// [`Layout`]: ../layout/struct.Layout.html
     fn draw<Message>(
         &mut self,
         children: &[Element<'_, Message, Self>],

native/src/widget/scrollable.rs

@@ -1,3 +1,4 @@
+//! Navigate an endless amount of content with a scrollbar.
 use crate::{
     column,
     input::{mouse, ButtonState},
@@ -361,7 +362,18 @@ impl State {
     }
 }
 
+/// The renderer of a [`Scrollable`].
+///
+/// Your [renderer] will need to implement this trait before being
+/// able to use a [`Scrollable`] in your user interface.
+///
+/// [`Scrollable`]: struct.Scrollable.html
+/// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer + Sized {
+    /// Returns whether the mouse is over the scrollbar given the bounds of
+    /// the [`Scrollable`] and its contents.
+    ///
+    /// [`Scrollable`]: struct.Scrollable.html
     fn is_mouse_over_scrollbar(
         &self,
         bounds: Rectangle,
@@ -369,6 +381,18 @@ pub trait Renderer: crate::Renderer + Sized {
         cursor_position: Point,
     ) -> bool;
 
+    /// Draws the [`Scrollable`].
+    ///
+    /// It receives:
+    /// - the [`State`] of the [`Scrollable`]
+    /// - the bounds of the [`Scrollable`]
+    /// - whether the mouse is over the [`Scrollable`] or not
+    /// - whether the mouse is over the scrollbar or not
+    /// - the scrolling offset
+    /// - the drawn content
+    ///
+    /// [`Scrollable`]: struct.Scrollable.html
+    /// [`State`]: struct.State.html
     fn draw(
         &mut self,
         scrollable: &State,

native/src/widget/slider.rs

@@ -13,6 +13,28 @@ use crate::{
 
 use std::{hash::Hash, ops::RangeInclusive};
 
+/// An horizontal bar and a handle that selects a single value from a range of
+/// values.
+///
+/// A [`Slider`] will try to fill the horizontal space of its container.
+///
+/// [`Slider`]: struct.Slider.html
+///
+/// # Example
+/// ```
+/// # use iced_native::{slider, Slider};
+/// #
+/// pub enum Message {
+///     SliderChanged(f32),
+/// }
+///
+/// let state = &mut slider::State::new();
+/// let value = 50.0;
+///
+/// Slider::new(state, 0.0..=100.0, value, Message::SliderChanged);
+/// ```
+///
+/// ![Slider drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/slider.png?raw=true)
 pub struct Slider<'a, Message> {
     state: &'a mut State,
     range: RangeInclusive<f32>,
@@ -180,6 +202,9 @@ where
 /// [`Slider`]: struct.Slider.html
 /// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer {
+    /// Returns the height of the [`Slider`].
+    ///
+    /// [`Slider`]: struct.Slider.html
     fn height(&self) -> u32;
 
     /// Draws a [`Slider`].

native/src/widget/text.rs

@@ -32,9 +32,9 @@ impl Text {
     /// Create a new fragment of [`Text`] with the given contents.
     ///
     /// [`Text`]: struct.Text.html
-    pub fn new(label: &str) -> Self {
+    pub fn new<T: Into<String>>(label: T) -> Self {
         Text {
-            content: String::from(label),
+            content: label.into(),
             size: None,
             color: None,
             font: Font::Default,
@@ -174,8 +174,15 @@ where
 /// [renderer]: ../../renderer/index.html
 /// [`UserInterface`]: ../../struct.UserInterface.html
 pub trait Renderer: crate::Renderer {
+    /// Returns the default size of the [`Text`].
+    ///
+    /// [`Text`]: struct.Text.html
     fn default_size(&self) -> u16;
 
+    /// Measures the [`Text`] in the given bounds and returns the minimum
+    /// boundaries that can fit the contents.
+    ///
+    /// [`Text`]: struct.Text.html
     fn measure(
         &self,
         content: &str,

native/src/widget/text_input.rs

@@ -10,7 +10,26 @@ use crate::{
     Widget,
 };
 
-/// A widget that can be filled with text by using a keyboard.
+/// A field that can be filled with text.
+///
+/// # Example
+/// ```
+/// # use iced_native::{text_input, TextInput};
+/// #
+/// enum Message {
+///     TextInputChanged(String),
+/// }
+///
+/// let mut state = text_input::State::new();
+/// let value = "Some text";
+///
+/// let input = TextInput::new(
+///     &mut state,
+///     "This is the placeholder...",
+///     value,
+///     Message::TextInputChanged,
+/// );
+/// ```
 pub struct TextInput<'a, Message> {
     state: &'a mut State,
     placeholder: String,
@@ -26,7 +45,14 @@ pub struct TextInput<'a, Message> {
 impl<'a, Message> TextInput<'a, Message> {
     /// Creates a new [`TextInput`].
     ///
+    /// It expects:
+    /// - some [`State`]
+    /// - a placeholder
+    /// - the current value
+    /// - a function that produces a message when the [`TextInput`] changes
+    ///
     /// [`TextInput`]: struct.TextInput.html
+    /// [`State`]: struct.State.html
     pub fn new<F>(
         state: &'a mut State,
         placeholder: &str,
@@ -232,9 +258,32 @@ where
     }
 }
 
+/// The renderer of a [`TextInput`].
+///
+/// Your [renderer] will need to implement this trait before being
+/// able to use a [`TextInput`] in your user interface.
+///
+/// [`TextInput`]: struct.TextInput.html
+/// [renderer]: ../../renderer/index.html
 pub trait Renderer: crate::Renderer + Sized {
+    /// Returns the default size of the text of the [`TextInput`].
+    ///
+    /// [`TextInput`]: struct.TextInput.html
     fn default_size(&self) -> u16;
 
+    /// Draws a [`TextInput`].
+    ///
+    /// It receives:
+    /// - its bounds of the [`TextInput`]
+    /// - the bounds of the text (i.e. the current value)
+    /// - the cursor position
+    /// - the placeholder to show when the value is empty
+    /// - the current [`Value`]
+    /// - the current [`State`]
+    ///
+    /// [`TextInput`]: struct.TextInput.html
+    /// [`Value`]: struct.Value.html
+    /// [`State`]: struct.State.html
     fn draw(
         &mut self,
         bounds: Rectangle,
@@ -289,6 +338,9 @@ impl State {
         }
     }
 
+    /// Returns whether the [`TextInput`] is currently focused or not.
+    ///
+    /// [`TextInput`]: struct.TextInput.html
     pub fn is_focused(&self) -> bool {
         self.is_focused
     }
@@ -303,7 +355,7 @@ impl State {
     /// Moves the cursor of a [`TextInput`] to the right.
     ///
     /// [`TextInput`]: struct.TextInput.html
-    pub fn move_cursor_right(&mut self, value: &Value) {
+    pub(crate) fn move_cursor_right(&mut self, value: &Value) {
         let current = self.cursor_position(value);
 
         if current < value.len() {
@@ -314,7 +366,7 @@ impl State {
     /// Moves the cursor of a [`TextInput`] to the left.
     ///
     /// [`TextInput`]: struct.TextInput.html
-    pub fn move_cursor_left(&mut self, value: &Value) {
+    pub(crate) fn move_cursor_left(&mut self, value: &Value) {
         let current = self.cursor_position(value);
 
         if current > 0 {
@@ -325,7 +377,7 @@ impl State {
     /// Moves the cursor of a [`TextInput`] to the end.
     ///
     /// [`TextInput`]: struct.TextInput.html
-    pub fn move_cursor_to_end(&mut self, value: &Value) {
+    pub(crate) fn move_cursor_to_end(&mut self, value: &Value) {
         self.cursor_position = value.len();
     }
 }