mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2024-12-29 09:22:22 -05:00
Docs: Fix wrong @link references to bean properties.
This commit is contained in:
parent
2290ec0ff6
commit
7dea96c6f2
14 changed files with 29 additions and 30 deletions
|
@ -123,10 +123,10 @@ var PaperScope = Base.extend(/** @lends PaperScope# */{
|
||||||
*
|
*
|
||||||
* @option [settings.insertItems=true] {Boolean} controls whether newly
|
* @option [settings.insertItems=true] {Boolean} controls whether newly
|
||||||
* created items are automatically inserted into the scene graph, by
|
* created items are automatically inserted into the scene graph, by
|
||||||
* adding them to {@link Project#getActiveLayer()}
|
* adding them to {@link Project#activeLayer}
|
||||||
* @option [settings.applyMatrix=true] {Boolean} controls what value newly
|
* @option [settings.applyMatrix=true] {Boolean} controls what value newly
|
||||||
* created items have their {@link Item#getApplyMatrix()} property set
|
* created items have their {@link Item#applyMatrix} property set to
|
||||||
* to (Note that not all items can set this to `false`)
|
* (Note that not all items can set this to `false`)
|
||||||
* @option [settings.handleSize=4] {Number} the size of the curve handles
|
* @option [settings.handleSize=4] {Number} the size of the curve handles
|
||||||
* when drawing selections
|
* when drawing selections
|
||||||
* @option [settings.hitTolerance=0] {Number} the default tolerance for hit-
|
* @option [settings.hitTolerance=0] {Number} the default tolerance for hit-
|
||||||
|
|
|
@ -268,7 +268,7 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getSymbolDefinitions()} instead.
|
* @deprecated use {@link #symbolDefinitions} instead.
|
||||||
*/
|
*/
|
||||||
getSymbols: 'getSymbolDefinitions',
|
getSymbols: 'getSymbolDefinitions',
|
||||||
|
|
||||||
|
|
|
@ -219,7 +219,7 @@ var Raster = Item.extend(/** @lends Raster# */{
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getResolution()} instead.
|
* @deprecated use {@link #resolution} instead.
|
||||||
*/
|
*/
|
||||||
getPpi: '#getResolution',
|
getPpi: '#getResolution',
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ var Shape = Item.extend(/** @lends Shape# */{
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getType()} instead.
|
* @deprecated use {@link #type} instead.
|
||||||
*/
|
*/
|
||||||
getShape: '#getType',
|
getShape: '#getType',
|
||||||
setShape: '#setType',
|
setShape: '#setType',
|
||||||
|
|
|
@ -122,7 +122,7 @@ var SymbolDefinition = Base.extend(/** @lends SymbolDefinition# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getItem()} instead.
|
* @deprecated use {@link #item} instead.
|
||||||
*/
|
*/
|
||||||
getDefinition: '#getItem',
|
getDefinition: '#getItem',
|
||||||
setDefinition: '#setItem',
|
setDefinition: '#setItem',
|
||||||
|
|
|
@ -103,7 +103,7 @@ var SymbolItem = Item.extend(/** @lends SymbolItem# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getDefinition()} instead.
|
* @deprecated use {@link #definition} instead.
|
||||||
*/
|
*/
|
||||||
getSymbol: '#getDefinition',
|
getSymbol: '#getDefinition',
|
||||||
setSymbol: '#setDefinition',
|
setSymbol: '#setDefinition',
|
||||||
|
|
|
@ -181,7 +181,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The first Segment contained within the compound-path, a short-cut to
|
* The first Segment contained within the compound-path, a short-cut to
|
||||||
* calling {@link Path#getFirstSegment()} on {@link Item#getFirstChild()}.
|
* calling {@link Path#firstSegment} on {@link Item#firstChild}.
|
||||||
*
|
*
|
||||||
* @bean
|
* @bean
|
||||||
* @type Segment
|
* @type Segment
|
||||||
|
@ -193,7 +193,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The last Segment contained within the compound-path, a short-cut to
|
* The last Segment contained within the compound-path, a short-cut to
|
||||||
* calling {@link Path#getLastSegment()} on {@link Item#getLastChild()}.
|
* calling {@link Path#lastChild} on {@link Item#lastChild}.
|
||||||
*
|
*
|
||||||
* @bean
|
* @bean
|
||||||
* @type Segment
|
* @type Segment
|
||||||
|
@ -220,7 +220,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The first Curve contained within the compound-path, a short-cut to
|
* The first Curve contained within the compound-path, a short-cut to
|
||||||
* calling {@link Path#getFirstCurve()} on {@link Item#getFirstChild()}.
|
* calling {@link Path#firstCurve} on {@link Item#firstChild}.
|
||||||
*
|
*
|
||||||
* @bean
|
* @bean
|
||||||
* @type Curve
|
* @type Curve
|
||||||
|
@ -232,7 +232,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The last Curve contained within the compound-path, a short-cut to
|
* The last Curve contained within the compound-path, a short-cut to
|
||||||
* calling {@link Path#getLastCurve()} on {@link Item#getLastChild()}.
|
* calling {@link Path#lastCurve} on {@link Item#lastChild}.
|
||||||
*
|
*
|
||||||
* @bean
|
* @bean
|
||||||
* @type Curve
|
* @type Curve
|
||||||
|
@ -244,7 +244,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The area that the compound-path's geometry is covering, calculated by
|
* The area that the compound-path's geometry is covering, calculated by
|
||||||
* getting th e{@link Path#getArea()} of each sub-path and it adding up.
|
* getting the {@link Path#area} of each sub-path and it adding up.
|
||||||
* Note that self-intersecting paths and sub-paths of different orientation
|
* Note that self-intersecting paths and sub-paths of different orientation
|
||||||
* can result in areas that cancel each other out.
|
* can result in areas that cancel each other out.
|
||||||
*
|
*
|
||||||
|
@ -261,7 +261,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The total length of all sub-paths in this compound-path, calculated by
|
* The total length of all sub-paths in this compound-path, calculated by
|
||||||
* getting the {@link Path#getLength()} of each sub-path and it adding up.
|
* getting the {@link Path#length} of each sub-path and it adding up.
|
||||||
*
|
*
|
||||||
* @bean
|
* @bean
|
||||||
* @type Number
|
* @type Number
|
||||||
|
|
|
@ -632,8 +632,7 @@ statics: /** @lends Curve */{
|
||||||
* Splits the specified curve values into curves that are monotone in the
|
* Splits the specified curve values into curves that are monotone in the
|
||||||
* specified coordinate direction.
|
* specified coordinate direction.
|
||||||
*
|
*
|
||||||
* @param {Number[]} v the curve values, as returned by
|
* @param {Number[]} v the curve values, as returned by {@link Curve#values}
|
||||||
* {@link Curve#getValues()}
|
|
||||||
* @param {Boolean} [dir=false] the direction in which the curves should be
|
* @param {Boolean} [dir=false] the direction in which the curves should be
|
||||||
* monotone, `false`: in x-direction, `true`: in y-direction
|
* monotone, `false`: in x-direction, `true`: in y-direction
|
||||||
* @return {Number[][]} an array of curve value arrays of the resulting
|
* @return {Number[][]} an array of curve value arrays of the resulting
|
||||||
|
|
|
@ -185,7 +185,7 @@ var CurveLocation = Base.extend(/** @lends CurveLocation# */{
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getTime()} instead.
|
* @deprecated use {@link #time} instead.
|
||||||
*/
|
*/
|
||||||
getParameter: '#getTime',
|
getParameter: '#getTime',
|
||||||
|
|
||||||
|
|
|
@ -453,8 +453,8 @@ PathItem.inject(new function() {
|
||||||
* @param {Point} point the location for which to determine the winding
|
* @param {Point} point the location for which to determine the winding
|
||||||
* contribution
|
* contribution
|
||||||
* @param {Curve[]} curves the curves that describe the shape against which
|
* @param {Curve[]} curves the curves that describe the shape against which
|
||||||
* to check, as returned by {@link Path#getCurves()} or
|
* to check, as returned by {@link Path#curves} or
|
||||||
* {@link CompoundPath#getCurves()}
|
* {@link CompoundPath#curves}
|
||||||
* @param {Boolean} [dir=false] the direction in which to determine the
|
* @param {Boolean} [dir=false] the direction in which to determine the
|
||||||
* winding contribution, `false`: in x-direction, `true`: in y-direction
|
* winding contribution, `false`: in x-direction, `true`: in y-direction
|
||||||
* @param {Boolean} [closed=false] determines how areas should be closed
|
* @param {Boolean} [closed=false] determines how areas should be closed
|
||||||
|
|
|
@ -127,7 +127,7 @@ var GradientStop = Base.extend(/** @lends GradientStop# */{
|
||||||
/**
|
/**
|
||||||
* @private
|
* @private
|
||||||
* @bean
|
* @bean
|
||||||
* @deprecated use {@link #getOffset()} instead.
|
* @deprecated use {@link #offset} instead.
|
||||||
*/
|
*/
|
||||||
getRampPoint: '#getOffset',
|
getRampPoint: '#getOffset',
|
||||||
setRampPoint: '#setOffset',
|
setRampPoint: '#setOffset',
|
||||||
|
|
|
@ -354,7 +354,7 @@ var Style = Base.extend(new function() {
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @private
|
* @private
|
||||||
* @deprecated use {@link #getFontFamily()} instead.
|
* @deprecated use {@link #fontFamily} instead.
|
||||||
*/
|
*/
|
||||||
getFont: '#getFontFamily',
|
getFont: '#getFontFamily',
|
||||||
setFont: '#setFontFamily',
|
setFont: '#setFontFamily',
|
||||||
|
|
|
@ -158,7 +158,7 @@ var TextItem = Item.extend(/** @lends TextItem# */{
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @private
|
* @private
|
||||||
* @deprecated use {@link #getStyle()} instead.
|
* @deprecated use {@link #style} instead.
|
||||||
*/
|
*/
|
||||||
getCharacterStyle: '#getStyle',
|
getCharacterStyle: '#getStyle',
|
||||||
setCharacterStyle: '#setStyle',
|
setCharacterStyle: '#setStyle',
|
||||||
|
@ -166,7 +166,7 @@ var TextItem = Item.extend(/** @lends TextItem# */{
|
||||||
/**
|
/**
|
||||||
* @bean
|
* @bean
|
||||||
* @private
|
* @private
|
||||||
* @deprecated use {@link #getStyle()} instead.
|
* @deprecated use {@link #style} instead.
|
||||||
*/
|
*/
|
||||||
getParagraphStyle: '#getStyle',
|
getParagraphStyle: '#getStyle',
|
||||||
setParagraphStyle: '#setStyle'
|
setParagraphStyle: '#setStyle'
|
||||||
|
|
|
@ -608,7 +608,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @name View#rotate
|
* @name View#rotate
|
||||||
* @function
|
* @function
|
||||||
* @param {Number} angle the rotation angle
|
* @param {Number} angle the rotation angle
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
* @see Matrix#rotate(angle[, center])
|
* @see Matrix#rotate(angle[, center])
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -619,7 +619,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @name View#scale
|
* @name View#scale
|
||||||
* @function
|
* @function
|
||||||
* @param {Number} scale the scale factor
|
* @param {Number} scale the scale factor
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* Scales the view by the given values from its center point, or optionally
|
* Scales the view by the given values from its center point, or optionally
|
||||||
|
@ -629,7 +629,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @function
|
* @function
|
||||||
* @param {Number} hor the horizontal scale factor
|
* @param {Number} hor the horizontal scale factor
|
||||||
* @param {Number} ver the vertical scale factor
|
* @param {Number} ver the vertical scale factor
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -639,7 +639,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @name View#shear
|
* @name View#shear
|
||||||
* @function
|
* @function
|
||||||
* @param {Point} shear the horziontal and vertical shear factors as a point
|
* @param {Point} shear the horziontal and vertical shear factors as a point
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
* @see Matrix#shear(shear[, center])
|
* @see Matrix#shear(shear[, center])
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
|
@ -650,7 +650,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @function
|
* @function
|
||||||
* @param {Number} hor the horizontal shear factor
|
* @param {Number} hor the horizontal shear factor
|
||||||
* @param {Number} ver the vertical shear factor
|
* @param {Number} ver the vertical shear factor
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
* @see Matrix#shear(hor, ver[, center])
|
* @see Matrix#shear(hor, ver[, center])
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -661,7 +661,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @name View#skew
|
* @name View#skew
|
||||||
* @function
|
* @function
|
||||||
* @param {Point} skew the horziontal and vertical skew angles in degrees
|
* @param {Point} skew the horziontal and vertical skew angles in degrees
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
* @see Matrix#shear(skew[, center])
|
* @see Matrix#shear(skew[, center])
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
|
@ -672,7 +672,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
|
||||||
* @function
|
* @function
|
||||||
* @param {Number} hor the horizontal skew angle in degrees
|
* @param {Number} hor the horizontal skew angle in degrees
|
||||||
* @param {Number} ver the vertical sskew angle in degrees
|
* @param {Number} ver the vertical sskew angle in degrees
|
||||||
* @param {Point} [center={@link View#getCenter()}]
|
* @param {Point} [center={@link View#center}]
|
||||||
* @see Matrix#shear(hor, ver[, center])
|
* @see Matrix#shear(hor, ver[, center])
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue