summaryrefslogtreecommitdiffstats
path: root/glutin
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 02:57:03 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 02:57:03 +0200
commit4aa0d7a13a6fbf04e3fa24c444d562c2f1085b5b (patch)
tree03824b7e98e27a31ee7d89aa27743c351f512740 /glutin
parentef28347f1c816d8ad9e772303467de489efb802b (diff)
downloadiced-4aa0d7a13a6fbf04e3fa24c444d562c2f1085b5b.tar.gz
iced-4aa0d7a13a6fbf04e3fa24c444d562c2f1085b5b.tar.bz2
iced-4aa0d7a13a6fbf04e3fa24c444d562c2f1085b5b.zip
Write documentation for `iced_glutin`
Diffstat (limited to 'glutin')
-rw-r--r--glutin/src/application.rs8
-rw-r--r--glutin/src/lib.rs16
2 files changed, 19 insertions, 5 deletions
diff --git a/glutin/src/application.rs b/glutin/src/application.rs
index 2e6f34af..c777a13b 100644
--- a/glutin/src/application.rs
+++ b/glutin/src/application.rs
@@ -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,
diff --git a/glutin/src/lib.rs b/glutin/src/lib.rs
index 829fe02a..b0e0bdd4 100644
--- a/glutin/src/lib.rs
+++ b/glutin/src/lib.rs
@@ -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;