diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-05-28 01:46:17 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2020-05-28 01:46:17 +0200 |
| commit | b9d42a45a8ce491e5fa21a86db0799bcd731d0dd (patch) | |
| tree | 2c41c7765810486b665fa10aa22ed53001f06f5c /glow | |
| parent | 2ca7e3c4b0cb293adebf9a9bf9a26191069d495d (diff) | |
| download | iced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.tar.gz iced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.tar.bz2 iced-b9d42a45a8ce491e5fa21a86db0799bcd731d0dd.zip | |
Write documentation for `iced_glow`
Diffstat (limited to 'glow')
| -rw-r--r-- | glow/src/lib.rs | 17 | ||||
| -rw-r--r-- | glow/src/settings.rs | 4 | ||||
| -rw-r--r-- | glow/src/widget.rs | 5 |
3 files changed, 17 insertions, 9 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>; diff --git a/glow/src/settings.rs b/glow/src/settings.rs index 07b36938..dce30029 100644 --- a/glow/src/settings.rs +++ b/glow/src/settings.rs @@ -1,6 +1,4 @@ -//! Configure a [`Renderer`]. -//! -//! [`Renderer`]: struct.Renderer.html +//! Configure a renderer. pub use iced_graphics::Antialiasing; /// The settings of a [`Renderer`]. diff --git a/glow/src/widget.rs b/glow/src/widget.rs index 362465f4..9968092b 100644 --- a/glow/src/widget.rs +++ b/glow/src/widget.rs @@ -48,6 +48,11 @@ pub use canvas::Canvas; pub use iced_native::{Image, Space}; +/// A container that distributes its contents vertically. pub type Column<'a, Message> = iced_native::Column<'a, Message, Renderer>; + +/// A container that distributes its contents horizontally. pub type Row<'a, Message> = iced_native::Row<'a, Message, Renderer>; + +/// A paragraph of text. pub type Text = iced_native::Text<Renderer>; |