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

Some more documentation work.

Browse source
This commit is contained in:
Jürg Lehni 2015-12-27 20:04:26 +01:00
parent 8967193bb9
commit d67796f655
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/path/PathItem.js
View file

@ -13,8 +13,8 @@
/** /**
* @name PathItem * @name PathItem
* *
* @class The PathItem class is the base for any items that describe paths * @class The PathItem class is the base for any items that describe paths and
* and offer standardised methods for drawing and path manipulation, such as * offer standardised methods for drawing and path manipulation, such as
* {@link Path} and {@link CompoundPath}. * {@link Path} and {@link CompoundPath}.
* *
* @extends Item * @extends Item
@ -33,8 +33,8 @@ var PathItem = Item.extend(/** @lends PathItem# */{
* *
* @param {PathItem} path the other item to find the intersections with * @param {PathItem} path the other item to find the intersections with
* @param {Function} [include] a callback function that can be used to * @param {Function} [include] a callback function that can be used to
* filter out undesired locations right while they are collected. * filter out undesired locations right while they are collected. When
* When defined, it shall return {@true to include a location}. * defined, it shall return {@true to include a location}.
* @return {CurveLocation[]} the locations of all intersection between the * @return {CurveLocation[]} the locations of all intersection between the
* paths * paths
* @see #getCrossings(path) * @see #getCrossings(path)
@ -546,8 +546,8 @@ var PathItem = Item.extend(/** @lends PathItem# */{
// DOCS: PathItem#arcTo(to, radius, rotation, clockwise, large) // DOCS: PathItem#arcTo(to, radius, rotation, clockwise, large)
/** /**
* Closes the path. When closed, Paper.js connects the first and * Closes the path. When closed, Paper.js connects the first and last
* last segment of the path with an additional curve. * segment of the path with an additional curve.
* *
* @name PathItem#closePath * @name PathItem#closePath
* @function * @function
@ -560,8 +560,8 @@ var PathItem = Item.extend(/** @lends PathItem# */{
* {@grouptitle Relative Drawing Commands} * {@grouptitle Relative Drawing Commands}
* *
* If called on a {@link CompoundPath}, a new {@link Path} is created as a * If called on a {@link CompoundPath}, a new {@link Path} is created as a
* child and a point is added as its first segment relative to the * child and a point is added as its first segment relative to the position
* position of the last segment of the current path. * of the last segment of the current path.
* *
* @name PathItem#moveBy * @name PathItem#moveBy
* @function * @function