Fix broken intra-doc links
This commit is contained in:
parent
7def3ee38a
commit
6740c2c5d6
8 changed files with 12 additions and 27 deletions
|
|
@ -24,7 +24,7 @@ pub trait Compositor: Sized {
|
|||
compatible_window: Option<&W>,
|
||||
) -> Result<(Self, Self::Renderer), Error>;
|
||||
|
||||
/// Creates a [`Renderer`] for the [`Compositor`].
|
||||
/// Creates a [`Self::Renderer`] for the [`Compositor`].
|
||||
fn renderer(&self) -> Self::Renderer;
|
||||
|
||||
/// Crates a new [`Surface`] for the given window.
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ where
|
|||
(uncaptured_events, commands)
|
||||
}
|
||||
|
||||
/// Applies [`widget::Operation`]s to the [`State`]
|
||||
/// Applies widget [`Operation`]s to the [`State`].
|
||||
pub fn operate(
|
||||
&mut self,
|
||||
renderer: &mut P::Renderer,
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ pub enum Action<T> {
|
|||
Drag,
|
||||
/// Spawns a new window.
|
||||
Spawn {
|
||||
/// The settings of the [`Window`].
|
||||
/// The settings of the window.
|
||||
settings: Settings,
|
||||
},
|
||||
/// Resize the window.
|
||||
|
|
|
|||
|
|
@ -62,6 +62,8 @@ pub use crate::style::application::{Appearance, StyleSheet};
|
|||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`Sandbox`]: crate::Sandbox
|
||||
pub trait Application: Sized {
|
||||
/// The [`Executor`] that will run commands and subscriptions.
|
||||
///
|
||||
|
|
|
|||
|
|
@ -272,7 +272,7 @@ pub fn window_level(level: window::Level) -> winit::window::WindowLevel {
|
|||
}
|
||||
}
|
||||
|
||||
/// Converts a [`Position`] to a [`winit`] logical position for a given monitor.
|
||||
/// Converts a [`window::Position`] to a [`winit`] logical position for a given monitor.
|
||||
///
|
||||
/// [`winit`]: https://github.com/rust-windowing/winit
|
||||
pub fn position(
|
||||
|
|
|
|||
|
|
@ -23,34 +23,19 @@ use std::mem::ManuallyDrop;
|
|||
use std::time::Instant;
|
||||
use winit::monitor::MonitorHandle;
|
||||
|
||||
/// This is a wrapper around the `Application::Message` associate type
|
||||
/// to allows the `shell` to create internal messages, while still having
|
||||
/// the current user-specified custom messages.
|
||||
#[derive(Debug)]
|
||||
pub enum Event<Message> {
|
||||
/// An internal event which contains an [`Application`] generated message.
|
||||
enum Event<Message> {
|
||||
Application(Message),
|
||||
/// An internal event which spawns a new window.
|
||||
NewWindow {
|
||||
/// The [window::Id] of the newly spawned [`Window`].
|
||||
id: window::Id,
|
||||
/// The [settings::Window] of the newly spawned [`Window`].
|
||||
settings: window::Settings,
|
||||
/// The title of the newly spawned [`Window`].
|
||||
title: String,
|
||||
/// The monitor on which to spawn the window. If `None`, will use monitor of the last window
|
||||
/// spawned.
|
||||
monitor: Option<MonitorHandle>,
|
||||
},
|
||||
/// An internal event for closing a window.
|
||||
CloseWindow(window::Id),
|
||||
/// An internal event for when the window has finished being created.
|
||||
WindowCreated {
|
||||
/// The internal ID of the window.
|
||||
id: window::Id,
|
||||
/// The raw window.
|
||||
window: winit::window::Window,
|
||||
/// Whether or not the window should close when a user requests it does.
|
||||
exit_on_close_request: bool,
|
||||
},
|
||||
}
|
||||
|
|
@ -771,7 +756,7 @@ async fn run_instance<A, E, C>(
|
|||
}
|
||||
|
||||
/// Builds a window's [`UserInterface`] for the [`Application`].
|
||||
pub fn build_user_interface<'a, A: Application>(
|
||||
fn build_user_interface<'a, A: Application>(
|
||||
application: &'a A,
|
||||
cache: user_interface::Cache,
|
||||
renderer: &mut A::Renderer,
|
||||
|
|
@ -795,7 +780,7 @@ where
|
|||
|
||||
/// Updates a multi-window [`Application`] by feeding it messages, spawning any
|
||||
/// resulting [`Command`], and tracking its [`Subscription`].
|
||||
pub fn update<A: Application, C, E: Executor>(
|
||||
fn update<A: Application, C, E: Executor>(
|
||||
application: &mut A,
|
||||
compositor: &mut C,
|
||||
runtime: &mut Runtime<E, Proxy<Event<A::Message>>, Event<A::Message>>,
|
||||
|
|
@ -834,7 +819,7 @@ pub fn update<A: Application, C, E: Executor>(
|
|||
}
|
||||
|
||||
/// Runs the actions of a [`Command`].
|
||||
pub fn run_command<A, C, E>(
|
||||
fn run_command<A, C, E>(
|
||||
application: &A,
|
||||
compositor: &mut C,
|
||||
command: Command<A::Message>,
|
||||
|
|
|
|||
|
|
@ -200,9 +200,7 @@ where
|
|||
/// window.
|
||||
///
|
||||
/// Normally, an [`Application`] should be synchronized with its [`State`]
|
||||
/// and window after calling [`Application::update`].
|
||||
///
|
||||
/// [`Application::update`]: crate::Program::update
|
||||
/// and window after calling [`State::update`].
|
||||
pub fn synchronize(
|
||||
&mut self,
|
||||
application: &A,
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ pub struct Settings<Flags> {
|
|||
/// communicate with it through the windowing system.
|
||||
pub id: Option<String>,
|
||||
|
||||
/// The [`Window`] settings.
|
||||
/// The [`window::Settings`].
|
||||
pub window: window::Settings,
|
||||
|
||||
/// The data needed to initialize an [`Application`].
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue