diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 22:14:39 +0100 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2019-11-22 22:14:48 +0100 |
| commit | 580891dda76f7e9174913eb75e3bee4261866d71 (patch) | |
| tree | 55226317e51fdb951b29c6ba7a056f9368ea939f /winit/src/lib.rs | |
| parent | 6a0e442ad68c2b104b7e91ef80798610a79aca6b (diff) | |
| download | iced-580891dda76f7e9174913eb75e3bee4261866d71.tar.gz iced-580891dda76f7e9174913eb75e3bee4261866d71.tar.bz2 iced-580891dda76f7e9174913eb75e3bee4261866d71.zip | |
Write docs for `iced_winit`
Diffstat (limited to 'winit/src/lib.rs')
| -rw-r--r-- | winit/src/lib.rs | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/winit/src/lib.rs b/winit/src/lib.rs index a708b1bd..0a2bf7dd 100644 --- a/winit/src/lib.rs +++ b/winit/src/lib.rs @@ -1,3 +1,26 @@ +//! A windowing shell for Iced, on top of [`winit`]. +//! +//!  +//! +//! `iced_winit` offers some convenient abstractions on top of [`iced_native`] +//! to quickstart development when using [`winit`]. +//! +//! It exposes a renderer-agnostic [`Application`] trait that can be implemented +//! and then run with a simple call. The use of this trait is optional. +//! +//! Additionally, a [`conversion`] module is available for users that decide to +//! implement a custom event loop. +//! +//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +//! [`winit`]: https://github.com/rust-windowing/winit +//! [`Application`]: trait.Application.html +//! [`conversion`]: conversion +#![deny(missing_docs)] +#![deny(missing_debug_implementations)] +#![deny(unused_results)] +#![deny(unsafe_code)] +#![deny(rust_2018_idioms)] + #[doc(no_inline)] pub use iced_native::*; pub use winit; |