From a7dba612f03e58d7bd9527499d893987986b347c Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Fri, 22 Nov 2019 19:36:57 +0100 Subject: Write docs for `iced` and `iced_native` --- core/src/align.rs | 8 +------- core/src/command.rs | 2 +- core/src/lib.rs | 2 ++ 3 files changed, 4 insertions(+), 8 deletions(-) (limited to 'core') diff --git a/core/src/align.rs b/core/src/align.rs index 8b571db4..05bd5e63 100644 --- a/core/src/align.rs +++ b/core/src/align.rs @@ -1,10 +1,4 @@ -/// Alignment on the cross axis of a container. -/// -/// * On a [`Column`], it describes __horizontal__ alignment. -/// * On a [`Row`], it describes __vertical__ alignment. -/// -/// [`Column`]: widget/struct.Column.html -/// [`Row`]: widget/struct.Row.html +/// Alignment on an unspecified axis of a container. #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum Align { /// Align at the start of the cross axis. diff --git a/core/src/command.rs b/core/src/command.rs index 698105aa..14b48b5b 100644 --- a/core/src/command.rs +++ b/core/src/command.rs @@ -2,7 +2,7 @@ use futures::future::{BoxFuture, Future, FutureExt}; /// A collection of async operations. /// -/// You should be able to turn a future easily into a [`Command`], eiter by +/// You should be able to turn a future easily into a [`Command`], either by /// using the `From` trait or [`Command::perform`]. /// /// [`Command`]: struct.Command.html diff --git a/core/src/lib.rs b/core/src/lib.rs index 5a608fe8..6c36e683 100644 --- a/core/src/lib.rs +++ b/core/src/lib.rs @@ -4,6 +4,8 @@ //! different runtime implementations. For instance, both [`iced_native`] and //! [`iced_web`] are built on top of `iced_core`. //! +//! ![`iced_core` crate graph](https://github.com/hecrj/iced/blob/cae26cb7bc627f4a5b3bcf1cd023a0c552e8c65e/docs/graphs/core.png?raw=true) +//! //! [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 -- cgit