Skip to content

Commit 3646f21

Browse files
authored
Update arc.rs with improved documentation
added units and improved description to field comments of Arc and Ellipse structs.
1 parent cb8b70b commit 3646f21

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

  • graphics/src/geometry/path

graphics/src/geometry/path/arc.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ pub struct Arc {
88
pub center: Point,
99
/// The radius of the arc.
1010
pub radius: f32,
11-
/// The start of the segment's angle, clockwise rotation.
11+
/// The start of the segment's angle in radians, clockwise rotation from positive x-axis.
1212
pub start_angle: f32,
13-
/// The end of the segment's angle, clockwise rotation.
13+
/// The end of the segment's angle in radians, clockwise rotation from positive x-axis.
1414
pub end_angle: f32,
1515
}
1616

@@ -19,13 +19,13 @@ pub struct Arc {
1919
pub struct Elliptical {
2020
/// The center of the arc.
2121
pub center: Point,
22-
/// The radii of the arc's ellipse, defining its axes.
22+
/// The radii of the arc's ellipse. The horizontal and vertical half-dimensions of the ellipse will match the x and y values of the radii vector.
2323
pub radii: Vector,
24-
/// The rotation of the arc's ellipse.
24+
/// The clockwise rotation of the arc's ellipse.
2525
pub rotation: f32,
26-
/// The start of the segment's angle, clockwise rotation.
26+
/// The start of the segment's angle in radians, clockwise rotation from positive x-axis.
2727
pub start_angle: f32,
28-
/// The end of the segment's angle, clockwise rotation.
28+
/// The end of the segment's angle in radians, clockwise rotation from positive x-axis.
2929
pub end_angle: f32,
3030
}
3131

0 commit comments

Comments
 (0)