Skip to content

Commit

Permalink
Add some documentation for drawPoints. (flutter#2843)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hixie authored and abarth committed Aug 2, 2016
1 parent 17ebc33 commit b66f005
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions flutter/lib/ui/painting.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1030,13 +1030,29 @@ enum VertexMode {
///
/// Used by [Canvas.drawPoints].
enum PointMode {
// Draw each point separately.
/// Draw each point separately.
///
/// If the [Paint.strokeCap] is [StrokeCat.round], then each point is drawn
/// as a circle with the diameter of the [Paint.strokeWidth], filled as
/// described by the [Paint] (ignoring [Paint.style]).
///
/// Otherwise, each point is drawn as an axis-aligned square with sides of
/// length [Paint.strokeWidth], filled as described by the [Paint] (ignoring
/// [Paint.style]).
points,

// Draw each sequence of two points as a line segment.
/// Draw each sequence of two points as a line segment.
///
/// If the number of points is odd, then the last point is ignored.
///
/// The lines are stroked as described by the [Paint] (ignoring
/// [Paint.style]).
lines,

// Draw the entire sequence of point as the vertices of a polygon.
/// Draw the entire sequence of point as one line.
///
/// The lines are stroked as described by the [Paint] (ignoring
/// [Paint.style]).
polygon,
}

Expand Down

0 comments on commit b66f005

Please sign in to comment.