summaryrefslogtreecommitdiffstats
path: root/core/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-18 07:16:19 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-18 07:16:19 +0100
commitd3553adf278e5b616fbd885f321faa83a4d24b56 (patch)
tree5bbfba3b45fd34d9c9604f28bcbb80e9856873a3 /core/src/lib.rs
parent63dbf078fefea444073813e834c2d35fa25eb3a7 (diff)
downloadiced-d3553adf278e5b616fbd885f321faa83a4d24b56.tar.gz
iced-d3553adf278e5b616fbd885f321faa83a4d24b56.tar.bz2
iced-d3553adf278e5b616fbd885f321faa83a4d24b56.zip
Write documentation for `iced_core`
Diffstat (limited to 'core/src/lib.rs')
-rw-r--r--core/src/lib.rs24
1 files changed, 20 insertions, 4 deletions
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;