diff options
author | 2022-11-10 00:10:53 +0100 | |
---|---|---|
committer | 2022-11-10 00:10:53 +0100 | |
commit | 1480ab20306e463b69b2229dcd5e81d4c66b2a64 (patch) | |
tree | fa9e1557a68e0a423d858618dd2d2e1484757027 /graphics | |
parent | ff9395838b5075eb357082f7bb9a6f9a58d7864b (diff) | |
download | iced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.tar.gz iced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.tar.bz2 iced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.zip |
Fix broken documentation links
Diffstat (limited to '')
-rw-r--r-- | graphics/src/gradient.rs | 7 | ||||
-rw-r--r-- | graphics/src/gradient/linear.rs | 5 | ||||
-rw-r--r-- | graphics/src/widget/canvas/fill.rs | 2 | ||||
-rw-r--r-- | graphics/src/widget/canvas/stroke.rs | 2 | ||||
-rw-r--r-- | graphics/src/window/compositor.rs | 2 | ||||
-rw-r--r-- | graphics/src/window/gl_compositor.rs | 2 |
6 files changed, 14 insertions, 6 deletions
diff --git a/graphics/src/gradient.rs b/graphics/src/gradient.rs index 64f9e4b3..83f25238 100644 --- a/graphics/src/gradient.rs +++ b/graphics/src/gradient.rs @@ -9,7 +9,7 @@ use crate::{Color, Point, Size}; /// A fill which transitions colors progressively along a direction, either linearly, radially (TBD), /// or conically (TBD). pub enum Gradient { - /// A linear gradient interpolates colors along a direction from its [`start`] to its [`end`] + /// A linear gradient interpolates colors along a direction from its `start` to its `end` /// point. Linear(Linear), } @@ -23,10 +23,15 @@ impl Gradient { #[derive(Debug, Clone, Copy, PartialEq)] /// A point along the gradient vector where the specified [`color`] is unmixed. +/// +/// [`color`]: Self::color pub struct ColorStop { /// Offset along the gradient vector. pub offset: f32, + /// The color of the gradient at the specified [`offset`]. + /// + /// [`offset`]: Self::offset pub color: Color, } diff --git a/graphics/src/gradient/linear.rs b/graphics/src/gradient/linear.rs index 9928c1eb..c886db47 100644 --- a/graphics/src/gradient/linear.rs +++ b/graphics/src/gradient/linear.rs @@ -2,7 +2,10 @@ use crate::gradient::{ColorStop, Gradient, Position}; use crate::{Color, Point}; -/// A linear gradient that can be used in the style of [`super::Fill`] or [`super::Stroke`]. +/// A linear gradient that can be used in the style of [`Fill`] or [`Stroke`]. +/// +/// [`Fill`]: crate::widget::canvas::Fill +/// [`Stroke`]: crate::widget::canvas::Stroke #[derive(Debug, Clone, PartialEq)] pub struct Linear { /// The point where the linear gradient begins. diff --git a/graphics/src/widget/canvas/fill.rs b/graphics/src/widget/canvas/fill.rs index c69fc0d7..e2fc1cfe 100644 --- a/graphics/src/widget/canvas/fill.rs +++ b/graphics/src/widget/canvas/fill.rs @@ -8,7 +8,7 @@ pub use crate::triangle::Style; pub struct Fill { /// The color or gradient of the fill. /// - /// By default, it is set to [`FillStyle::Solid`] `BLACK`. + /// By default, it is set to [`Style::Solid`] with [`Color::BLACK`]. pub style: Style, /// The fill rule defines how to determine what is inside and what is diff --git a/graphics/src/widget/canvas/stroke.rs b/graphics/src/widget/canvas/stroke.rs index f9b8e447..a882531a 100644 --- a/graphics/src/widget/canvas/stroke.rs +++ b/graphics/src/widget/canvas/stroke.rs @@ -8,7 +8,7 @@ use iced_native::Color; pub struct Stroke<'a> { /// The color or gradient of the stroke. /// - /// By default, it is set to [`StrokeStyle::Solid`] `BLACK`. + /// By default, it is set to a [`Style::Solid`] with [`Color::BLACK`]. pub style: Style, /// The distance between the two edges of the stroke. pub width: f32, diff --git a/graphics/src/window/compositor.rs b/graphics/src/window/compositor.rs index 52255666..db4ba45d 100644 --- a/graphics/src/window/compositor.rs +++ b/graphics/src/window/compositor.rs @@ -40,7 +40,7 @@ pub trait Compositor: Sized { height: u32, ); - /// Returns [`GraphicsInformation`] used by this [`Compositor`]. + /// Returns [`Information`] used by this [`Compositor`]. fn fetch_information(&self) -> Information; /// Presents the [`Renderer`] primitives to the next frame of the given [`Surface`]. diff --git a/graphics/src/window/gl_compositor.rs b/graphics/src/window/gl_compositor.rs index 722e4d9c..a45a7ca1 100644 --- a/graphics/src/window/gl_compositor.rs +++ b/graphics/src/window/gl_compositor.rs @@ -54,7 +54,7 @@ pub trait GLCompositor: Sized { /// Resizes the viewport of the [`GLCompositor`]. fn resize_viewport(&mut self, physical_size: Size<u32>); - /// Returns [`GraphicsInformation`] used by this [`Compositor`]. + /// Returns [`Information`] used by this [`GLCompositor`]. fn fetch_information(&self) -> Information; /// Presents the primitives of the [`Renderer`] to the next frame of the |