scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2024-12-28 00:42:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Fix wrong @link references to bean properties.

Browse source
This commit is contained in:
Jürg Lehni 2017-04-13 12:24:56 +02:00
parent 2290ec0ff6
commit 7dea96c6f2
14 changed files with 29 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/core/PaperScope.js
View file

@ -123,10 +123,10 @@ var PaperScope = Base.extend(/** @lends PaperScope# */{
*
* @option [settings.insertItems=true] {Boolean} controls whether newly
* 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
* created items have their {@link Item#getApplyMatrix()} property set
* to (Note that not all items can set this to `false`)
* created items have their {@link Item#applyMatrix} property set to
* (Note that not all items can set this to `false`)
* @option [settings.handleSize=4] {Number} the size of the curve handles
* when drawing selections
* @option [settings.hitTolerance=0] {Number} the default tolerance for hit-

2
src/item/Project.js
View file

@ -268,7 +268,7 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
/**
* @bean
* @deprecated use {@link #getSymbolDefinitions()} instead.
* @deprecated use {@link #symbolDefinitions} instead.
*/
getSymbols: 'getSymbolDefinitions',

2
src/item/Raster.js
View file

@ -219,7 +219,7 @@ var Raster = Item.extend(/** @lends Raster# */{
/**
* @private
* @bean
* @deprecated use {@link #getResolution()} instead.
* @deprecated use {@link #resolution} instead.
*/
getPpi: '#getResolution',

2
src/item/Shape.js
View file

@ -63,7 +63,7 @@ var Shape = Item.extend(/** @lends Shape# */{
/**
* @private
* @bean
* @deprecated use {@link #getType()} instead.
* @deprecated use {@link #type} instead.
*/
getShape: '#getType',
setShape: '#setType',

2
src/item/SymbolDefinition.js
View file

@ -122,7 +122,7 @@ var SymbolDefinition = Base.extend(/** @lends SymbolDefinition# */{
/**
* @bean
* @deprecated use {@link #getItem()} instead.
* @deprecated use {@link #item} instead.
*/
getDefinition: '#getItem',
setDefinition: '#setItem',

2
src/item/SymbolItem.js
View file

@ -103,7 +103,7 @@ var SymbolItem = Item.extend(/** @lends SymbolItem# */{
/**
* @bean
* @deprecated use {@link #getDefinition()} instead.
* @deprecated use {@link #definition} instead.
*/
getSymbol: '#getDefinition',
setSymbol: '#setDefinition',

12
src/path/CompoundPath.js
View file

@ -181,7 +181,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
/**
* 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
* @type Segment
@ -193,7 +193,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
/**
* 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
* @type Segment
@ -220,7 +220,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
/**
* 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
* @type Curve
@ -232,7 +232,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
/**
* 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
* @type Curve
@ -244,7 +244,7 @@ var CompoundPath = PathItem.extend(/** @lends CompoundPath# */{
/**
* 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
* 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
* 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
* @type Number

3
src/path/Curve.js
View file

@ -632,8 +632,7 @@ statics: /** @lends Curve */{
* Splits the specified curve values into curves that are monotone in the
* specified coordinate direction.
*
* @param {Number[]} v the curve values, as returned by
* {@link Curve#getValues()}
* @param {Number[]} v the curve values, as returned by {@link Curve#values}
* @param {Boolean} [dir=false] the direction in which the curves should be
* monotone, `false`: in x-direction, `true`: in y-direction
* @return {Number[][]} an array of curve value arrays of the resulting

2
src/path/CurveLocation.js
View file

@ -185,7 +185,7 @@ var CurveLocation = Base.extend(/** @lends CurveLocation# */{
/**
* @private
* @bean
* @deprecated use {@link #getTime()} instead.
* @deprecated use {@link #time} instead.
*/
getParameter: '#getTime',

4
src/path/PathItem.Boolean.js
View file

@ -453,8 +453,8 @@ PathItem.inject(new function() {
* @param {Point} point the location for which to determine the winding
* contribution
* @param {Curve[]} curves the curves that describe the shape against which
* to check, as returned by {@link Path#getCurves()} or
* {@link CompoundPath#getCurves()}
* to check, as returned by {@link Path#curves} or
* {@link CompoundPath#curves}
* @param {Boolean} [dir=false] the direction in which to determine the
* winding contribution, `false`: in x-direction, `true`: in y-direction
* @param {Boolean} [closed=false] determines how areas should be closed

2
src/style/GradientStop.js
View file

@ -127,7 +127,7 @@ var GradientStop = Base.extend(/** @lends GradientStop# */{
/**
* @private
* @bean
* @deprecated use {@link #getOffset()} instead.
* @deprecated use {@link #offset} instead.
*/
getRampPoint: '#getOffset',
setRampPoint: '#setOffset',

2
src/style/Style.js
View file

@ -354,7 +354,7 @@ var Style = Base.extend(new function() {
/**
* @bean
* @private
* @deprecated use {@link #getFontFamily()} instead.
* @deprecated use {@link #fontFamily} instead.
*/
getFont: '#getFontFamily',
setFont: '#setFontFamily',

4
src/text/TextItem.js
View file

@ -158,7 +158,7 @@ var TextItem = Item.extend(/** @lends TextItem# */{
/**
* @bean
* @private
* @deprecated use {@link #getStyle()} instead.
* @deprecated use {@link #style} instead.
*/
getCharacterStyle: '#getStyle',
setCharacterStyle: '#setStyle',
@ -166,7 +166,7 @@ var TextItem = Item.extend(/** @lends TextItem# */{
/**
* @bean
* @private
* @deprecated use {@link #getStyle()} instead.
* @deprecated use {@link #style} instead.
*/
getParagraphStyle: '#getStyle',
setParagraphStyle: '#setStyle'

14
src/view/View.js
View file

@ -608,7 +608,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @name View#rotate
* @function
* @param {Number} angle the rotation angle
* @param {Point} [center={@link View#getCenter()}]
* @param {Point} [center={@link View#center}]
* @see Matrix#rotate(angle[, center])
*/
@ -619,7 +619,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @name View#scale
* @function
* @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
@ -629,7 +629,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @function
* @param {Number} hor the horizontal 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
* @function
* @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])
*/
/**
@ -650,7 +650,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @function
* @param {Number} hor the horizontal 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])
*/
@ -661,7 +661,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @name View#skew
* @function
* @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])
*/
/**
@ -672,7 +672,7 @@ var View = Base.extend(Emitter, /** @lends View# */{
* @function
* @param {Number} hor the horizontal skew 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])
*/