diff options
author | 2020-11-06 02:25:56 +0100 | |
---|---|---|
committer | 2020-11-06 02:25:56 +0100 | |
commit | 631c9e4a215d8f044d76ea926117f9a9bdd24d5d (patch) | |
tree | 09ea9710e2f62634aab519836f65cd26b17a8b00 /winit/src/application.rs | |
parent | e966cd5b591d8014e53f414014cb49deffef535d (diff) | |
download | iced-631c9e4a215d8f044d76ea926117f9a9bdd24d5d.tar.gz iced-631c9e4a215d8f044d76ea926117f9a9bdd24d5d.tar.bz2 iced-631c9e4a215d8f044d76ea926117f9a9bdd24d5d.zip |
Write missing documentation in `iced_winit`
Diffstat (limited to 'winit/src/application.rs')
-rw-r--r-- | winit/src/application.rs | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/winit/src/application.rs b/winit/src/application.rs index 8e97706f..c1d86471 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -377,8 +377,10 @@ async fn run_instance<A, E, C>( drop(ManuallyDrop::into_inner(user_interface)); } -/// Returns true if the provided event should cause the [`Application`] to +/// Returns true if the provided event should cause an [`Application`] to /// exit. +/// +/// [`Application`]: trait.Application.html pub fn requests_exit( event: &winit::event::WindowEvent<'_>, _modifiers: winit::event::ModifiersState, @@ -401,6 +403,12 @@ pub fn requests_exit( } } +/// Builds a [`UserInterface`] for the provided [`Application`], logging +/// [`Debug`] information accordingly. +/// +/// [`UserInterface`]: struct.UserInterface.html +/// [`Application`]: trait.Application.html +/// [`Debug`]: struct.Debug.html pub fn build_user_interface<'a, A: Application>( application: &'a mut A, cache: Cache, @@ -419,6 +427,12 @@ pub fn build_user_interface<'a, A: Application>( user_interface } +/// Updates an [`Application`] by feeding it the provided messages, spawning any +/// resulting [`Command`], and tracking its [`Subscription`]. +/// +/// [`Application`]: trait.Application.html +/// [`Command`]: struct.Command.html +/// [`Subscription`]: struct.Subscription.html pub fn update<A: Application, E: Executor>( application: &mut A, runtime: &mut Runtime<E, Proxy<A::Message>, A::Message>, |