Clean up some JSDoc comments.

This commit is contained in:
Jürg Lehni 2011-11-12 13:27:29 +01:00
parent b1332331b0
commit 24f07dccec
4 changed files with 27 additions and 32 deletions

View file

@ -36,8 +36,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
* Describes the type of the hit result. For example, if you hit a segment * Describes the type of the hit result. For example, if you hit a segment
* point, the type would be 'segment'. * point, the type would be 'segment'.
* *
* @property
* @name HitResult#type * @name HitResult#type
* @property
* @type String('segment', 'handle-in', 'handle-out', 'stroke', 'fill', * @type String('segment', 'handle-in', 'handle-out', 'stroke', 'fill',
* 'bounds', 'center', 'pixel') * 'bounds', 'center', 'pixel')
*/ */
@ -46,8 +46,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
* If the HitResult has a {@link HitResult#type} of 'bounds', this property * If the HitResult has a {@link HitResult#type} of 'bounds', this property
* describes which corner of the bounding rectangle was hit. * describes which corner of the bounding rectangle was hit.
* *
* @property
* @name HitResult#name * @name HitResult#name
* @property
* @type String('top-left', 'top-right', 'bottom-left', 'bottom-right', * @type String('top-left', 'top-right', 'bottom-left', 'bottom-right',
* 'left-center', 'top-center', 'right-center', 'bottom-center') * 'left-center', 'top-center', 'right-center', 'bottom-center')
*/ */
@ -55,8 +55,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
/** /**
* The item that was hit. * The item that was hit.
* *
* @property
* @name HitResult#item * @name HitResult#item
* @property
* @type Item * @type Item
*/ */
@ -64,8 +64,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
* If the HitResult has a type of 'stroke', this property gives more * If the HitResult has a type of 'stroke', this property gives more
* information about the exact position that was hit on the path. * information about the exact position that was hit on the path.
* *
* @property
* @name HitResult#location * @name HitResult#location
* @property
* @type CurveLocation * @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 * If the HitResult has a type of 'pixel', this property refers to the color
* of the pixel on the {@link Raster} that was hit. * of the pixel on the {@link Raster} that was hit.
* *
* @property
* @name HitResult#color * @name HitResult#color
* @property
* @type RgbColor * @type RgbColor
*/ */
@ -83,8 +83,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
* 'handle-out', this property refers to the Segment that was hit or that * 'handle-out', this property refers to the Segment that was hit or that
* is closest to the hitResult.location on the curve. * is closest to the hitResult.location on the curve.
* *
* @property
* @name HitResult#segment * @name HitResult#segment
* @property
* @type Segment * @type Segment
*/ */
@ -92,8 +92,8 @@ HitResult = Base.extend(/** @lends HitResult# */{
* Describes the actual coordinates of the segment, handle or bounding box * Describes the actual coordinates of the segment, handle or bounding box
* corner that was hit. * corner that was hit.
* *
* @property
* @name HitResult#point * @name HitResult#point
* @property
* @type Point * @type Point
*/ */

View file

@ -735,8 +735,6 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
* {@link Item#guide} set to {@code true}. * {@link Item#guide} set to {@code true}.
* <b>options.selected:</b> {@code Boolean} - Only hit selected items. * <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 {Point} point The point where the hit test should be performed
* @param {Object} [options={ fill: true, stroke: true, segments: true, * @param {Object} [options={ fill: true, stroke: true, segments: true,
* tolerance: 2 }] * tolerance: 2 }]
@ -989,15 +987,12 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
* @function * @function
* @return {Item[]} an array containing the removed items * @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 * Removes the children from the specified {@code from} index to the
* {@code to} index from the parent's {@link #children} array. * {@code to} index from the parent's {@link #children} array.
* *
* @name Item#removeChildren
* @function
* @param {Number} from the beginning index, inclusive * @param {Number} from the beginning index, inclusive
* @param {Number} [to=children.length] the ending index, exclusive * @param {Number} [to=children.length] the ending index, exclusive
* @return {Item[]} an array containing the removed items * @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. * The color of the stroke.
* *
* @property
* @name Item#strokeColor * @name Item#strokeColor
* @property
* @type RgbColor|HsbColor|HslColor|GrayColor * @type RgbColor|HsbColor|HslColor|GrayColor
* *
* @example {@paperscript} * @example {@paperscript}
@ -1307,8 +1302,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
/** /**
* The width of the stroke. * The width of the stroke.
* *
* @property
* @name Item#strokeWidth * @name Item#strokeWidth
* @property
* @type Number * @type Number
* *
* @example {@paperscript} * @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 * The shape to be used at the end of open {@link Path} items, when they
* have a stroke. * have a stroke.
* *
* @property
* @name Item#strokeCap * @name Item#strokeCap
* @property
* @default 'butt' * @default 'butt'
* @type String('round', 'square', '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. * The shape to be used at the corners of paths when they have a stroke.
* *
* @property
* @name Item#strokeJoin * @name Item#strokeJoin
* @property
* @default 'miter' * @default 'miter'
* @type String ('miter', 'round', 'bevel') * @type String ('miter', 'round', 'bevel')
* *
@ -1391,8 +1386,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
/** /**
* The dash offset of the stroke. * The dash offset of the stroke.
* *
* @property
* @name Item#dashOffset * @name Item#dashOffset
* @property
* @default 0 * @default 0
* @type Number * @type Number
*/ */
@ -1408,8 +1403,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
* // Set the dashed stroke to [10pt dash, 4pt gap]: * // Set the dashed stroke to [10pt dash, 4pt gap]:
* path.dashArray = [10, 4]; * path.dashArray = [10, 4];
* *
* @property
* @name Item#dashArray * @name Item#dashArray
* @property
* @default [] * @default []
* @type Array * @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 * miterLimit imposes a limit on the ratio of the miter length to the
* {@link Item#strokeWidth}. * {@link Item#strokeWidth}.
* *
* @property
* @default 10 * @default 10
* @property
* @name Item#miterLimit * @name Item#miterLimit
* @type Number * @type Number
*/ */
@ -1433,8 +1428,8 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
* *
* The fill color of the item. * The fill color of the item.
* *
* @property
* @name Item#fillColor * @name Item#fillColor
* @property
* @type RgbColor|HsbColor|HslColor|GrayColor * @type RgbColor|HsbColor|HslColor|GrayColor
* *
* @example {@paperscript} * @example {@paperscript}

View file

@ -75,8 +75,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
* *
* The color of the stroke. * The color of the stroke.
* *
* @property
* @name PathStyle#strokeColor * @name PathStyle#strokeColor
* @property
* @type RgbColor|HsbColor|HslColor|GrayColor * @type RgbColor|HsbColor|HslColor|GrayColor
* *
* @example {@paperscript} * @example {@paperscript}
@ -93,8 +93,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
/** /**
* The width of the stroke. * The width of the stroke.
* *
* @property
* @name PathStyle#strokeWidth * @name PathStyle#strokeWidth
* @property
* @default 1 * @default 1
* @type Number * @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 * The shape to be used at the end of open {@link Path} items, when they
* have a stroke. * have a stroke.
* *
* @property
* @name PathStyle#strokeCap * @name PathStyle#strokeCap
* @property
* @default 'butt' * @default 'butt'
* @type String('round', 'square', '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. * The shape to be used at the corners of paths when they have a stroke.
* *
* @property
* @name PathStyle#strokeJoin * @name PathStyle#strokeJoin
* @property
* @default 'miter' * @default 'miter'
* @type String ('miter', 'round', 'bevel') * @type String ('miter', 'round', 'bevel')
* *
@ -177,8 +177,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
/** /**
* The dash offset of the stroke. * The dash offset of the stroke.
* *
* @property
* @name PathStyle#dashOffset * @name PathStyle#dashOffset
* @property
* @default 0 * @default 0
* @type Number * @type Number
*/ */
@ -194,8 +194,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
* // Set the dashed stroke to [10pt dash, 4pt gap]: * // Set the dashed stroke to [10pt dash, 4pt gap]:
* path.dashArray = [10, 4]; * path.dashArray = [10, 4];
* *
* @property
* @name PathStyle#dashArray * @name PathStyle#dashArray
* @property
* @default [] * @default []
* @type Array * @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 * far beyond the {@link #strokeWidth} of the path. The miterLimit imposes a
* limit on the ratio of the miter length to the {@link #strokeWidth}. * limit on the ratio of the miter length to the {@link #strokeWidth}.
* *
* @name PathStyle#miterLimit
* @property * @property
* @default 10 * @default 10
* @name PathStyle#miterLimit
* @type Number * @type Number
*/ */
@ -218,8 +218,8 @@ var PathStyle = this.PathStyle = Style.extend(/** @lends PathStyle# */{
* *
* The fill color. * The fill color.
* *
* @property
* @name PathStyle#fillColor * @name PathStyle#fillColor
* @property
* @type RgbColor|HsbColor|HslColor|GrayColor * @type RgbColor|HsbColor|HslColor|GrayColor
* *
* @example {@paperscript} * @example {@paperscript}

View file

@ -424,8 +424,8 @@ var View = this.View = PaperScopeItem.extend(Callback, /** @lends View# */{
* path.rotate(3); * path.rotate(3);
* } * }
* *
* @property
* @name View#onFrame * @name View#onFrame
* @property
* @type Function * @type Function
*/ */
@ -444,8 +444,8 @@ var View = this.View = PaperScopeItem.extend(Callback, /** @lends View# */{
* path.position = view.center; * path.position = view.center;
* } * }
* *
* @property
* @name View#onResize * @name View#onResize
* @property
* @type Function * @type Function
*/ */
}, { }, {