Merge pull request #1327 from iced-rs/update-docs

Update documentation

Author: hecrj

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Thank you for considering contributing to Iced! Feel free to read [the ecosystem overview] and [the roadmap] to get an idea of the current state of the library.
 
-The main advice for new contributors is to share your ideas with the community. Introduce yourself over our [Discord server] or [start a discussion in an issue](https://github.com/hecrj/iced/issues) explaining what you have in mind (do not be afraid of duplicated issues!). If you want to talk directly to me (@hecrj), you can also find me on Discord (`lone_scientist#9554`).
+The main advice for new contributors is to share your ideas with the community. Introduce yourself over our [Discord server] or [start a discussion in an issue](https://github.com/iced-rs/iced/issues) explaining what you have in mind (do not be afraid of duplicated issues!). If you want to talk directly to me (@hecrj), you can also find me on Discord (`lone_scientist#9554`).
 
 This is a very important step. It helps to coordinate work, get on the same page, and start building trust. Please, do not skip it! Remember that [Code is the Easy Part] and also [The Hard Parts of Open Source]!
 

Cargo.toml

@@ -116,4 +116,4 @@ iced_wgpu = { version = "0.4", path = "wgpu", features = ["webgl"], optional = t
 
 [package.metadata.docs.rs]
 rustdoc-args = ["--cfg", "docsrs"]
-features = ["image", "svg", "canvas", "qr_code"]
+features = ["image", "svg", "canvas", "qr_code", "pure"]

README.md

@@ -2,13 +2,13 @@
 
 <img src="docs/logo.svg" width="140px" />
 
-# iced
+# Iced
 
 [![Documentation](https://docs.rs/iced/badge.svg)][documentation]
 [![Crates.io](https://img.shields.io/crates/v/iced.svg)](https://crates.io/crates/iced)
-[![License](https://img.shields.io/crates/l/iced.svg)](https://github.com/hecrj/iced/blob/master/LICENSE)
+[![License](https://img.shields.io/crates/l/iced.svg)](https://github.com/iced-rs/iced/blob/master/LICENSE)
 [![Downloads](https://img.shields.io/crates/d/iced.svg)](https://crates.io/crates/iced)
-[![Test Status](https://github.com/hecrj/iced/workflows/Test/badge.svg?event=push)](https://github.com/hecrj/iced/actions)
+[![Test Status](https://github.com/iced-rs/iced/workflows/Test/badge.svg?event=push)](https://github.com/iced-rs/iced/actions)
 [![Discord Server](https://img.shields.io/discord/628993209984614400?label=&labelColor=6A7EC2&logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/3xZJ65GAhd)
 
 A cross-platform GUI library for Rust focused on simplicity and type-safety.
@@ -40,11 +40,11 @@ Inspired by [Elm].
     * A [windowing shell]
     * A [web runtime] leveraging the DOM
 
-__iced is currently experimental software.__ [Take a look at the roadmap],
+__Iced is currently experimental software.__ [Take a look at the roadmap],
 [check out the issues], and [feel free to contribute!]
 
 [Cross-platform support]: https://raw.githubusercontent.com/iced-rs/iced/master/docs/images/todos_desktop.jpg
-[the Web]: https://iced.rs/
+[the Web]: https://github.com/iced-rs/iced_web
 [text inputs]: https://gfycat.com/alertcalmcrow-rust-gui
 [scrollables]: https://gfycat.com/perkybaggybaboon-rust-gui
 [Debug overlay with performance metrics]: https://gfycat.com/incredibledarlingbee
@@ -69,13 +69,13 @@ Add `iced` as a dependency in your `Cargo.toml`:
 iced = "0.3"
 ```
 
-__iced moves fast and the `master` branch can contain breaking changes!__ If
+__Iced moves fast and the `master` branch can contain breaking changes!__ If
 you want to learn about a specific release, check out [the release list].
 
 [the release list]: https://github.com/iced-rs/iced/releases
 
 ## Overview
-Inspired by [The Elm Architecture], iced expects you to split user interfaces
+Inspired by [The Elm Architecture], Iced expects you to split user interfaces
 into four different concepts:
 
   * __State__ — the state of your application
@@ -165,7 +165,7 @@ impl Counter {
 }
 ```
 
-And that's everything! We just wrote a whole user interface. iced is now able
+And that's everything! We just wrote a whole user interface. Iced is now able
 to:
 
   1. Take the result of our __view logic__ and layout its widgets.
@@ -176,7 +176,7 @@ to:
 Browse the [documentation] and the [examples] to learn more!
 
 ## Implementation details
-iced was originally born as an attempt at bringing the simplicity of [Elm] and
+Iced was originally born as an attempt at bringing the simplicity of [Elm] and
 [The Elm Architecture] into [Coffee], a 2D game engine I am working on.
 
 The core of the library was implemented during May 2019 in [this pull request].
@@ -189,7 +189,7 @@ end-user-oriented GUI library, while keeping [the ecosystem] modular:
 
 <p align="center">
   <a href="ECOSYSTEM.md">
-    <img alt="iced ecosystem" src="docs/graphs/ecosystem.png" width="80%">
+    <img alt="The Iced Ecosystem" src="docs/graphs/ecosystem.png" width="80%">
   </a>
 </p>
 
@@ -222,7 +222,7 @@ iced = { version = "0.3", default-features = false, features = ["glow"] }
 but if you don't, right now there's no software fallback, so it means your hardware
 doesn't support Iced.
 
-[built-in renderer]: https://github.com/hecrj/iced/blob/master/ECOSYSTEM.md#Renderers
+[built-in renderer]: https://github.com/iced-rs/iced/blob/master/ECOSYSTEM.md#Renderers
 
 ## Contributing / Feedback
 Contributions are greatly appreciated! If you want to contribute, please
@@ -234,15 +234,15 @@ awesome folks) over the `#games-and-graphics` and `#gui-and-ui` channels in
 the [Rust Community Discord]. I go by `lone_scientist#9554` there.
 
 ## Sponsors
-The development of iced is sponsored by the [Cryptowatch] team at [Kraken.com]
+The development of Iced is sponsored by the [Cryptowatch] team at [Kraken.com]
 
 [documentation]: https://docs.rs/iced/
-[examples]: https://github.com/hecrj/iced/tree/master/examples
+[examples]: https://github.com/iced-rs/iced/tree/master/examples
 [Coffee]: https://github.com/hecrj/coffee
 [Elm]: https://elm-lang.org/
 [The Elm Architecture]: https://guide.elm-lang.org/architecture/
-[the current issues]: https://github.com/hecrj/iced/issues
-[contributing guidelines]: https://github.com/hecrj/iced/blob/master/CONTRIBUTING.md
+[the current issues]: https://github.com/iced-rs/iced/issues
+[contributing guidelines]: https://github.com/iced-rs/iced/blob/master/CONTRIBUTING.md
 [Discord server]: https://discord.gg/3xZJ65GAhd
 [Rust Community Discord]: https://bit.ly/rust-community
 [Cryptowatch]: https://cryptowat.ch/charts

core/src/keyboard/modifiers.rs

@@ -41,21 +41,29 @@ impl Modifiers {
     };
 
     /// Returns true if the [`SHIFT`] key is pressed in the [`Modifiers`].
+    ///
+    /// [`SHIFT`]: Self::SHIFT
     pub fn shift(self) -> bool {
         self.contains(Self::SHIFT)
     }
 
     /// Returns true if the [`CTRL`] key is pressed in the [`Modifiers`].
+    ///
+    /// [`CTRL`]: Self::CTRL
     pub fn control(self) -> bool {
         self.contains(Self::CTRL)
     }
 
     /// Returns true if the [`ALT`] key is pressed in the [`Modifiers`].
+    ///
+    /// [`ALT`]: Self::ALT
     pub fn alt(self) -> bool {
         self.contains(Self::ALT)
     }
 
     /// Returns true if the [`LOGO`] key is pressed in the [`Modifiers`].
+    ///
+    /// [`LOGO`]: Self::LOGO
     pub fn logo(self) -> bool {
         self.contains(Self::LOGO)
     }

core/src/lib.rs

@@ -7,8 +7,11 @@
 //! ![The foundations of the Iced ecosystem](https://github.com/iced-rs/iced/blob/0525d76ff94e828b7b21634fa94a747022001c83/docs/graphs/foundations.png?raw=true)
 //!
 //! [Iced]: https://github.com/iced-rs/iced
-//! [`iced_native`]: https://github.com/iced-rs/iced/tree/master/native
-//! [`iced_web`]: https://github.com/iced-rs/iced/tree/master/web
+//! [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native
+//! [`iced_web`]: https://github.com/iced-rs/iced_web
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
+)]
 #![deny(missing_docs)]
 #![deny(missing_debug_implementations)]
 #![deny(unused_results)]

futures/src/command.rs

@@ -17,7 +17,7 @@ impl<T> Command<T> {
         Self(Internal::None)
     }
 
-    /// Creates a [`Command`] that performs a single [`Action`].
+    /// Creates a [`Command`] that performs a single action.
     pub const fn single(action: T) -> Self {
         Self(Internal::Single(action))
     }

futures/src/runtime.rs

@@ -9,6 +9,8 @@ use std::marker::PhantomData;
 ///
 /// If you have an [`Executor`], a [`Runtime`] can be leveraged to run any
 /// [`Command`] or [`Subscription`] and get notified of the results!
+///
+/// [`Command`]: crate::Command
 #[derive(Debug)]
 pub struct Runtime<Hasher, Event, Executor, Sender, Message> {
     executor: Executor,
@@ -51,10 +53,12 @@ where
         self.executor.enter(f)
     }
 
-    /// Spawns a [`Command`] in the [`Runtime`].
+    /// Spawns a [`Future`] in the [`Runtime`].
     ///
     /// The resulting `Message` will be forwarded to the `Sender` of the
     /// [`Runtime`].
+    ///
+    /// [`Future`]: BoxFuture
     pub fn spawn(&mut self, future: BoxFuture<Message>) {
         use futures::{FutureExt, SinkExt};
 

futures/src/subscription.rs

@@ -125,9 +125,9 @@ impl<I, O, H> std::fmt::Debug for Subscription<I, O, H> {
 /// - [`stopwatch`], a watch with start/stop and reset buttons showcasing how
 /// to listen to time.
 ///
-/// [examples]: https://github.com/iced-rs/iced/tree/0.3/examples
-/// [`download_progress`]: https://github.com/iced-rs/iced/tree/0.3/examples/download_progress
-/// [`stopwatch`]: https://github.com/iced-rs/iced/tree/0.3/examples/stopwatch
+/// [examples]: https://github.com/iced-rs/iced/tree/0.4/examples
+/// [`download_progress`]: https://github.com/iced-rs/iced/tree/0.4/examples/download_progress
+/// [`stopwatch`]: https://github.com/iced-rs/iced/tree/0.4/examples/stopwatch
 pub trait Recipe<Hasher: std::hash::Hasher, Event> {
     /// The events that will be produced by a [`Subscription`] with this
     /// [`Recipe`].

glow/README.md

@@ -1,12 +1,12 @@
 # `iced_glow`
 [![Documentation](https://docs.rs/iced_glow/badge.svg)][documentation]
 [![Crates.io](https://img.shields.io/crates/v/iced_glow.svg)](https://crates.io/crates/iced_glow)
-[![License](https://img.shields.io/crates/l/iced_glow.svg)](https://github.com/hecrj/iced/blob/master/LICENSE)
+[![License](https://img.shields.io/crates/l/iced_glow.svg)](https://github.com/iced-rs/iced/blob/master/LICENSE)
 [![Discord Server](https://img.shields.io/discord/628993209984614400?label=&labelColor=6A7EC2&logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/3xZJ65GAhd)
 
 `iced_glow` is a [`glow`] renderer for [`iced_native`]. This renderer supports OpenGL 3.0+ and OpenGL ES 2.0.
 
-This is renderer is mostly used as a fallback for hardware that doesn't support [`wgpu`] (Vulkan, Metal or DX12).
+This renderer is mostly used as a fallback for hardware that doesn't support [`wgpu`] (Vulkan, Metal or DX12).
 
 Currently, `iced_glow` supports the following primitives:
 - Text, which is rendered using [`glow_glyph`]. No shaping at all.
@@ -34,7 +34,7 @@ iced_glow = "0.2"
 __Iced moves fast and the `master` branch can contain breaking changes!__ If
 you want to learn about a specific release, check out [the release list].
 
-[the release list]: https://github.com/hecrj/iced/releases
+[the release list]: https://github.com/iced-rs/iced/releases
 
 ## Current limitations
 

glow/src/backend.rs

@@ -13,7 +13,7 @@ use iced_native::{Font, Size};
 /// A [`glow`] graphics backend for [`iced`].
 ///
 /// [`glow`]: https://github.com/grovesNL/glow
-/// [`iced`]: https://github.com/hecrj/iced
+/// [`iced`]: https://github.com/iced-rs/iced
 #[derive(Debug)]
 pub struct Backend {
     quad_pipeline: quad::Pipeline,

glow/src/lib.rs

@@ -1,9 +1,9 @@
 //! A [`glow`] renderer for [`iced_native`].
 //!
-//! ![The native path of the Iced ecosystem](https://github.com/hecrj/iced/blob/0525d76ff94e828b7b21634fa94a747022001c83/docs/graphs/native.png?raw=true)
+//! ![The native path of the Iced ecosystem](https://github.com/iced-rs/iced/blob/0525d76ff94e828b7b21634fa94a747022001c83/docs/graphs/native.png?raw=true)
 //!
 //! [`glow`]: https://github.com/grovesNL/glow
-//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native
+//! [`iced_native`]: https://github.com/iced-rs/iced/tree/0.4/native
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
 )]
@@ -37,5 +37,5 @@ pub use iced_native::{Alignment, Background, Color, Command, Length, Vector};
 /// A [`glow`] graphics renderer for [`iced`].
 ///
 /// [`glow`]: https://github.com/grovesNL/glow
-/// [`iced`]: https://github.com/hecrj/iced
+/// [`iced`]: https://github.com/iced-rs/iced
 pub type Renderer = iced_graphics::Renderer<Backend>;

graphics/src/lib.rs

@@ -1,9 +1,9 @@
 //! A bunch of backend-agnostic types that can be leveraged to build a renderer
 //! for [`iced`].
 //!
-//! ![The native path of the Iced ecosystem](https://github.com/hecrj/iced/blob/0525d76ff94e828b7b21634fa94a747022001c83/docs/graphs/native.png?raw=true)
+//! ![The native path of the Iced ecosystem](https://github.com/iced-rs/iced/blob/0525d76ff94e828b7b21634fa94a747022001c83/docs/graphs/native.png?raw=true)
 //!
-//! [`iced`]: https://github.com/hecrj/iced
+//! [`iced`]: https://github.com/iced-rs/iced
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
 )]

graphics/src/widget/canvas.rs

@@ -51,10 +51,10 @@ use std::marker::PhantomData;
 /// - [`solar_system`], an animated solar system drawn using the [`Canvas`] widget
 /// and showcasing how to compose different transforms.
 ///
-/// [examples]: https://github.com/hecrj/iced/tree/master/examples
-/// [`clock`]: https://github.com/hecrj/iced/tree/master/examples/clock
-/// [`game_of_life`]: https://github.com/hecrj/iced/tree/master/examples/game_of_life
-/// [`solar_system`]: https://github.com/hecrj/iced/tree/master/examples/solar_system
+/// [examples]: https://github.com/iced-rs/iced/tree/0.4/examples
+/// [`clock`]: https://github.com/iced-rs/iced/tree/0.4/examples/clock
+/// [`game_of_life`]: https://github.com/iced-rs/iced/tree/0.4/examples/game_of_life
+/// [`solar_system`]: https://github.com/iced-rs/iced/tree/0.4/examples/solar_system
 ///
 /// ## Drawing a simple circle
 /// If you want to get a quick overview, here's how we can draw a simple circle:

graphics/src/widget/pure/canvas/program.rs

@@ -10,10 +10,10 @@ use crate::Rectangle;
 ///
 /// [`Canvas`]: crate::widget::Canvas
 pub trait Program<Message> {
-    /// The internal [`State`] mutated by the [`Program`].
+    /// The internal state mutated by the [`Program`].
     type State: Default + 'static;
 
-    /// Updates the state of the [`Program`].
+    /// Updates the [`State`](Self::State) of the [`Program`].
     ///
     /// When a [`Program`] is used in a [`Canvas`], the runtime will call this
     /// method for each [`Event`].

graphics/src/window/compositor.rs

@@ -40,7 +40,8 @@ pub trait Compositor: Sized {
 
     /// Presents the [`Renderer`] primitives to the next frame of the given [`Surface`].
     ///
-    /// [`SwapChain`]: Self::SwapChain
+    /// [`Renderer`]: Self::Renderer
+    /// [`Surface`]: Self::Surface
     fn present<T: AsRef<str>>(
         &mut self,
         renderer: &mut Self::Renderer,
@@ -51,7 +52,7 @@ pub trait Compositor: Sized {
     ) -> Result<(), SurfaceError>;
 }
 
-/// Result of an unsuccessful call to [`Compositor::draw`].
+/// Result of an unsuccessful call to [`Compositor::present`].
 #[derive(Clone, PartialEq, Eq, Debug, Error)]
 pub enum SurfaceError {
     /// A timeout was encountered while trying to acquire the next frame.

lazy/src/lib.rs

@@ -1,7 +1,12 @@
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
+)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 pub mod component;
 pub mod responsive;
 
 #[cfg(feature = "pure")]
+#[cfg_attr(docsrs, doc(cfg(feature = "pure")))]
 pub mod pure;
 
 pub use component::Component;

native/src/command/action.rs

@@ -10,6 +10,8 @@ use std::fmt;
 /// [`Command`]: crate::Command
 pub enum Action<T> {
     /// Run a [`Future`] to completion.
+    ///
+    /// [`Future`]: iced_futures::BoxFuture
     Future(iced_futures::BoxFuture<T>),
 
     /// Run a clipboard action.
@@ -21,6 +23,8 @@ pub enum Action<T> {
 
 impl<T> Action<T> {
     /// Applies a transformation to the result of a [`Command`].
+    ///
+    /// [`Command`]: crate::Command
     pub fn map<A>(
         self,
         f: impl Fn(T) -> A + 'static + MaybeSend + Sync,

native/src/image.rs

@@ -5,7 +5,7 @@ use std::hash::{Hash, Hasher as _};
 use std::path::PathBuf;
 use std::sync::Arc;
 
-/// An [`Image`] handle.
+/// A handle of some image data.
 #[derive(Debug, Clone)]
 pub struct Handle {
     id: u64,
@@ -79,7 +79,7 @@ impl Hash for Handle {
     }
 }
 
-/// The data of an [`Image`].
+/// The data of a raster image.
 #[derive(Clone, Hash)]
 pub enum Data {
     /// File data

native/src/lib.rs

@@ -23,8 +23,8 @@
 //! - Build a new renderer, see the [renderer] module.
 //! - Build a custom widget, start at the [`Widget`] trait.
 //!
-//! [`iced_core`]: https://github.com/iced-rs/iced/tree/master/core
-//! [`iced_winit`]: https://github.com/iced-rs/iced/tree/master/winit
+//! [`iced_core`]: https://github.com/iced-rs/iced/tree/0.4/core
+//! [`iced_winit`]: https://github.com/iced-rs/iced/tree/0.4/winit
 //! [`druid`]: https://github.com/xi-editor/druid
 //! [`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
 //! [renderer]: crate::renderer

native/src/overlay.rs

@@ -63,7 +63,7 @@ where
         event::Status::Ignored
     }
 
-    /// Returns the current [`mouse::Interaction`] of the [`Widget`].
+    /// Returns the current [`mouse::Interaction`] of the [`Overlay`].
     ///
     /// By default, it returns [`mouse::Interaction::Idle`].
     fn mouse_interaction(