summaryrefslogtreecommitdiffstats
path: root/src/element.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-29 00:58:42 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-29 00:58:42 +0200
commit268a5f00171820ff1d3da7de03b5efab5e45c01d (patch)
treedec80ca85cd0edad458ab7bd24913f6a408a60e5 /src/element.rs
parent51050fc45ce0e84e40ab801deefe35baf4ee3c2c (diff)
downloadiced-268a5f00171820ff1d3da7de03b5efab5e45c01d.tar.gz
iced-268a5f00171820ff1d3da7de03b5efab5e45c01d.tar.bz2
iced-268a5f00171820ff1d3da7de03b5efab5e45c01d.zip
Write documentation for `UserInterface`
Diffstat (limited to 'src/element.rs')
-rw-r--r--src/element.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/element.rs b/src/element.rs
index 6bc0ad74..ca9d420b 100644
--- a/src/element.rs
+++ b/src/element.rs
@@ -4,10 +4,14 @@ use crate::{Event, Hasher, Layout, MouseCursor, Node, Point, Widget};
/// A generic [`Widget`].
///
-/// If you have a widget, you should be able to use `widget.into()` to turn it
-/// into an [`Element`].
+/// It is useful to build composable user interfaces that do not leak
+/// implementation details in their __view logic__.
///
-/// [`Widget`]: trait.Widget.html
+/// If you have a [built-in widget], you should be able to use `Into<Element>`
+/// to turn it into an [`Element`].
+///
+/// [built-in widget]: widget/index.html#built-in-widgets
+/// [`Widget`]: widget/trait.Widget.html
/// [`Element`]: struct.Element.html
pub struct Element<'a, Message, Renderer> {
pub(crate) widget: Box<dyn Widget<Message, Renderer> + 'a>,