mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-05 20:32:00 -05:00
Clean up some JSDoc comments.
This commit is contained in:
parent
b1332331b0
commit
24f07dccec
4 changed files with 27 additions and 32 deletions
|
@ -36,8 +36,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* Describes the type of the hit result. For example, if you hit a segment
|
||||
* point, the type would be 'segment'.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#type
|
||||
* @property
|
||||
* @type String('segment', 'handle-in', 'handle-out', 'stroke', 'fill',
|
||||
* 'bounds', 'center', 'pixel')
|
||||
*/
|
||||
|
@ -46,8 +46,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* If the HitResult has a {@link HitResult#type} of 'bounds', this property
|
||||
* describes which corner of the bounding rectangle was hit.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#name
|
||||
* @property
|
||||
* @type String('top-left', 'top-right', 'bottom-left', 'bottom-right',
|
||||
* 'left-center', 'top-center', 'right-center', 'bottom-center')
|
||||
*/
|
||||
|
@ -55,8 +55,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
/**
|
||||
* The item that was hit.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#item
|
||||
* @property
|
||||
* @type Item
|
||||
*/
|
||||
|
||||
|
@ -64,8 +64,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* If the HitResult has a type of 'stroke', this property gives more
|
||||
* information about the exact position that was hit on the path.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#location
|
||||
* @property
|
||||
* @type CurveLocation
|
||||
*/
|
||||
|
||||
|
@ -73,8 +73,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* If the HitResult has a type of 'pixel', this property refers to the color
|
||||
* of the pixel on the {@link Raster} that was hit.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#color
|
||||
* @property
|
||||
* @type RgbColor
|
||||
*/
|
||||
|
||||
|
@ -83,8 +83,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* 'handle-out', this property refers to the Segment that was hit or that
|
||||
* is closest to the hitResult.location on the curve.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#segment
|
||||
* @property
|
||||
* @type Segment
|
||||
*/
|
||||
|
||||
|
@ -92,8 +92,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
|
|||
* Describes the actual coordinates of the segment, handle or bounding box
|
||||
* corner that was hit.
|
||||
*
|
||||
* @property
|
||||
* @name HitResult#point
|
||||
* @property
|
||||
* @type Point
|
||||
*/
|
||||
|
||||
|
|
|
@ -735,8 +735,6 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
* {@link Item#guide} set to {@code true}.
|
||||
* <b>options.selected:</b> {@code Boolean} - Only hit selected items.
|
||||
*
|
||||
* @name Item#hitTest
|
||||
* @function
|
||||
* @param {Point} point The point where the hit test should be performed
|
||||
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
||||
* tolerance: 2 }]
|
||||
|
@ -989,15 +987,12 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
* @function
|
||||
* @return {Item[]} an array containing the removed items
|
||||
*/
|
||||
/**
|
||||
* Removes all of the item's {@link #children} (if any).
|
||||
*
|
||||
* @return {Item[]} an array containing the removed items
|
||||
*/
|
||||
/**
|
||||
* Removes the children from the specified {@code from} index to the
|
||||
* {@code to} index from the parent's {@link #children} array.
|
||||
*
|
||||
* @name Item#removeChildren
|
||||
* @function
|
||||
* @param {Number} from the beginning index, inclusive
|
||||
* @param {Number} [to=children.length] the ending index, exclusive
|
||||
* @return {Item[]} an array containing the removed items
|
||||
|
@ -1289,8 +1284,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
*
|
||||
* The color of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name Item#strokeColor
|
||||
* @property
|
||||
* @type RgbColor|HsbColor|HslColor|GrayColor
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
@ -1307,8 +1302,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
/**
|
||||
* The width of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name Item#strokeWidth
|
||||
* @property
|
||||
* @type Number
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
@ -1329,8 +1324,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
* The shape to be used at the end of open {@link Path} items, when they
|
||||
* have a stroke.
|
||||
*
|
||||
* @property
|
||||
* @name Item#strokeCap
|
||||
* @property
|
||||
* @default 'butt'
|
||||
* @type String('round', 'square', 'butt')
|
||||
*
|
||||
|
@ -1361,8 +1356,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
/**
|
||||
* The shape to be used at the corners of paths when they have a stroke.
|
||||
*
|
||||
* @property
|
||||
* @name Item#strokeJoin
|
||||
* @property
|
||||
* @default 'miter'
|
||||
* @type String ('miter', 'round', 'bevel')
|
||||
*
|
||||
|
@ -1391,8 +1386,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
/**
|
||||
* The dash offset of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name Item#dashOffset
|
||||
* @property
|
||||
* @default 0
|
||||
* @type Number
|
||||
*/
|
||||
|
@ -1408,8 +1403,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
* // Set the dashed stroke to [10pt dash, 4pt gap]:
|
||||
* path.dashArray = [10, 4];
|
||||
*
|
||||
* @property
|
||||
* @name Item#dashArray
|
||||
* @property
|
||||
* @default []
|
||||
* @type Array
|
||||
*/
|
||||
|
@ -1422,8 +1417,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
* miterLimit imposes a limit on the ratio of the miter length to the
|
||||
* {@link Item#strokeWidth}.
|
||||
*
|
||||
* @property
|
||||
* @default 10
|
||||
* @property
|
||||
* @name Item#miterLimit
|
||||
* @type Number
|
||||
*/
|
||||
|
@ -1433,8 +1428,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
|
|||
*
|
||||
* The fill color of the item.
|
||||
*
|
||||
* @property
|
||||
* @name Item#fillColor
|
||||
* @property
|
||||
* @type RgbColor|HsbColor|HslColor|GrayColor
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
|
|
@ -75,8 +75,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
*
|
||||
* The color of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#strokeColor
|
||||
* @property
|
||||
* @type RgbColor|HsbColor|HslColor|GrayColor
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
@ -93,8 +93,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
/**
|
||||
* The width of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#strokeWidth
|
||||
* @property
|
||||
* @default 1
|
||||
* @type Number
|
||||
*
|
||||
|
@ -116,8 +116,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
* The shape to be used at the end of open {@link Path} items, when they
|
||||
* have a stroke.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#strokeCap
|
||||
* @property
|
||||
* @default 'butt'
|
||||
* @type String('round', 'square', 'butt')
|
||||
*
|
||||
|
@ -148,8 +148,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
/**
|
||||
* The shape to be used at the corners of paths when they have a stroke.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#strokeJoin
|
||||
* @property
|
||||
* @default 'miter'
|
||||
* @type String ('miter', 'round', 'bevel')
|
||||
*
|
||||
|
@ -177,8 +177,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
/**
|
||||
* The dash offset of the stroke.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#dashOffset
|
||||
* @property
|
||||
* @default 0
|
||||
* @type Number
|
||||
*/
|
||||
|
@ -194,8 +194,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
* // Set the dashed stroke to [10pt dash, 4pt gap]:
|
||||
* path.dashArray = [10, 4];
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#dashArray
|
||||
* @property
|
||||
* @default []
|
||||
* @type Array
|
||||
*/
|
||||
|
@ -207,9 +207,9 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
* far beyond the {@link #strokeWidth} of the path. The miterLimit imposes a
|
||||
* limit on the ratio of the miter length to the {@link #strokeWidth}.
|
||||
*
|
||||
* @name PathStyle#miterLimit
|
||||
* @property
|
||||
* @default 10
|
||||
* @name PathStyle#miterLimit
|
||||
* @type Number
|
||||
*/
|
||||
|
||||
|
@ -218,8 +218,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
|
|||
*
|
||||
* The fill color.
|
||||
*
|
||||
* @property
|
||||
* @name PathStyle#fillColor
|
||||
* @property
|
||||
* @type RgbColor|HsbColor|HslColor|GrayColor
|
||||
*
|
||||
* @example {@paperscript}
|
||||
|
|
|
@ -424,8 +424,8 @@ var View = this.View = PaperScopeItem.extend(Callback, /** @lends View# */{
|
|||
* path.rotate(3);
|
||||
* }
|
||||
*
|
||||
* @property
|
||||
* @name View#onFrame
|
||||
* @property
|
||||
* @type Function
|
||||
*/
|
||||
|
||||
|
@ -444,8 +444,8 @@ var View = this.View = PaperScopeItem.extend(Callback, /** @lends View# */{
|
|||
* path.position = view.center;
|
||||
* }
|
||||
*
|
||||
* @property
|
||||
* @name View#onResize
|
||||
* @property
|
||||
* @type Function
|
||||
*/
|
||||
}, {
|
||||
|
|
Loading…
Reference in a new issue