summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-11-10 00:10:53 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-11-10 00:10:53 +0100
commit1480ab20306e463b69b2229dcd5e81d4c66b2a64 (patch)
treefa9e1557a68e0a423d858618dd2d2e1484757027
parentff9395838b5075eb357082f7bb9a6f9a58d7864b (diff)
downloadiced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.tar.gz
iced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.tar.bz2
iced-1480ab20306e463b69b2229dcd5e81d4c66b2a64.zip
Fix broken documentation links
-rw-r--r--graphics/src/gradient.rs7
-rw-r--r--graphics/src/gradient/linear.rs5
-rw-r--r--graphics/src/widget/canvas/fill.rs2
-rw-r--r--graphics/src/widget/canvas/stroke.rs2
-rw-r--r--graphics/src/window/compositor.rs2
-rw-r--r--graphics/src/window/gl_compositor.rs2
-rw-r--r--native/src/overlay.rs26
-rw-r--r--native/src/overlay/element.rs2
-rw-r--r--native/src/overlay/menu.rs14
-rw-r--r--native/src/widget/container.rs2
-rw-r--r--native/src/widget/helpers.rs2
-rw-r--r--native/src/widget/pane_grid/content.rs2
-rw-r--r--native/src/widget/pane_grid/state.rs4
-rw-r--r--native/src/widget/pane_grid/title_bar.rs2
-rw-r--r--native/src/widget/text.rs2
-rw-r--r--native/src/widget/text_input.rs2
-rw-r--r--native/src/widget/tree.rs12
-rw-r--r--src/application.rs3
-rw-r--r--src/overlay.rs2
-rw-r--r--winit/src/application.rs4
20 files changed, 38 insertions, 61 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
diff --git a/native/src/overlay.rs b/native/src/overlay.rs
index 905d3389..8c01581f 100644
--- a/native/src/overlay.rs
+++ b/native/src/overlay.rs
@@ -11,7 +11,7 @@ use crate::layout;
use crate::mouse;
use crate::renderer;
use crate::widget;
-use crate::widget::tree::{self, Tree};
+use crate::widget::Tree;
use crate::{Clipboard, Layout, Point, Rectangle, Shell, Size};
/// An interactive component that can be displayed on top of other widgets.
@@ -42,29 +42,7 @@ where
cursor_position: Point,
);
- /// Returns the [`Tag`] of the [`Widget`].
- ///
- /// [`Tag`]: tree::Tag
- fn tag(&self) -> tree::Tag {
- tree::Tag::stateless()
- }
-
- /// Returns the [`State`] of the [`Widget`].
- ///
- /// [`State`]: tree::State
- fn state(&self) -> tree::State {
- tree::State::None
- }
-
- /// Returns the state [`Tree`] of the children of the [`Widget`].
- fn children(&self) -> Vec<Tree> {
- Vec::new()
- }
-
- /// Reconciliates the [`Widget`] with the provided [`Tree`].
- fn diff(&self, _tree: &mut Tree) {}
-
- /// Applies an [`Operation`] to the [`Widget`].
+ /// Applies a [`widget::Operation`] to the [`Overlay`].
fn operate(
&self,
_layout: Layout<'_>,
diff --git a/native/src/overlay/element.rs b/native/src/overlay/element.rs
index 9500df27..2c558086 100644
--- a/native/src/overlay/element.rs
+++ b/native/src/overlay/element.rs
@@ -104,7 +104,7 @@ where
.draw(renderer, theme, style, layout, cursor_position)
}
- /// Applies an [`Operation`] to the [`Element`].
+ /// Applies a [`widget::Operation`] to the [`Element`].
pub fn operate(
&self,
layout: Layout<'_>,
diff --git a/native/src/overlay/menu.rs b/native/src/overlay/menu.rs
index 3b55eba1..2e4f70b5 100644
--- a/native/src/overlay/menu.rs
+++ b/native/src/overlay/menu.rs
@@ -9,7 +9,7 @@ use crate::text::{self, Text};
use crate::touch;
use crate::widget::container::{self, Container};
use crate::widget::scrollable::{self, Scrollable};
-use crate::widget::tree::{self, Tree};
+use crate::widget::Tree;
use crate::{
Clipboard, Color, Element, Layout, Length, Padding, Point, Rectangle,
Shell, Size, Vector, Widget,
@@ -199,18 +199,6 @@ where
Renderer: text::Renderer,
Renderer::Theme: StyleSheet + container::StyleSheet,
{
- fn tag(&self) -> tree::Tag {
- self.container.tag()
- }
-
- fn state(&self) -> tree::State {
- self.container.state()
- }
-
- fn children(&self) -> Vec<Tree> {
- self.container.children()
- }
-
fn layout(
&self,
renderer: &Renderer,
diff --git a/native/src/widget/container.rs b/native/src/widget/container.rs
index 16537c50..9d3e4d9b 100644
--- a/native/src/widget/container.rs
+++ b/native/src/widget/container.rs
@@ -309,7 +309,7 @@ pub fn layout<Renderer>(
layout::Node::with_children(size.pad(padding), vec![content])
}
-/// Draws the background of a [`Container`] given its [`Style`] and its `bounds`.
+/// Draws the background of a [`Container`] given its [`Appearance`] and its `bounds`.
pub fn draw_background<Renderer>(
renderer: &mut Renderer,
appearance: &Appearance,
diff --git a/native/src/widget/helpers.rs b/native/src/widget/helpers.rs
index fe6fb815..3bce9e60 100644
--- a/native/src/widget/helpers.rs
+++ b/native/src/widget/helpers.rs
@@ -19,7 +19,7 @@ macro_rules! column {
);
}
-/// Creates a [Row`] with the given children.
+/// Creates a [`Row`] with the given children.
///
/// [`Row`]: widget::Row
#[macro_export]
diff --git a/native/src/widget/pane_grid/content.rs b/native/src/widget/pane_grid/content.rs
index 405dc0b2..7e6c8148 100644
--- a/native/src/widget/pane_grid/content.rs
+++ b/native/src/widget/pane_grid/content.rs
@@ -87,7 +87,7 @@ where
/// Draws the [`Content`] with the provided [`Renderer`] and [`Layout`].
///
- /// [`Renderer`]: iced_native::Renderer
+ /// [`Renderer`]: crate::Renderer
pub fn draw(
&self,
tree: &Tree,
diff --git a/native/src/widget/pane_grid/state.rs b/native/src/widget/pane_grid/state.rs
index 58397444..c4ae0a0e 100644
--- a/native/src/widget/pane_grid/state.rs
+++ b/native/src/widget/pane_grid/state.rs
@@ -32,7 +32,9 @@ pub struct State<T> {
/// [`PaneGrid`]: crate::widget::PaneGrid
pub internal: Internal,
- /// The maximized [`Pane`] of the [`PaneGrid`]
+ /// The maximized [`Pane`] of the [`PaneGrid`].
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub(super) maximized: Option<Pane>,
}
diff --git a/native/src/widget/pane_grid/title_bar.rs b/native/src/widget/pane_grid/title_bar.rs
index 783a14c3..1b70e51b 100644
--- a/native/src/widget/pane_grid/title_bar.rs
+++ b/native/src/widget/pane_grid/title_bar.rs
@@ -114,7 +114,7 @@ where
/// Draws the [`TitleBar`] with the provided [`Renderer`] and [`Layout`].
///
- /// [`Renderer`]: iced_native::Renderer
+ /// [`Renderer`]: crate::Renderer
pub fn draw(
&self,
tree: &Tree,
diff --git a/native/src/widget/text.rs b/native/src/widget/text.rs
index dab6e874..be9e775e 100644
--- a/native/src/widget/text.rs
+++ b/native/src/widget/text.rs
@@ -74,7 +74,7 @@ where
self
}
- /// Sets the [`Color`] of the [`Text`].
+ /// Sets the style of the [`Text`].
pub fn style(
mut self,
style: impl Into<<Renderer::Theme as StyleSheet>::Style>,
diff --git a/native/src/widget/text_input.rs b/native/src/widget/text_input.rs
index 22eff7f1..2315b05a 100644
--- a/native/src/widget/text_input.rs
+++ b/native/src/widget/text_input.rs
@@ -165,7 +165,7 @@ where
}
/// Draws the [`TextInput`] with the given [`Renderer`], overriding its
- /// [`text_input::Value`] if provided.
+ /// [`Value`] if provided.
///
/// [`Renderer`]: text::Renderer
pub fn draw(
diff --git a/native/src/widget/tree.rs b/native/src/widget/tree.rs
index a8b1a185..0af40c33 100644
--- a/native/src/widget/tree.rs
+++ b/native/src/widget/tree.rs
@@ -30,7 +30,7 @@ impl Tree {
}
}
- /// Creates a new [`Tree`] for the provided [`Element`].
+ /// Creates a new [`Tree`] for the provided [`Widget`].
pub fn new<'a, Message, Renderer>(
widget: impl Borrow<dyn Widget<Message, Renderer> + 'a>,
) -> Self
@@ -46,10 +46,10 @@ impl Tree {
}
}
- /// Reconciliates the current tree with the provided [`Element`].
+ /// Reconciliates the current tree with the provided [`Widget`].
///
- /// If the tag of the [`Element`] matches the tag of the [`Tree`], then the
- /// [`Element`] proceeds with the reconciliation (i.e. [`Widget::diff`] is called).
+ /// If the tag of the [`Widget`] matches the tag of the [`Tree`], then the
+ /// [`Widget`] proceeds with the reconciliation (i.e. [`Widget::diff`] is called).
///
/// Otherwise, the whole [`Tree`] is recreated.
///
@@ -67,7 +67,7 @@ impl Tree {
}
}
- /// Reconciliates the children of the tree with the provided list of [`Element`].
+ /// Reconciliates the children of the tree with the provided list of widgets.
pub fn diff_children<'a, Message, Renderer>(
&mut self,
new_children: &[impl Borrow<dyn Widget<Message, Renderer> + 'a>],
@@ -81,7 +81,7 @@ impl Tree {
)
}
- /// Reconciliates the children of the tree with the provided list of [`Element`] using custom
+ /// Reconciliates the children of the tree with the provided list of widgets using custom
/// logic both for diffing and creating new widget state.
pub fn diff_children_custom<T>(
&mut self,
diff --git a/src/application.rs b/src/application.rs
index 23ce034e..ae5e948f 100644
--- a/src/application.rs
+++ b/src/application.rs
@@ -148,9 +148,8 @@ pub trait Application: Sized {
Self::Theme::default()
}
- /// Returns the current [`Style`] of the [`Theme`].
+ /// Returns the current `Style` of the [`Theme`].
///
- /// [`Style`]: <Self::Theme as StyleSheet>::Style
/// [`Theme`]: Self::Theme
fn style(&self) -> <Self::Theme as StyleSheet>::Style {
<Self::Theme as StyleSheet>::Style::default()
diff --git a/src/overlay.rs b/src/overlay.rs
index a7003751..c0f4c492 100644
--- a/src/overlay.rs
+++ b/src/overlay.rs
@@ -3,6 +3,8 @@
/// A generic [`Overlay`].
///
/// This is an alias of an `iced_native` element with a default `Renderer`.
+///
+/// [`Overlay`]: iced_native::Overlay
pub type Element<'a, Message, Renderer = crate::Renderer> =
iced_native::overlay::Element<'a, Message, Renderer>;
diff --git a/winit/src/application.rs b/winit/src/application.rs
index ffaaa8fb..1706d2e9 100644
--- a/winit/src/application.rs
+++ b/winit/src/application.rs
@@ -58,10 +58,10 @@ where
/// title of your application when necessary.
fn title(&self) -> String;
- /// Returns the current [`Theme`] of the [`Application`].
+ /// Returns the current `Theme` of the [`Application`].
fn theme(&self) -> <Self::Renderer as crate::Renderer>::Theme;
- /// Returns the [`Style`] variation of the [`Theme`].
+ /// Returns the `Style` variation of the `Theme`.
fn style(
&self,
) -> <<Self::Renderer as crate::Renderer>::Theme as StyleSheet>::Style {