scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-20 22:39:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Reformat documentation comments and change wording to follow existing documentation convention.

Browse source
This commit is contained in:
Jürg Lehni 2014-02-19 15:46:57 +01:00
parent 19d84a8a8d
commit 8726a3f082
1 changed files with 14 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/path/PathItem.js
View file

@ -262,12 +262,11 @@ var PathItem = Item.extend(/** @lends PathItem# */{
* Returns the winding contribution of the given point with respect to this * Returns the winding contribution of the given point with respect to this
* PathItem. * PathItem.
* *
* @param {Object} point Point to determine the winding direction * @param {Point} point the location for which to determine the winding
* about. * direction
* @param {Boolean} horizontal Boolean value indicating if we need to * @param {Boolean} horizontal wether we need to consider this point as
* consider this point as part of a * part of a horizontal curve
* horizontal curve. * @return {Number} the winding number
* @return {Number} Winding number.
*/ */
_getWinding: function(point, horizontal) { _getWinding: function(point, horizontal) {
return PathItem._getWinding(point, this._getMonotoneCurves(), return PathItem._getWinding(point, this._getMonotoneCurves(),
@ -296,7 +295,7 @@ var PathItem = Item.extend(/** @lends PathItem# */{
* Private method for splitting a PathItem at the given intersections. * Private method for splitting a PathItem at the given intersections.
* The routine works for both self intersections and intersections * The routine works for both self intersections and intersections
* between PathItems. * between PathItems.
* @param {Array} intersections Array of CurveLocation objects * @param {CurveLocation[]} intersections Array of CurveLocation objects
*/ */
_splitPath: function(intersections) { _splitPath: function(intersections) {
var loc, i, j, node1, node2, t, segment, var loc, i, j, node1, node2, t, segment,
@ -455,16 +454,15 @@ var PathItem = Item.extend(/** @lends PathItem# */{
/** /**
* Private method to trace closed contours from a set of segments according * Private method to trace closed contours from a set of segments according
* to a set of constraints —winding contribution and a custom operator. * to a set of constraints—winding contribution and a custom operator.
* *
* @param {Array} segments Array of 'seed' segments for tracing closed * @param {Segment[]} segments Array of 'seed' segments for tracing closed
* contours. * contours
* @param {Function} operator A function. It must take one argument, which * @param {Function} the operator function that receives as argument the
* is the winding number contribution of a * winding number contribution of a curve and returns a boolean value
* curve, and should return a boolean value * indicating whether the curve should be included in the final contour or
* indicating whether the curve should be * not
* included in the final contour or not. * @return {Path[]} the contours traced
* @return {Array} Array of contours traced.
*/ */
_tracePaths: function(segments, operator, selfIx) { _tracePaths: function(segments, operator, selfIx) {
// Utility function. Correctly returns entry and exit tangents of an // Utility function. Correctly returns entry and exit tangents of an