diff options
| author |  Héctor Ramón <hector0193@gmail.com> | 2020-04-02 16:53:54 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2020-04-02 16:53:54 +0200 |
| commit | 3aafd2c1f7539806449b116fa98d6bf0fff94de8 (patch) | |
| tree | 727eb202e24d66836065e89c279d400c053563c0 /winit/src | |
| parent | 2fa6edf7a8b2a6e06b42ff9879fe81cbd1a957c6 (diff) | |
| parent | 4a498ed0e3d0526ce9f47b7eefa0b2716f9b27a8 (diff) | |
| download | iced-3aafd2c1f7539806449b116fa98d6bf0fff94de8.tar.gz iced-3aafd2c1f7539806449b116fa98d6bf0fff94de8.tar.bz2 iced-3aafd2c1f7539806449b116fa98d6bf0fff94de8.zip | |
Merge pull request #252 from hecrj/improvement/documentation
Update and improve documentation
Diffstat (limited to 'winit/src')
| -rw-r--r-- | winit/src/application.rs | 9 | ||||
| -rw-r--r-- | winit/src/conversion.rs | 3 |
2 files changed, 8 insertions, 4 deletions
diff --git a/winit/src/application.rs b/winit/src/application.rs index d5f957bf..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`]. /// @@ -34,7 +37,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. /// @@ -100,8 +103,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. /// 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, |