Write documentation for iced_glutin

This commit is contained in:
Héctor Ramón Jiménez 2020-05-28 02:57:03 +02:00
parent ef28347f1c
commit 4aa0d7a13a
4 changed files with 23 additions and 7 deletions

View file

@ -1,12 +1,18 @@
//! Create interactive, native cross-platform applications.
use crate::{mouse, Executor, Runtime, Size};
use iced_graphics::window;
use iced_graphics::Viewport;
use iced_winit::application;
use iced_winit::conversion;
use iced_winit::{program, Clipboard, Debug, Proxy, Settings};
use iced_winit::{Clipboard, Debug, Proxy, Settings};
pub use iced_winit::Application;
pub use iced_winit::{program, Program};
/// Runs an [`Application`] with an executor, compositor, and the provided
/// settings.
///
/// [`Application`]: trait.Application.html
pub fn run<A, E, C>(
settings: Settings<A::Flags>,
compositor_settings: C::Settings,

View file

@ -1,15 +1,23 @@
//#![deny(missing_docs)]
//! A windowing shell for [`iced`], on top of [`glutin`].
//!
//! [`iced`]: https://github.com/hecrj/iced
//! [`glutin`]: https://github.com/rust-windowing/glutin
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![deny(unused_results)]
#![deny(unsafe_code)]
#![forbid(rust_2018_idioms)]
pub use glutin;
#[doc(no_inline)]
pub use iced_native::*;
pub mod application;
pub use application::Application;
pub use iced_winit::settings::{self, Settings};
pub use iced_winit::settings;
pub use iced_winit::Mode;
#[doc(no_inline)]
pub use application::Application;
#[doc(no_inline)]
pub use settings::Settings;