Write documentation for iced_glow

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>;

glow/src/settings.rs

@@ -1,6 +1,4 @@
-//! Configure a [`Renderer`].
+//! Configure a renderer.
-//!
-//! [`Renderer`]: struct.Renderer.html
 pub use iced_graphics::Antialiasing;
 
 /// The settings of a [`Renderer`].

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>;

graphics/Cargo.toml

@@ -31,3 +31,7 @@ optional = true
 [dependencies.font-kit]
 version = "0.6"
 optional = true
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+all-features = true

wgpu/src/settings.rs

@@ -1,6 +1,4 @@
-//! Configure a [`Renderer`].
+//! Configure a renderer.
-//!
-//! [`Renderer`]: struct.Renderer.html
 pub use iced_graphics::Antialiasing;
 
 /// The settings of a [`Renderer`].