summaryrefslogtreecommitdiffstats
path: root/glow/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:46:17 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:46:17 +0200
commitb9d42a45a8ce491e5fa21a86db0799bcd731d0dd (patch)
tree2c41c7765810486b665fa10aa22ed53001f06f5c /glow/src/lib.rs
parent2ca7e3c4b0cb293adebf9a9bf9a26191069d495d (diff)
downloadiced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.tar.gz
iced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.tar.bz2
iced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.zip
Write documentation for `iced_glow`
Diffstat (limited to 'glow/src/lib.rs')
-rw-r--r--glow/src/lib.rs17
1 files changed, 11 insertions, 6 deletions
diff --git a/glow/src/lib.rs b/glow/src/lib.rs
index a32c787e..9e9564ca 100644
--- a/glow/src/lib.rs
+++ b/glow/src/lib.rs
@@ -1,7 +1,10 @@
-//#![deny(missing_docs)]
+//! A [`glow`] renderer for [`iced_native`].
+//!
+//! [`glow`]: https://github.com/grovesNL/glow
+//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native
+#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![deny(unused_results)]
-//#![forbid(unsafe_code)]
#![forbid(rust_2018_idioms)]
mod backend;
@@ -19,15 +22,17 @@ pub use settings::Settings;
pub(crate) use backend::Backend;
pub(crate) use iced_graphics::Transformation;
-pub type Renderer = iced_graphics::Renderer<Backend>;
-
#[doc(no_inline)]
pub use widget::*;
-pub type Element<'a, Message> = iced_native::Element<'a, Message, Renderer>;
-
pub use iced_graphics::Viewport;
pub use iced_native::{
Background, Color, Command, HorizontalAlignment, Length, Vector,
VerticalAlignment,
};
+
+/// A [`glow`] graphics renderer for [`iced`].
+///
+/// [`glow`]: https://github.com/grovesNL/glow
+/// [`iced`]: https://github.com/hecrj/iced
+pub type Renderer = iced_graphics::Renderer<Backend>;