summaryrefslogtreecommitdiffstats
path: root/wgpu
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-11-25 07:11:27 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-11-26 02:05:43 +0100
commit01322f69a406eee76014f5e2834336e2295ad80e (patch)
tree380d9224b81537e460ea7f9fe84c0c912d3f4cbf /wgpu
parentd612bf56784b41346f18ad9eda4f6d54d699dcb5 (diff)
downloadiced-01322f69a406eee76014f5e2834336e2295ad80e.tar.gz
iced-01322f69a406eee76014f5e2834336e2295ad80e.tar.bz2
iced-01322f69a406eee76014f5e2834336e2295ad80e.zip
Use recently stabilized intra-doc links
See RFC: https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md
Diffstat (limited to 'wgpu')
-rw-r--r--wgpu/src/backend.rs2
-rw-r--r--wgpu/src/settings.rs12
-rw-r--r--wgpu/src/widget/button.rs3
-rw-r--r--wgpu/src/widget/canvas.rs3
-rw-r--r--wgpu/src/widget/pane_grid.rs7
-rw-r--r--wgpu/src/widget/progress_bar.rs2
-rw-r--r--wgpu/src/widget/slider.rs3
-rw-r--r--wgpu/src/widget/text_input.rs3
-rw-r--r--wgpu/src/window/compositor.rs6
9 files changed, 7 insertions, 34 deletions
diff --git a/wgpu/src/backend.rs b/wgpu/src/backend.rs
index 819d65c7..fccb5ac7 100644
--- a/wgpu/src/backend.rs
+++ b/wgpu/src/backend.rs
@@ -30,8 +30,6 @@ pub struct Backend {
impl Backend {
/// Creates a new [`Backend`].
- ///
- /// [`Backend`]: struct.Backend.html
pub fn new(device: &wgpu::Device, settings: Settings) -> Self {
let text_pipeline =
text::Pipeline::new(device, settings.format, settings.default_font);
diff --git a/wgpu/src/settings.rs b/wgpu/src/settings.rs
index 07a180bb..26763e22 100644
--- a/wgpu/src/settings.rs
+++ b/wgpu/src/settings.rs
@@ -1,19 +1,19 @@
//! Configure a renderer.
pub use crate::Antialiasing;
-/// The settings of a [`Renderer`].
+/// The settings of a [`Backend`].
///
-/// [`Renderer`]: ../struct.Renderer.html
+/// [`Backend`]: crate::Backend
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Settings {
- /// The output format of the [`Renderer`].
+ /// The output format of the [`Backend`].
///
- /// [`Renderer`]: ../struct.Renderer.html
+ /// [`Backend`]: crate::Backend
pub format: wgpu::TextureFormat,
- /// The present mode of the [`Renderer`].
+ /// The present mode of the [`Backend`].
///
- /// [`Renderer`]: ../struct.Renderer.html
+ /// [`Backend`]: crate::Backend
pub present_mode: wgpu::PresentMode,
/// The bytes of the font that will be used by default.
diff --git a/wgpu/src/widget/button.rs b/wgpu/src/widget/button.rs
index fee7a7f8..fc729cd5 100644
--- a/wgpu/src/widget/button.rs
+++ b/wgpu/src/widget/button.rs
@@ -1,9 +1,6 @@
//! Allow your users to perform actions by pressing a button.
//!
//! A [`Button`] has some local [`State`].
-//!
-//! [`Button`]: type.Button.html
-//! [`State`]: struct.State.html
use crate::Renderer;
pub use iced_graphics::button::{Style, StyleSheet};
diff --git a/wgpu/src/widget/canvas.rs b/wgpu/src/widget/canvas.rs
index bef34857..399dd19c 100644
--- a/wgpu/src/widget/canvas.rs
+++ b/wgpu/src/widget/canvas.rs
@@ -3,7 +3,4 @@
//! A [`Canvas`] widget can be used to draw different kinds of 2D shapes in a
//! [`Frame`]. It can be used for animation, data visualization, game graphics,
//! and more!
-//!
-//! [`Canvas`]: struct.Canvas.html
-//! [`Frame`]: struct.Frame.html
pub use iced_graphics::canvas::*;
diff --git a/wgpu/src/widget/pane_grid.rs b/wgpu/src/widget/pane_grid.rs
index f594473f..c26dde48 100644
--- a/wgpu/src/widget/pane_grid.rs
+++ b/wgpu/src/widget/pane_grid.rs
@@ -6,8 +6,7 @@
//! The [`pane_grid` example] showcases how to use a [`PaneGrid`] with resizing,
//! drag and drop, and hotkey support.
//!
-//! [`pane_grid` example]: https://github.com/hecrj/iced/tree/0.1/examples/pane_grid
-//! [`PaneGrid`]: type.PaneGrid.html
+//! [`pane_grid` example]: https://github.com/hecrj/iced/tree/0.2/examples/pane_grid
use crate::Renderer;
pub use iced_native::pane_grid::{
@@ -24,13 +23,9 @@ pub use iced_native::pane_grid::{
pub type PaneGrid<'a, Message> = iced_native::PaneGrid<'a, Message, Renderer>;
/// The content of a [`Pane`].
-///
-/// [`Pane`]: struct.Pane.html
pub type Content<'a, Message> =
iced_native::pane_grid::Content<'a, Message, Renderer>;
/// The title bar of a [`Pane`].
-///
-/// [`Pane`]: struct.Pane.html
pub type TitleBar<'a, Message> =
iced_native::pane_grid::TitleBar<'a, Message, Renderer>;
diff --git a/wgpu/src/widget/progress_bar.rs b/wgpu/src/widget/progress_bar.rs
index a636a3a6..45a25d00 100644
--- a/wgpu/src/widget/progress_bar.rs
+++ b/wgpu/src/widget/progress_bar.rs
@@ -2,8 +2,6 @@
//!
//! A [`ProgressBar`] has a range of possible values and a current value,
//! as well as a length, height and style.
-//!
-//! [`ProgressBar`]: type.ProgressBar.html
use crate::Renderer;
pub use iced_graphics::progress_bar::{Style, StyleSheet};
diff --git a/wgpu/src/widget/slider.rs b/wgpu/src/widget/slider.rs
index 3a8c2595..9a269858 100644
--- a/wgpu/src/widget/slider.rs
+++ b/wgpu/src/widget/slider.rs
@@ -1,9 +1,6 @@
//! Display an interactive selector of a single value from a range of values.
//!
//! A [`Slider`] has some local [`State`].
-//!
-//! [`Slider`]: struct.Slider.html
-//! [`State`]: struct.State.html
use crate::Renderer;
pub use iced_graphics::slider::{Handle, HandleShape, Style, StyleSheet};
diff --git a/wgpu/src/widget/text_input.rs b/wgpu/src/widget/text_input.rs
index 1da3fbe6..db18b1cc 100644
--- a/wgpu/src/widget/text_input.rs
+++ b/wgpu/src/widget/text_input.rs
@@ -1,9 +1,6 @@
//! Display fields that can be filled with text.
//!
//! A [`TextInput`] has some local [`State`].
-//!
-//! [`TextInput`]: struct.TextInput.html
-//! [`State`]: struct.State.html
use crate::Renderer;
pub use iced_graphics::text_input::{Style, StyleSheet};
diff --git a/wgpu/src/window/compositor.rs b/wgpu/src/window/compositor.rs
index baa94d4e..492efb42 100644
--- a/wgpu/src/window/compositor.rs
+++ b/wgpu/src/window/compositor.rs
@@ -21,9 +21,6 @@ impl Compositor {
/// Requests a new [`Compositor`] with the given [`Settings`].
///
/// Returns `None` if no compatible graphics adapter could be found.
- ///
- /// [`Compositor`]: struct.Compositor.html
- /// [`Settings`]: struct.Settings.html
pub async fn request(settings: Settings) -> Option<Self> {
let instance = wgpu::Instance::new(wgpu::BackendBit::PRIMARY);
@@ -67,9 +64,6 @@ impl Compositor {
}
/// Creates a new rendering [`Backend`] for this [`Compositor`].
- ///
- /// [`Compositor`]: struct.Compositor.html
- /// [`Backend`]: struct.Backend.html
pub fn create_backend(&self) -> Backend {
Backend::new(&self.device, self.settings)
}