From ac35fe3edf78c1674fe85b37549002e006b0ff13 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Sat, 30 Apr 2022 13:54:07 +0200 Subject: Point repository links to `0.4` branch in documentation --- graphics/src/widget/canvas.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'graphics/src') diff --git a/graphics/src/widget/canvas.rs b/graphics/src/widget/canvas.rs index 6c526e35..0ed45e42 100644 --- a/graphics/src/widget/canvas.rs +++ b/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/hecrj/iced/tree/0.4/examples +/// [`clock`]: https://github.com/hecrj/iced/tree/0.4/examples/clock +/// [`game_of_life`]: https://github.com/hecrj/iced/tree/0.4/examples/game_of_life +/// [`solar_system`]: https://github.com/hecrj/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: -- cgit From 68e9eb0a9b45b86713ce5d0e9c2273a60f2cc11c Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Sat, 30 Apr 2022 14:20:52 +0200 Subject: Fix broken intra-doc links in documentation --- graphics/src/widget/pure/canvas/program.rs | 4 ++-- graphics/src/window/compositor.rs | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) (limited to 'graphics/src') diff --git a/graphics/src/widget/pure/canvas/program.rs b/graphics/src/widget/pure/canvas/program.rs index ee74c27f..058b364b 100644 --- a/graphics/src/widget/pure/canvas/program.rs +++ b/graphics/src/widget/pure/canvas/program.rs @@ -10,10 +10,10 @@ use crate::Rectangle; /// /// [`Canvas`]: crate::widget::Canvas pub trait Program { - /// 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`]. diff --git a/graphics/src/window/compositor.rs b/graphics/src/window/compositor.rs index 9ea040cd..04a87bc6 100644 --- a/graphics/src/window/compositor.rs +++ b/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>( &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. -- cgit From aecbd46123eb556fa1193cdf3b9eb96cfd4beff2 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 2 May 2022 20:25:47 +0200 Subject: Replace `hecrj` in links with `iced-rs` --- graphics/src/lib.rs | 4 ++-- graphics/src/widget/canvas.rs | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'graphics/src') diff --git a/graphics/src/lib.rs b/graphics/src/lib.rs index b3be62af..9661f6ef 100644 --- a/graphics/src/lib.rs +++ b/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" )] diff --git a/graphics/src/widget/canvas.rs b/graphics/src/widget/canvas.rs index 0ed45e42..23444b2b 100644 --- a/graphics/src/widget/canvas.rs +++ b/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/0.4/examples -/// [`clock`]: https://github.com/hecrj/iced/tree/0.4/examples/clock -/// [`game_of_life`]: https://github.com/hecrj/iced/tree/0.4/examples/game_of_life -/// [`solar_system`]: https://github.com/hecrj/iced/tree/0.4/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: -- cgit