From d3553adf278e5b616fbd885f321faa83a4d24b56 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 18 Nov 2019 07:16:19 +0100 Subject: Write documentation for `iced_core` --- core/src/lib.rs | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) (limited to 'core/src/lib.rs') diff --git a/core/src/lib.rs b/core/src/lib.rs index 3816f8a2..692e40d4 100644 --- a/core/src/lib.rs +++ b/core/src/lib.rs @@ -1,10 +1,22 @@ +//! The core library of [Iced]. +//! +//! This library holds basic types that can be reused and re-exported in +//! different runtime implementations. For instance, both [`iced_native`] and +//! [`iced_web`] are built on top of `iced_core`. +//! +//! [Iced]: https://github.com/hecrj/iced +//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +//! [`iced_web`]: https://github.com/hecrj/iced/tree/master/web +#![deny(missing_docs)] +#![deny(missing_debug_implementations)] +#![deny(unused_results)] +#![deny(unsafe_code)] +#![deny(rust_2018_idioms)] pub mod widget; mod align; mod background; mod color; -#[cfg(feature = "command")] -mod command; mod font; mod length; mod point; @@ -14,11 +26,15 @@ mod vector; pub use align::Align; pub use background::Background; pub use color::Color; -#[cfg(feature = "command")] -pub use command::Command; pub use font::Font; pub use length::Length; pub use point::Point; pub use rectangle::Rectangle; pub use vector::Vector; pub use widget::*; + +#[cfg(feature = "command")] +mod command; + +#[cfg(feature = "command")] +pub use command::Command; -- cgit