add docstrings to path.go

This commit is contained in:
Stani 2015-07-08 10:53:35 +02:00
parent 437a88ccda
commit 33f067e4dd

24
path.go
View file

@ -3,25 +3,37 @@
package draw2d package draw2d
// Path describes the interface for path drawing.
type Path interface { type Path interface {
// Return the current point of the path // LastPoint returns the current point of the path
LastPoint() (x, y float64) LastPoint() (x, y float64)
// Create a new subpath that start at the specified point // MoveTo creates a new subpath that start at the specified point
MoveTo(x, y float64) MoveTo(x, y float64)
// Create a new subpath that start at the specified point // RMoveTo creates a new subpath that start at the specified point
// relative to the current point // relative to the current point
RMoveTo(dx, dy float64) RMoveTo(dx, dy float64)
// Add a line to the current subpath // LineTo adds a line to the current subpath
LineTo(x, y float64) LineTo(x, y float64)
// Add a line to the current subpath // RLineTo adds a line to the current subpath
// relative to the current point // relative to the current point
RLineTo(dx, dy float64) RLineTo(dx, dy float64)
// QuadCurveTo adds a quadratic Bézier curve to the current subpath
QuadCurveTo(cx, cy, x, y float64) QuadCurveTo(cx, cy, x, y float64)
// QuadCurveTo adds a quadratic Bézier curve to the current subpath
// relative to the current point
RQuadCurveTo(dcx, dcy, dx, dy float64) RQuadCurveTo(dcx, dcy, dx, dy float64)
// CubicCurveTo adds a cubic Bézier curve to the current subpath
CubicCurveTo(cx1, cy1, cx2, cy2, x, y float64) CubicCurveTo(cx1, cy1, cx2, cy2, x, y float64)
// RCubicCurveTo adds a cubic Bézier curve to the current subpath
// relative to the current point
RCubicCurveTo(dcx1, dcy1, dcx2, dcy2, dx, dy float64) RCubicCurveTo(dcx1, dcy1, dcx2, dcy2, dx, dy float64)
// ArcTo adds an arc to the current subpath
ArcTo(cx, cy, rx, ry, startAngle, angle float64) ArcTo(cx, cy, rx, ry, startAngle, angle float64)
// RArcTo adds an arc to the current subpath
// relative to the current point
RArcTo(dcx, dcy, rx, ry, startAngle, angle float64) RArcTo(dcx, dcy, rx, ry, startAngle, angle float64)
// Close creates a line from the current point to the last MoveTo
// point (if not the same) and mark the path as closed so the
// first and last lines join nicely.
Close() Close()
} }