Merge pull request #252 from hecrj/improvement/documentation

Update and improve documentation

4 files changed, 9 insertions, 19 deletions

diff --git a/winit/CHANGELOG.md b/winit/CHANGELOG.md
deleted file mode 100644
index 1289a45a..00000000
--- a/winit/CHANGELOG.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [0.1.0-alpha] - 2019-11-25
-### Added
-- First release! :tada:
-
-[Unreleased]: https://github.com/hecrj/iced/compare/winit-0.1.0-alpha...HEAD
-[0.1.0-alpha]: https://github.com/hecrj/iced/releases/tag/winit-0.1.0-alpha
diff --git a/winit/Cargo.toml b/winit/Cargo.toml
index ca2018c7..a3b1613d 100644
--- a/winit/Cargo.toml
+++ b/winit/Cargo.toml
@@ -19,7 +19,7 @@ window_clipboard = "0.1"
 log = "0.4"
 
 [dependencies.iced_native]
-version = "0.1.0-alpha"
+version = "0.1.0"
 path = "../native"
 
 [target.'cfg(target_os = "windows")'.dependencies.winapi]
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,