Write docs for iced and iced_native

src/native.rs

@@ -4,7 +4,36 @@ pub use iced_winit::{
 };
 
 pub mod widget {
+    //! Display information and interactive controls in your application.
+    //!
+    //! # Re-exports
+    //! For convenience, the contents of this module are available at the root
+    //! module. Therefore, you can directly type:
+    //!
+    //! ```
+    //! use iced::{button, Button};
+    //! ```
+    //!
+    //! # Stateful widgets
+    //! Some widgets need to keep track of __local state__.
+    //!
+    //! These widgets have their own module with a `State` type. For instance, a
+    //! [`TextInput`] has some [`text_input::State`].
+    //!
+    //! [`TextInput`]: text_input/struct.TextInput.html
+    //! [`text_input::State`]: text_input/struct.State.html
     pub mod button {
+        //! Allow your users to perform actions by pressing a button.
+        //!
+        //! A [`Button`] has some local [`State`].
+        //!
+        //! [`Button`]: type.Button.html
+        //! [`State`]: struct.State.html
+
+        /// A widget that produces a message when clicked.
+        ///
+        /// This is an alias of an `iced_native` button with a default
+        /// `Renderer`.
         pub type Button<'a, Message> =
             iced_winit::Button<'a, Message, iced_wgpu::Renderer>;
 
@@ -12,6 +41,13 @@ pub mod widget {
     }
 
     pub mod scrollable {
+        //! Navigate an endless amount of content with a scrollbar.
+
+        /// A widget that can vertically display an infinite amount of content
+        /// with a scrollbar.
+        ///
+        /// This is an alias of an `iced_native` scrollable with a default
+        /// `Renderer`.
         pub type Scrollable<'a, Message> =
             iced_winit::Scrollable<'a, Message, iced_wgpu::Renderer>;
 
@@ -19,10 +55,23 @@ pub mod widget {
     }
 
     pub mod text_input {
+        //! Ask for information using text fields.
+        //!
+        //! A [`TextInput`] has some local [`State`].
+        //!
+        //! [`TextInput`]: struct.TextInput.html
+        //! [`State`]: struct.State.html
         pub use iced_winit::text_input::{State, TextInput};
     }
 
     pub mod slider {
+        //! Display an interactive selector of a single value from a range of
+        //! values.
+        //!
+        //! A [`Slider`] has some local [`State`].
+        //!
+        //! [`Slider`]: struct.Slider.html
+        //! [`State`]: struct.State.html
         pub use iced_winit::slider::{Slider, State};
     }
 
@@ -34,12 +83,22 @@ pub mod widget {
         text_input::TextInput,
     };
 
+    /// A container that distributes its contents vertically.
+    ///
+    /// This is an alias of an `iced_native` column with a default `Renderer`.
     pub type Column<'a, Message> =
         iced_winit::Column<'a, Message, iced_wgpu::Renderer>;
 
+    /// A container that distributes its contents horizontally.
+    ///
+    /// This is an alias of an `iced_native` row with a default `Renderer`.
     pub type Row<'a, Message> =
         iced_winit::Row<'a, Message, iced_wgpu::Renderer>;
 
+    /// An element decorating some content.
+    ///
+    /// This is an alias of an `iced_native` container with a default
+    /// `Renderer`.
     pub type Container<'a, Message> =
         iced_winit::Container<'a, Message, iced_wgpu::Renderer>;
 }
@@ -47,5 +106,8 @@ pub mod widget {
 #[doc(no_inline)]
 pub use widget::*;
 
+/// A generic widget.
+///
+/// This is an alias of an `iced_native` element with a default `Renderer`.
 pub type Element<'a, Message> =
     iced_winit::Element<'a, Message, iced_wgpu::Renderer>;