From 9c067562fa765cfc49d09cd9b12fbba96d5619fa Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Tue, 18 Feb 2020 08:48:54 +0100
Subject: Write documentation for new `canvas` module

---
 wgpu/src/widget/canvas/stroke.rs | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'wgpu/src/widget/canvas/stroke.rs')

diff --git a/wgpu/src/widget/canvas/stroke.rs b/wgpu/src/widget/canvas/stroke.rs
index 9bb260b2..46d669c4 100644
--- a/wgpu/src/widget/canvas/stroke.rs
+++ b/wgpu/src/widget/canvas/stroke.rs
@@ -1,10 +1,16 @@
 use iced_native::Color;
 
+/// The style of a stroke.
 #[derive(Debug, Clone, Copy)]
 pub struct Stroke {
+    /// The color of the stroke.
     pub color: Color,
+    /// The distance between the two edges of the stroke.
     pub width: f32,
+    /// The shape to be used at the end of open subpaths when they are stroked.
     pub line_cap: LineCap,
+    /// The shape to be used at the corners of paths or basic shapes when they
+    /// are stroked.
     pub line_join: LineJoin,
 }
 
@@ -19,10 +25,16 @@ impl Default for Stroke {
     }
 }
 
+/// The shape used at the end of open subpaths when they are stroked.
 #[derive(Debug, Clone, Copy)]
 pub enum LineCap {
+    /// The stroke for each sub-path does not extend beyond its two endpoints.
     Butt,
+    /// At the end of each sub-path, the shape representing the stroke will be
+    /// extended by a square.
     Square,
+    /// At the end of each sub-path, the shape representing the stroke will be
+    /// extended by a semicircle.
     Round,
 }
 
@@ -42,10 +54,15 @@ impl From<LineCap> for lyon::tessellation::LineCap {
     }
 }
 
+/// The shape used at the corners of paths or basic shapes when they are
+/// stroked.
 #[derive(Debug, Clone, Copy)]
 pub enum LineJoin {
+    /// A sharp corner.
     Miter,
+    /// A round corner.
     Round,
+    /// A bevelled corner.
     Bevel,
 }
 
-- 
cgit