mirror of
https://github.com/danbulant/appit
synced 2026-06-24 17:11:54 +00:00
Fixing doc references
This commit is contained in:
parent
0b1e41d1c5
commit
9f0b4a3c3e
1 changed files with 26 additions and 24 deletions
|
|
@ -71,12 +71,6 @@ impl<Message> Clone for Window<Message> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A builder for a window.
|
/// A builder for a window.
|
||||||
///
|
|
||||||
/// This type is similar to winit's
|
|
||||||
/// [`WindowBuilder`](winit::window::WindowBuilder), except that it only
|
|
||||||
/// supports the cross-platform interface. Support for additional
|
|
||||||
/// platform-specific settings may be possible as long as all types introduced
|
|
||||||
/// are `Send`.
|
|
||||||
pub struct WindowBuilder<'a, Behavior, Application, AppMessage>
|
pub struct WindowBuilder<'a, Behavior, Application, AppMessage>
|
||||||
where
|
where
|
||||||
Behavior: self::WindowBehavior<AppMessage>,
|
Behavior: self::WindowBehavior<AppMessage>,
|
||||||
|
|
@ -221,8 +215,8 @@ where
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// The only errors this funciton can return arise from
|
/// This function returns any error that winit may return from attempting to
|
||||||
/// [`winit::window::WindowBuilder::build`].
|
/// open a window.
|
||||||
pub fn open(mut self) -> Result<Option<Window<AppMessage::Window>>, winit::error::OsError> {
|
pub fn open(mut self) -> Result<Option<Window<AppMessage::Window>>, winit::error::OsError> {
|
||||||
// The window's thread shouldn't ever block for long periods of time. To
|
// The window's thread shouldn't ever block for long periods of time. To
|
||||||
// avoid a "frozen" window causing massive memory allocations, we'll use
|
// avoid a "frozen" window causing massive memory allocations, we'll use
|
||||||
|
|
@ -911,8 +905,10 @@ where
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Returns an [`EventLoopError`] upon the loop exiting due to an error. See
|
/// Returns an [`EventLoopError`](winit::error::EventLoopError) upon the
|
||||||
/// [`EventLoop::run`] for more information.
|
/// loop exiting due to an error. See
|
||||||
|
/// [`EventLoop::run`](winit::event_loop::EventLoop::run) for more
|
||||||
|
/// information.
|
||||||
fn run_with_event_callback(
|
fn run_with_event_callback(
|
||||||
app_callback: impl FnMut(AppMessage, ExecutingApp<'_, AppMessage>) -> AppMessage::Response
|
app_callback: impl FnMut(AppMessage, ExecutingApp<'_, AppMessage>) -> AppMessage::Response
|
||||||
+ 'static,
|
+ 'static,
|
||||||
|
|
@ -936,8 +932,10 @@ where
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Returns an [`EventLoopError`] upon the loop exiting due to an error. See
|
/// Returns an [`EventLoopError`](winit::error::EventLoopError) upon the
|
||||||
/// [`EventLoop::run`] for more information.
|
/// loop exiting due to an error. See
|
||||||
|
/// [`EventLoop::run`](winit::event_loop::EventLoop::run) for more
|
||||||
|
/// information.
|
||||||
fn run_with_context_and_event_callback(
|
fn run_with_context_and_event_callback(
|
||||||
context: Self::Context,
|
context: Self::Context,
|
||||||
app_callback: impl FnMut(AppMessage, ExecutingApp<'_, AppMessage>) -> AppMessage::Response
|
app_callback: impl FnMut(AppMessage, ExecutingApp<'_, AppMessage>) -> AppMessage::Response
|
||||||
|
|
@ -956,8 +954,8 @@ where
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// The only errors this funciton can return arise from
|
/// This function returns any error that winit may return from attempting to
|
||||||
/// [`winit::window::WindowBuilder::build`].
|
/// open a window.
|
||||||
fn open<App>(app: &mut App) -> Result<Option<Window<AppMessage::Window>>, OsError>
|
fn open<App>(app: &mut App) -> Result<Option<Window<AppMessage::Window>>, OsError>
|
||||||
where
|
where
|
||||||
App: AsApplication<AppMessage> + ?Sized,
|
App: AsApplication<AppMessage> + ?Sized,
|
||||||
|
|
@ -974,8 +972,8 @@ where
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// The only errors this funciton can return arise from
|
/// This function returns any error that winit may return from attempting to
|
||||||
/// [`winit::window::WindowBuilder::build`].
|
/// open a window.
|
||||||
fn open_with<App>(
|
fn open_with<App>(
|
||||||
app: &mut App,
|
app: &mut App,
|
||||||
context: Self::Context,
|
context: Self::Context,
|
||||||
|
|
@ -1030,8 +1028,8 @@ where
|
||||||
#[allow(unused_variables)]
|
#[allow(unused_variables)]
|
||||||
fn resized(&mut self, window: &mut RunningWindow<AppMessage>) {}
|
fn resized(&mut self, window: &mut RunningWindow<AppMessage>) {}
|
||||||
|
|
||||||
/// The window has been moved. [`RunningWindow::position()`] returns the
|
/// The window has been moved. [`RunningWindow::outer_position()`] returns
|
||||||
/// current position.
|
/// the current position.
|
||||||
#[allow(unused_variables)]
|
#[allow(unused_variables)]
|
||||||
fn moved(&mut self, window: &mut RunningWindow<AppMessage>) {}
|
fn moved(&mut self, window: &mut RunningWindow<AppMessage>) {}
|
||||||
|
|
||||||
|
|
@ -1187,15 +1185,17 @@ where
|
||||||
/// A runnable window.
|
/// A runnable window.
|
||||||
pub trait Run: WindowBehavior<()> {
|
pub trait Run: WindowBehavior<()> {
|
||||||
/// Runs a window with a default instance of this behavior's
|
/// Runs a window with a default instance of this behavior's
|
||||||
/// [`Context`](Self::Context).
|
/// [`Context`](WindowBehavior::Context).
|
||||||
///
|
///
|
||||||
/// This function is shorthand for creating a [`PendingApp`], opening this
|
/// This function is shorthand for creating a [`PendingApp`], opening this
|
||||||
/// window inside of it, and running the pending app.
|
/// window inside of it, and running the pending app.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Returns an [`EventLoopError`] upon the loop exiting due to an error. See
|
/// Returns an [`EventLoopError`](winit::error::EventLoopError) upon the
|
||||||
/// [`EventLoop::run`] for more information.
|
/// loop exiting due to an error. See
|
||||||
|
/// [`EventLoop::run`](winit::event_loop::EventLoop::run) for more
|
||||||
|
/// information.
|
||||||
fn run() -> Result<(), EventLoopError>
|
fn run() -> Result<(), EventLoopError>
|
||||||
where
|
where
|
||||||
Self::Context: Default,
|
Self::Context: Default,
|
||||||
|
|
@ -1205,15 +1205,17 @@ pub trait Run: WindowBehavior<()> {
|
||||||
app.run()
|
app.run()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Runs a window with the provided [`Context`](Self::Context).
|
/// Runs a window with the provided [`Context`](WindowBehavior::Context).
|
||||||
///
|
///
|
||||||
/// This function is shorthand for creating a [`PendingApp`], opening this
|
/// This function is shorthand for creating a [`PendingApp`], opening this
|
||||||
/// window inside of it, and running the pending app.
|
/// window inside of it, and running the pending app.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Returns an [`EventLoopError`] upon the loop exiting due to an error. See
|
/// Returns an [`EventLoopError`](winit::error::EventLoopError) upon the
|
||||||
/// [`EventLoop::run`] for more information.
|
/// loop exiting due to an error. See
|
||||||
|
/// [`EventLoop::run`](winit::event_loop::EventLoop::run) for more
|
||||||
|
/// information.
|
||||||
fn run_with(context: Self::Context) -> Result<(), EventLoopError> {
|
fn run_with(context: Self::Context) -> Result<(), EventLoopError> {
|
||||||
let mut app = PendingApp::new();
|
let mut app = PendingApp::new();
|
||||||
Self::open_with(&mut app, context).expect("error opening initial window");
|
Self::open_with(&mut app, context).expect("error opening initial window");
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue