From 68e9eb0a9b45b86713ce5d0e9c2273a60f2cc11c Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Sat, 30 Apr 2022 14:20:52 +0200
Subject: Fix broken intra-doc links in documentation
---
native/src/command/action.rs | 4 ++++
native/src/image.rs | 4 ++--
native/src/overlay.rs | 2 +-
native/src/renderer.rs | 23 +----------------------
native/src/svg.rs | 4 ++--
native/src/text.rs | 2 +-
native/src/user_interface.rs | 5 ++---
native/src/widget/checkbox.rs | 2 +-
native/src/widget/pane_grid/configuration.rs | 4 ++--
native/src/widget/pane_grid/content.rs | 2 +-
native/src/widget/pane_grid/state.rs | 22 ++++++++++++++++++++++
native/src/widget/pane_grid/title_bar.rs | 2 +-
native/src/widget/text.rs | 6 +++---
native/src/widget/text_input.rs | 9 ++++++---
native/src/widget/toggler.rs | 2 ++
15 files changed, 51 insertions(+), 42 deletions(-)
(limited to 'native')
diff --git a/native/src/command/action.rs b/native/src/command/action.rs
index 5c7509c8..cd4309ed 100644
--- a/native/src/command/action.rs
+++ b/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,
diff --git a/native/src/image.rs b/native/src/image.rs
index 43bba4f1..516eb2db 100644
--- a/native/src/image.rs
+++ b/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
diff --git a/native/src/overlay.rs b/native/src/overlay.rs
index 124bcac2..86878f6a 100644
--- a/native/src/overlay.rs
+++ b/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(
diff --git a/native/src/renderer.rs b/native/src/renderer.rs
index ca7ad5a2..73d2f401 100644
--- a/native/src/renderer.rs
+++ b/native/src/renderer.rs
@@ -1,24 +1,4 @@
//! Write your own renderer.
-//!
-//! You will need to implement the `Renderer` trait first. It simply contains
-//! an `Output` associated type.
-//!
-//! There is no common trait to draw all the widgets. Instead, every [`Widget`]
-//! constrains its generic `Renderer` type as necessary.
-//!
-//! This approach is flexible and composable. For instance, the
-//! [`Text`] widget only needs a [`text::Renderer`] while a [`Checkbox`] widget
-//! needs both a [`text::Renderer`] and a [`checkbox::Renderer`], reusing logic.
-//!
-//! In the end, a __renderer__ satisfying all the constraints is
-//! needed to build a [`UserInterface`].
-//!
-//! [`Widget`]: crate::Widget
-//! [`UserInterface`]: crate::UserInterface
-//! [`Text`]: crate::widget::Text
-//! [`text::Renderer`]: crate::widget::text::Renderer
-//! [`Checkbox`]: crate::widget::Checkbox
-//! [`checkbox::Renderer`]: crate::widget::checkbox::Renderer
#[cfg(debug_assertions)]
mod null;
#[cfg(debug_assertions)]
@@ -27,8 +7,7 @@ pub use null::Null;
use crate::layout;
use crate::{Background, Color, Element, Rectangle, Vector};
-/// A component that can take the state of a user interface and produce an
-/// output for its users.
+/// A component that can be used by widgets to draw themselves on a screen.
pub trait Renderer: Sized {
/// Lays out the elements of a user interface.
///
diff --git a/native/src/svg.rs b/native/src/svg.rs
index 90eff87e..f86fec5b 100644
--- a/native/src/svg.rs
+++ b/native/src/svg.rs
@@ -5,7 +5,7 @@ use std::hash::{Hash, Hasher as _};
use std::path::PathBuf;
use std::sync::Arc;
-/// An [`Svg`] handle.
+/// A handle of Svg data.
#[derive(Debug, Clone)]
pub struct Handle {
id: u64,
@@ -55,7 +55,7 @@ impl Hash for Handle {
}
}
-/// The data of an [`Svg`].
+/// The data of a vectorial image.
#[derive(Clone, Hash)]
pub enum Data {
/// File data
diff --git a/native/src/text.rs b/native/src/text.rs
index 256a9c5a..6e28681d 100644
--- a/native/src/text.rs
+++ b/native/src/text.rs
@@ -39,7 +39,7 @@ pub enum Hit {
}
impl Hit {
- /// Computes the cursor position corresponding to this [`HitTestResult`] .
+ /// Computes the cursor position of the [`Hit`] .
pub fn cursor(self) -> usize {
match self {
Self::CharOffset(i) => i,
diff --git a/native/src/user_interface.rs b/native/src/user_interface.rs
index 85625e23..f80786aa 100644
--- a/native/src/user_interface.rs
+++ b/native/src/user_interface.rs
@@ -264,11 +264,10 @@ where
/// Draws the [`UserInterface`] with the provided [`Renderer`].
///
- /// It returns the some [`Renderer::Output`]. You should update the icon of
- /// the mouse cursor accordingly in your system.
+ /// It returns the current [`mouse::Interaction`]. You should update the
+ /// icon of the mouse cursor accordingly in your system.
///
/// [`Renderer`]: crate::Renderer
- /// [`Renderer::Output`]: crate::Renderer::Output
///
/// # Example
/// We can finally draw our [counter](index.html#usage) by
diff --git a/native/src/widget/checkbox.rs b/native/src/widget/checkbox.rs
index 122c5e52..b6d920df 100644
--- a/native/src/widget/checkbox.rs
+++ b/native/src/widget/checkbox.rs
@@ -102,7 +102,7 @@ impl<'a, Message, Renderer: text::Renderer> Checkbox<'a, Message, Renderer> {
/// Sets the [`Font`] of the text of the [`Checkbox`].
///
- /// [`Font`]: crate::widget::text::Renderer::Font
+ /// [`Font`]: crate::text::Renderer::Font
pub fn font(mut self, font: Renderer::Font) -> Self {
self.font = font;
self
diff --git a/native/src/widget/pane_grid/configuration.rs b/native/src/widget/pane_grid/configuration.rs
index 4c52bad4..7d68fb46 100644
--- a/native/src/widget/pane_grid/configuration.rs
+++ b/native/src/widget/pane_grid/configuration.rs
@@ -2,7 +2,7 @@ use crate::widget::pane_grid::Axis;
/// The arrangement of a [`PaneGrid`].
///
-/// [`PaneGrid`]: crate::pane_grid::PaneGrid
+/// [`PaneGrid`]: crate::widget::PaneGrid
#[derive(Debug, Clone)]
pub enum Configuration<T> {
/// A split of the available space.
@@ -21,6 +21,6 @@ pub enum Configuration<T> {
},
/// A [`Pane`].
///
- /// [`Pane`]: crate::pane_grid::Pane
+ /// [`Pane`]: crate::widget::pane_grid::Pane
Pane(T),
}
diff --git a/native/src/widget/pane_grid/content.rs b/native/src/widget/pane_grid/content.rs
index f0ed0426..407f5458 100644
--- a/native/src/widget/pane_grid/content.rs
+++ b/native/src/widget/pane_grid/content.rs
@@ -55,7 +55,7 @@ where
{
/// Draws the [`Content`] with the provided [`Renderer`] and [`Layout`].
///
- /// [`Renderer`]: crate::widget::pane_grid::Renderer
+ /// [`Renderer`]: crate::Renderer
pub fn draw(
&self,
renderer: &mut Renderer,
diff --git a/native/src/widget/pane_grid/state.rs b/native/src/widget/pane_grid/state.rs
index f9ea21f4..6a282d24 100644
--- a/native/src/widget/pane_grid/state.rs
+++ b/native/src/widget/pane_grid/state.rs
@@ -1,4 +1,6 @@
//! The state of a [`PaneGrid`].
+//!
+//! [`PaneGrid`]: crate::widget::PaneGrid
use crate::widget::pane_grid::{
Axis, Configuration, Direction, Node, Pane, Split,
};
@@ -21,9 +23,13 @@ use std::collections::{BTreeMap, HashMap};
#[derive(Debug, Clone)]
pub struct State<T> {
/// The panes of the [`PaneGrid`].
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub panes: HashMap<Pane, T>,
/// The internal state of the [`PaneGrid`].
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub internal: Internal,
pub(super) action: Action,
@@ -198,6 +204,8 @@ impl<T> State<T> {
}
/// The internal state of a [`PaneGrid`].
+///
+/// [`PaneGrid`]: crate::widget::PaneGrid
#[derive(Debug, Clone)]
pub struct Internal {
layout: Node,
@@ -207,6 +215,8 @@ pub struct Internal {
impl Internal {
/// Initializes the [`Internal`] state of a [`PaneGrid`] from a
/// [`Configuration`].
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub fn from_configuration<T>(
panes: &mut HashMap<Pane, T>,
content: Configuration<T>,
@@ -248,11 +258,17 @@ impl Internal {
}
/// The current action of a [`PaneGrid`].
+///
+/// [`PaneGrid`]: crate::widget::PaneGrid
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Action {
/// The [`PaneGrid`] is idle.
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
Idle,
/// A [`Pane`] in the [`PaneGrid`] is being dragged.
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
Dragging {
/// The [`Pane`] being dragged.
pane: Pane,
@@ -260,6 +276,8 @@ pub enum Action {
origin: Point,
},
/// A [`Split`] in the [`PaneGrid`] is being dragged.
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
Resizing {
/// The [`Split`] being dragged.
split: Split,
@@ -288,6 +306,8 @@ impl Action {
impl Internal {
/// Calculates the current [`Pane`] regions from the [`PaneGrid`] layout.
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub fn pane_regions(
&self,
spacing: f32,
@@ -297,6 +317,8 @@ impl Internal {
}
/// Calculates the current [`Split`] regions from the [`PaneGrid`] layout.
+ ///
+ /// [`PaneGrid`]: crate::widget::PaneGrid
pub fn split_regions(
&self,
spacing: f32,
diff --git a/native/src/widget/pane_grid/title_bar.rs b/native/src/widget/pane_grid/title_bar.rs
index d56972ec..a10181af 100644
--- a/native/src/widget/pane_grid/title_bar.rs
+++ b/native/src/widget/pane_grid/title_bar.rs
@@ -82,7 +82,7 @@ where
{
/// Draws the [`TitleBar`] with the provided [`Renderer`] and [`Layout`].
///
- /// [`Renderer`]: crate::widget::pane_grid::Renderer
+ /// [`Renderer`]: crate::Renderer
pub fn draw(
&self,
renderer: &mut Renderer,
diff --git a/native/src/widget/text.rs b/native/src/widget/text.rs
index 6f00c9c8..a7855c30 100644
--- a/native/src/widget/text.rs
+++ b/native/src/widget/text.rs
@@ -59,7 +59,7 @@ impl<Renderer: text::Renderer> Text<Renderer> {
/// Sets the [`Font`] of the [`Text`].
///
- /// [`Font`]: Renderer::Font
+ /// [`Font`]: crate::text::Renderer::Font
pub fn font(mut self, font: impl Into<Renderer::Font>) -> Self {
self.font = font.into();
self
@@ -77,7 +77,7 @@ impl<Renderer: text::Renderer> Text<Renderer> {
self
}
- /// Sets the [`HorizontalAlignment`] of the [`Text`].
+ /// Sets the [`alignment::Horizontal`] of the [`Text`].
pub fn horizontal_alignment(
mut self,
alignment: alignment::Horizontal,
@@ -86,7 +86,7 @@ impl<Renderer: text::Renderer> Text<Renderer> {
self
}
- /// Sets the [`VerticalAlignment`] of the [`Text`].
+ /// Sets the [`alignment::Vertical`] of the [`Text`].
pub fn vertical_alignment(
mut self,
alignment: alignment::Vertical,
diff --git a/native/src/widget/text_input.rs b/native/src/widget/text_input.rs
index a206a0c7..5ecd68e9 100644
--- a/native/src/widget/text_input.rs
+++ b/native/src/widget/text_input.rs
@@ -108,10 +108,9 @@ where
self
}
- /// Sets the [`Font`] of the [`Text`].
+ /// Sets the [`Font`] of the [`TextInput`].
///
- /// [`Font`]: crate::widget::text::Renderer::Font
- /// [`Text`]: crate::widget::Text
+ /// [`Font`]: crate::text::Renderer::Font
pub fn font(mut self, font: Renderer::Font) -> Self {
self.font = font;
self
@@ -157,6 +156,8 @@ where
/// Draws the [`TextInput`] with the given [`Renderer`], overriding its
/// [`Value`] if provided.
+ ///
+ /// [`Renderer`]: text::Renderer
pub fn draw(
&self,
renderer: &mut Renderer,
@@ -570,6 +571,8 @@ where
/// Draws the [`TextInput`] with the given [`Renderer`], overriding its
/// [`Value`] if provided.
+///
+/// [`Renderer`]: text::Renderer
pub fn draw<Renderer>(
renderer: &mut Renderer,
layout: Layout<'_>,
diff --git a/native/src/widget/toggler.rs b/native/src/widget/toggler.rs
index 536aef78..6d7592f3 100644
--- a/native/src/widget/toggler.rs
+++ b/native/src/widget/toggler.rs
@@ -107,6 +107,8 @@ impl<'a, Message, Renderer: text::Renderer> Toggler<'a, Message, Renderer> {
}
/// Sets the [`Font`] of the text of the [`Toggler`]
+ ///
+ /// [`Font`]: crate::text::Renderer::Font
pub fn font(mut self, font: Renderer::Font) -> Self {
self.font = font;
self
--
cgit