From 26a35b7d7e72ab8f685e75b0332bade1efef92d8 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Wed, 1 Apr 2020 00:25:33 +0200 Subject: Clarify return policy of `Application::run` --- winit/src/application.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'winit/src') diff --git a/winit/src/application.rs b/winit/src/application.rs index d5f957bf..37682901 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -100,8 +100,8 @@ pub trait Application: Sized { /// Runs the [`Application`] with the provided [`Settings`]. /// - /// This method will take control of the current thread and __will NOT - /// return__. + /// On native platforms, this method will take control of the current thread + /// and __will NOT return__. /// /// It should probably be that last thing you call in your `main` function. /// -- cgit From f5e7e0625eec96f96d9dcbe514198a82bd5a49ec Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Wed, 1 Apr 2020 04:35:24 +0200 Subject: Improve docs for `Sandbox` and `Application` --- winit/src/application.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'winit/src') diff --git a/winit/src/application.rs b/winit/src/application.rs index 37682901..fb02fdec 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -34,7 +34,7 @@ pub trait Application: Sized { type Flags; /// Initializes the [`Application`] with the flags provided to - /// [`run`] as part of the [`Settings`]: + /// [`run`] as part of the [`Settings`]. /// /// Here is where you should return the initial state of your app. /// -- cgit From 15aa40df40a169939aa3614b729d40fff10d6ac6 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Thu, 2 Apr 2020 03:21:34 +0200 Subject: Add missing link to `conversion::fullscreen` --- winit/src/conversion.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'winit/src') diff --git a/winit/src/conversion.rs b/winit/src/conversion.rs index debaf535..eaa26ace 100644 --- a/winit/src/conversion.rs +++ b/winit/src/conversion.rs @@ -90,7 +90,8 @@ pub fn window_event( /// Converts a [`Mode`] to a [`winit`] fullscreen mode. /// -/// [`Mode`]: +/// [`Mode`]: ../enum.Mode.html +/// [`winit`]: https://github.com/rust-windowing/winit pub fn fullscreen( monitor: winit::monitor::MonitorHandle, mode: Mode, -- cgit From 8c8325d0cf797f7ce69c2d9e0db83faa3d94d5f0 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Thu, 2 Apr 2020 03:33:30 +0200 Subject: Write documentation for the `debug` feature --- winit/src/application.rs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'winit/src') diff --git a/winit/src/application.rs b/winit/src/application.rs index fb02fdec..b974711c 100644 --- a/winit/src/application.rs +++ b/winit/src/application.rs @@ -12,6 +12,9 @@ use crate::{ /// /// An [`Application`](trait.Application.html) can execute asynchronous actions /// by returning a [`Command`](struct.Command.html) in some of its methods. +/// +/// When using an [`Application`] with the `debug` feature enabled, a debug view +/// can be toggled by pressing `F12`. pub trait Application: Sized { /// The graphics backend to use to draw the [`Application`]. /// -- cgit