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

Convert "Note: " comments to "NOTE: " and do some cleanup.

Browse source
This commit is contained in:
Jürg Lehni 2016-01-06 14:23:19 +01:00
parent 7152942719
commit b9c76f44e8
12 changed files with 21 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/basic/Point.js
View file

@ -948,7 +948,6 @@ var Point = Base.extend(/** @lends Point# */{
* @class An internal version of Point that notifies its owner of each change
* through setting itself again on the setter that corresponds to the getter
* that produced this LinkedPoint.
* Note: This prototype is not exported.
*
* @ignore
*/

1
src/basic/Rectangle.js
View file

@ -836,7 +836,6 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* @class An internal version of Rectangle that notifies its owner of each
* change through setting itself again on the setter that corresponds to the
* getter that produced this LinkedRectangle.
* Note: This prototype is not exported.
*
* @private
*/

1
src/basic/Size.js
View file

@ -524,7 +524,6 @@ var Size = Base.extend(/** @lends Size# */{
* @class An internal version of Size that notifies its owner of each change
* through setting itself again on the setter that corresponds to the getter
* that produced this LinkedSize.
* Note: This prototype is not exported.
*
* @private
*/

8
src/core/Base.js
View file

@ -475,7 +475,7 @@ Base.inject(/** @lends Base# */{
return Base.deserialize(
typeof json === 'string' ? JSON.parse(json) : json,
// Provide our own create function to handle target and
// insertion
// insertion.
function(type, args) {
// If a target is provided and its of the right type,
// import right into it.
@ -483,8 +483,8 @@ Base.inject(/** @lends Base# */{
? target
: Base.create(type.prototype),
isTarget = obj === target;
// Note: We don't set insert false for layers since
// we want these to be created on the fly in the active
// NOTE: We don't set insert false for layers since we
// want these to be created on the fly in the active
// project into which we're importing (except for if
// it's a preexisting target layer).
if (args.length === 1 && obj instanceof Item
@ -494,7 +494,7 @@ Base.inject(/** @lends Base# */{
arg.insert = false;
}
type.apply(obj, args);
// Clear target to only use it once
// Clear target to only use it once.
if (isTarget)
target = null;
return obj;

10
src/item/Item.js
View file

@ -310,7 +310,7 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
},
setName: function(name) {
// Note: Don't check if the name has changed and bail out if it has not,
// NOTE: Don't check if the name has changed and bail out if it has not,
// because setName is used internally also to update internal structures
// when an item is moved from one parent to another.
@ -422,7 +422,7 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
// See #getPosition() below.
beans: true,
// Note: These properties have their getter / setters produced in the
// NOTE: These properties have their getter / setters produced in the
// injection scope above.
/**
@ -832,7 +832,7 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
* bounding types.
*/
_getBounds: function(getter, matrix, cacheItem) {
// Note: We cannot cache these results here, since we do not get
// NOTE: We cannot cache these results here, since we do not get
// _changed() notifications here for changing geometry in children.
// But cacheName is used in sub-classes such as PlacedSymbol and Raster.
var children = this._children;
@ -897,7 +897,7 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
// Do not transform by the internal matrix if there is a internalGetter.
var _matrix = internalGetter ? null : this._matrix.orNullIfIdentity(),
cache = (!matrix || matrix.equals(_matrix)) && getter;
// Note: This needs to happen before returning cached values, since even
// NOTE: This needs to happen before returning cached values, since even
// then, _boundsCache needs to be kept up-to-date.
Item._updateBoundsCache(this._parent || this._parentSymbol, cacheItem);
if (cache && this._bounds && this._bounds[cache])
@ -1382,7 +1382,7 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
},
equals: function(item) {
// Note: We do not compare name and selected state.
// NOTE: We do not compare name and selected state.
// TODO: Consider not comparing locked and visible also?
return item === this || item && this._class === item._class
&& this._style.equals(item._style)

2
src/path/CompoundPath.js
View file

@ -329,7 +329,7 @@ new function() { // Injection scope for PostScript-like drawing functions
}
var fields = {
// Note: Documentation for these methods is found in PathItem, as they
// NOTE: Documentation for these methods is found in PathItem, as they
// are considered abstract methods of PathItem and need to be defined in
// all implementing classes.
moveTo: function(/* point */) {

8
src/path/Curve.js
View file

@ -76,7 +76,7 @@ var Curve = Base.extend(/** @lends Curve# */{
seg2 = new Segment();
} else if (count === 1) {
// new Segment(segment);
// Note: This copies from existing segments through bean getters
// NOTE: This copies from existing segments through bean getters
if ('segment1' in arg0) {
seg1 = new Segment(arg0.segment1);
seg2 = new Segment(arg0.segment2);
@ -766,7 +766,7 @@ statics: {
* Private helper for both Curve.getBounds() and Path.getBounds(), which
* finds the 0-crossings of the derivative of a bezier curve polynomial, to
* determine potential extremas when finding the bounds of a curve.
* Note: padding is only used for Path.getBounds().
* NOTE: padding is only used for Path.getBounds().
*/
_addBounds: function(v0, v1, v2, v3, coord, padding, min, max, roots) {
// Code ported and further optimised from:
@ -809,7 +809,7 @@ statics: {
}
}}, Base.each(
['getBounds', 'getStrokeBounds', 'getHandleBounds', 'getRoughBounds'],
// Note: Although Curve.getBounds() exists, we are using Path.getBounds() to
// NOTE: Although Curve.getBounds() exists, we are using Path.getBounds() to
// determine the bounds of Curve objects with defined segment1 and segment2
// values Curve.getBounds() can be used directly on curve arrays, without
// the need to create a Curve object first, as required by the code that
@ -1158,7 +1158,7 @@ new function() { // // Scope to inject various curve evaluation methods
var methods = ['getPoint', 'getTangent', 'getNormal', 'getWeightedTangent',
'getWeightedNormal', 'getCurvature'];
return Base.each(methods,
// Note: Although Curve.getBounds() exists, we are using Path.getBounds() to
// NOTE: Although Curve.getBounds() exists, we are using Path.getBounds() to
// determine the bounds of Curve objects with defined segment1 and segment2
// values Curve.getBounds() can be used directly on curve arrays, without
// the need to create a Curve object first, as required by the code that

2
src/path/CurveLocation.js
View file

@ -317,7 +317,7 @@ var CurveLocation = Base.extend(/** @lends CurveLocation# */{
var res = this === loc,
epsilon = /*#=*/Numerical.GEOMETRIC_EPSILON;
// NOTE: We need to compare both by (index + parameter) and by proximity
// of points. See: #784#issuecomment-143161586
// of points. See #784#issuecomment-143161586
if (!res && loc instanceof CurveLocation
&& this.getPath() === loc.getPath()
&& this.getPoint().isClose(loc.getPoint(), epsilon)) {

4
src/path/Path.js
View file

@ -2290,7 +2290,7 @@ new function() { // Path Smoothing
}
return {
// Note: Documentation for smooth() is in PathItem
// NOTE: Documentation for smooth() is in PathItem
smooth: function() {
// This code is based on the work by Oleg V. Polikarpotchkin,
// http://ov-p.spaces.live.com/blog/cns!39D56F0C7A08D703!147.entry
@ -2401,7 +2401,7 @@ new function() { // PostScript-style drawing commands
}
return {
// Note: Documentation for these methods is found in PathItem, as they
// NOTE: Documentation for these methods is found in PathItem, as they
// are considered abstract methods of PathItem and need to be defined in
// all implementing classes.
moveTo: function(/* point */) {

5
src/path/Segment.js
View file

@ -118,7 +118,7 @@ var Segment = Base.extend(/** @lends Segment# */{
if (count === 0) {
// Nothing
} else if (count === 1) {
// Note: This copies from existing segments through accessors.
// NOTE: This copies from existing segments through accessors.
if ('point' in arg0) {
point = arg0.point;
handleIn = arg0.handleIn;
@ -415,7 +415,8 @@ var Segment = Base.extend(/** @lends Segment# */{
/**
* Reverses the {@link #handleIn} and {@link #handleOut} vectors of this
* segment. Note: the actual segment is modified, no copy is created.
* segment, modifying the actual segment without creating a copy.
*
* @return {Segment} the reversed segment
*/
reverse: function() {

1
src/path/SegmentPoint.js
View file

@ -13,7 +13,6 @@
/**
* @name SegmentPoint
* @class An internal version of Point that notifies its segment of each change
* Note: This prototype is not exported.
*
* @private
*/

2
src/style/Style.js
View file

@ -165,7 +165,7 @@ var Style = Base.extend(new function() {
value._owner = owner;
}
}
// Note: We do not convert the values to Colors in the
// NOTE: We do not convert the values to Colors in the
// setter. This only happens once the getter is called.
this._values[key] = value;
// Notify the owner of the style change STYLE is always set,