Reword some doc comments

This commit is contained in:
Laurenz 2021-05-19 00:33:50 +02:00
parent 118fc1014b
commit 1cb6328d20

View File

@ -41,7 +41,7 @@ impl Frame {
pub enum Element { pub enum Element {
/// Shaped text. /// Shaped text.
Text(Text), Text(Text),
/// A geometric shape. /// A filled geometric shape.
Geometry(Shape, Fill), Geometry(Shape, Fill),
/// A raster image. /// A raster image.
Image(ImageId, Size), Image(ImageId, Size),
@ -54,7 +54,7 @@ pub struct Text {
pub face_id: FaceId, pub face_id: FaceId,
/// The font size. /// The font size.
pub size: Length, pub size: Length,
/// The glyph fill color / texture. /// The glyph's fill color.
pub fill: Fill, pub fill: Fill,
/// The glyphs. /// The glyphs.
pub glyphs: Vec<Glyph>, pub glyphs: Vec<Glyph>,
@ -84,7 +84,7 @@ impl Text {
} }
} }
/// Some shape. /// A geometric shape.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum Shape { pub enum Shape {
/// A rectangle with its origin in the topleft corner. /// A rectangle with its origin in the topleft corner.
@ -95,9 +95,9 @@ pub enum Shape {
Path(Path), Path(Path),
} }
/// The kind of graphic fill to be applied to a [`Shape`]. /// How text and shapes are filled.
#[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)] #[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)]
pub enum Fill { pub enum Fill {
/// The fill is a color. /// A solid color.
Color(Color), Color(Color),
} }