Skip to content

Commit 3d77d51

Browse files
committed
Fix correct method names.
Add parameter names.
1 parent f534161 commit 3d77d51

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/easeljs/geom/Point.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ this.createjs = this.createjs||{};
102102
/**
103103
* Offsets the Point object by the specified amount. The value of dx is added to the original value of x to create the new x value. The value of dy is added to the original value of y to create the new y value.
104104
* @method offset
105-
* @param {Number} The amount by which to offset the horizontal coordinate, x.
106-
* @param {Number} The amount by which to offset the vertical coordinate, y.
105+
* @param {Number} dx The amount by which to offset the horizontal coordinate, x.
106+
* @param {Number} dy The amount by which to offset the vertical coordinate, y.
107107
* @return {Point} This instance. Useful for chaining method calls.
108108
* @chainable
109109
*/
@@ -115,9 +115,9 @@ this.createjs = this.createjs||{};
115115

116116
/**
117117
* Converts a pair of polar coordinates to a Cartesian point coordinate.
118-
* @method offset
119-
* @param {Number} The length coordinate of the polar pair.
120-
* @param {Number} The angle, in radians, of the polar pair.
118+
* @method polar
119+
* @param {Number} len The length coordinate of the polar pair.
120+
* @param {Number} angle The angle, in radians, of the polar pair.
121121
* @param {Point | Object} [pt] An object to copy the result into. If omitted a generic object with x/y properties will be returned.
122122
* @return {Point} The new, interpolated point.
123123
* @chainable
@@ -131,10 +131,10 @@ this.createjs = this.createjs||{};
131131

132132
/**
133133
* Determines a point between two specified points. The parameter `f` determines where the new interpolated point is located relative to the two end points specified by parameters `pt1` and `pt2`. The closer the value of the parameter `f` is to 1.0, the closer the interpolated point is to the first point (parameter `pt1`). The closer the value of the parameter `f` is to 0, the closer the interpolated point is to the second point (parameter `pt2`).
134-
* @method offset
135-
* @param {Point | Object} The first point as a Point or generic object.
136-
* @param {Point | Object} The second point as a Point or generic object.
137-
* @param {Number} The level of interpolation between the two points. Indicates where the new point will be, along the line between `pt1` and `pt2`. If `f=1`, `pt1` is returned; if `f=0`, `pt2` is returned.
134+
* @method interpolate
135+
* @param {Point | Object} pt1 The first point as a Point or generic object.
136+
* @param {Point | Object} pt2 The second point as a Point or generic object.
137+
* @param {Number} f The level of interpolation between the two points. Indicates where the new point will be, along the line between `pt1` and `pt2`. If `f=1`, `pt1` is returned; if `f=0`, `pt2` is returned.
138138
* @param {Point | Object} [pt] An object to copy the result into. If omitted a generic object with x/y properties will be returned.
139139
* @return {Point} The new, interpolated point.
140140
* @chainable

0 commit comments

Comments
 (0)