Update Svg documentation

This commit is contained in:
Héctor Ramón Jiménez 2019-12-15 06:28:44 +01:00
parent 09707f29fc
commit 6ba2461445
2 changed files with 13 additions and 6 deletions

View File

@ -1,4 +1,4 @@
//! Display an icon.
//! Display vector graphics in your application.
use crate::{layout, Element, Hasher, Layout, Length, Point, Size, Widget};
use std::{
@ -6,7 +6,14 @@ use std::{
path::{Path, PathBuf},
};
/// A simple icon_loader widget.
/// A vector graphics image.
///
/// An [`Svg`] image resizes smoothly without losing any quality.
///
/// [`Svg`] images can have a considerable rendering cost when resized,
/// specially when they are complex.
///
/// [`Svg`]: struct.Svg.html
#[derive(Debug, Clone)]
pub struct Svg {
handle: Handle,

View File

@ -81,16 +81,16 @@ pub mod widget {
}
pub mod svg {
//! Display icons in your user interface.
pub use iced_winit::svg::Svg;
//! Display vector graphics in your user interface.
pub use iced_winit::svg::{Handle, Svg};
}
pub use iced_winit::{Checkbox, Radio, Text};
#[doc(no_inline)]
pub use {
button::Button, image::Image, scrollable::Scrollable,
slider::Slider, svg::Svg, text_input::TextInput,
button::Button, image::Image, scrollable::Scrollable, slider::Slider,
svg::Svg, text_input::TextInput,
};
/// A container that distributes its contents vertically.