Write documentation for the new overlay API

This commit is contained in:
Héctor Ramón Jiménez 2020-07-10 02:39:12 +02:00
parent dc0e423142
commit 2118a726f8
16 changed files with 205 additions and 27 deletions

View file

@ -24,7 +24,7 @@ impl<'a, Message, Renderer> Element<'a, Message, Renderer>
where
Renderer: crate::Renderer,
{
/// Create a new [`Element`] containing the given [`Widget`].
/// Creates a new [`Element`] containing the given [`Widget`].
///
/// [`Element`]: struct.Element.html
/// [`Widget`]: widget/trait.Widget.html
@ -273,6 +273,9 @@ where
self.widget.hash_layout(state);
}
/// Returns the overlay of the [`Element`], if there is any.
///
/// [`Element`]: struct.Element.html
pub fn overlay<'b>(
&'b mut self,
layout: Layout<'_>,