Fix majority of unresolved documentation links
This commit is contained in:
parent
89d9c45d25
commit
89d9f1d7d2
40 changed files with 117 additions and 137 deletions
|
|
@ -2,32 +2,9 @@
|
|||
//!
|
||||
//! 
|
||||
//!
|
||||
//! `iced_native` takes [`iced_core`] and builds a native runtime on top of it,
|
||||
//! featuring:
|
||||
//!
|
||||
//! - A custom layout engine, greatly inspired by [`druid`]
|
||||
//! - Event handling for all the built-in widgets
|
||||
//! - A renderer-agnostic API
|
||||
//!
|
||||
//! To achieve this, it introduces a couple of reusable interfaces:
|
||||
//!
|
||||
//! - A [`Widget`] trait, which is used to implement new widgets: from layout
|
||||
//! requirements to event and drawing logic.
|
||||
//! - A bunch of `Renderer` traits, meant to keep the crate renderer-agnostic.
|
||||
//!
|
||||
//! # Usage
|
||||
//! The strategy to use this crate depends on your particular use case. If you
|
||||
//! want to:
|
||||
//! - Implement a custom shell or integrate it in your own system, check out the
|
||||
//! [`UserInterface`] type.
|
||||
//! - Build a new renderer, see the [renderer] module.
|
||||
//! - Build a custom widget, start at the [`Widget`] trait.
|
||||
//! `iced_runtime` takes [`iced_core`] and builds a native runtime on top of it.
|
||||
//!
|
||||
//! [`iced_core`]: https://github.com/iced-rs/iced/tree/0.10/core
|
||||
//! [`iced_winit`]: https://github.com/iced-rs/iced/tree/0.10/winit
|
||||
//! [`druid`]: https://github.com/xi-editor/druid
|
||||
//! [`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
|
||||
//! [renderer]: crate::renderer
|
||||
#![doc(
|
||||
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
|
||||
)]
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ use crate::core::renderer;
|
|||
use crate::core::widget;
|
||||
use crate::core::{Clipboard, Event, Layout, Point, Rectangle, Shell, Size};
|
||||
|
||||
/// An [`Overlay`] container that displays nested overlays
|
||||
/// An overlay container that displays nested overlays
|
||||
#[allow(missing_debug_implementations)]
|
||||
pub struct Nested<'a, Message, Renderer> {
|
||||
overlay: overlay::Element<'a, Message, Renderer>,
|
||||
|
|
@ -27,6 +27,8 @@ where
|
|||
}
|
||||
|
||||
/// Returns the layout [`Node`] of the [`Nested`] overlay.
|
||||
///
|
||||
/// [`Node`]: layout::Node
|
||||
pub fn layout(
|
||||
&mut self,
|
||||
renderer: &Renderer,
|
||||
|
|
|
|||
|
|
@ -175,7 +175,7 @@ where
|
|||
(uncaptured_events, command)
|
||||
}
|
||||
|
||||
/// Applies [`widget::Operation`]s to the [`State`]
|
||||
/// Applies [`Operation`]s to the [`State`]
|
||||
pub fn operate(
|
||||
&mut self,
|
||||
renderer: &mut P::Renderer,
|
||||
|
|
|
|||
|
|
@ -356,7 +356,7 @@ where
|
|||
/// It returns the current [`mouse::Interaction`]. You should update the
|
||||
/// icon of the mouse cursor accordingly in your system.
|
||||
///
|
||||
/// [`Renderer`]: crate::Renderer
|
||||
/// [`Renderer`]: crate::core::Renderer
|
||||
///
|
||||
/// # Example
|
||||
/// We can finally draw our [counter](index.html#usage) by
|
||||
|
|
@ -619,7 +619,7 @@ pub enum State {
|
|||
/// The [`UserInterface`] is up-to-date and can be reused without
|
||||
/// rebuilding.
|
||||
Updated {
|
||||
/// The [`Instant`] when a redraw should be performed.
|
||||
/// The [`window::RedrawRequest`] when a redraw should be performed.
|
||||
redraw_request: Option<window::RedrawRequest>,
|
||||
},
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue