diff --git a/src/basic/Point.js b/src/basic/Point.js index 55f0265b..26b06550 100644 --- a/src/basic/Point.js +++ b/src/basic/Point.js @@ -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 */ diff --git a/src/basic/Rectangle.js b/src/basic/Rectangle.js index 2e5ad02d..f0d2dcaa 100644 --- a/src/basic/Rectangle.js +++ b/src/basic/Rectangle.js @@ -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 */ diff --git a/src/basic/Size.js b/src/basic/Size.js index d0e48e92..6d9a8604 100644 --- a/src/basic/Size.js +++ b/src/basic/Size.js @@ -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 */ diff --git a/src/core/Base.js b/src/core/Base.js index dbc80f7e..73ce01a2 100644 --- a/src/core/Base.js +++ b/src/core/Base.js @@ -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; diff --git a/src/item/Item.js b/src/item/Item.js index 26bf18d7..d7f366b2 100644 --- a/src/item/Item.js +++ b/src/item/Item.js @@ -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) diff --git a/src/path/CompoundPath.js b/src/path/CompoundPath.js index 683a8eff..440b4000 100644 --- a/src/path/CompoundPath.js +++ b/src/path/CompoundPath.js @@ -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 */) { diff --git a/src/path/Curve.js b/src/path/Curve.js index 8d8daf64..cb7522a9 100644 --- a/src/path/Curve.js +++ b/src/path/Curve.js @@ -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 diff --git a/src/path/CurveLocation.js b/src/path/CurveLocation.js index b5fb5538..0d648c52 100644 --- a/src/path/CurveLocation.js +++ b/src/path/CurveLocation.js @@ -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)) { diff --git a/src/path/Path.js b/src/path/Path.js index 61faecc9..0a140c54 100644 --- a/src/path/Path.js +++ b/src/path/Path.js @@ -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 */) { diff --git a/src/path/Segment.js b/src/path/Segment.js index 86f814a1..206b5c89 100644 --- a/src/path/Segment.js +++ b/src/path/Segment.js @@ -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() { diff --git a/src/path/SegmentPoint.js b/src/path/SegmentPoint.js index 93cdffc4..83945d2b 100644 --- a/src/path/SegmentPoint.js +++ b/src/path/SegmentPoint.js @@ -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 */ diff --git a/src/style/Style.js b/src/style/Style.js index 4c097e0e..9c3c9bac 100644 --- a/src/style/Style.js +++ b/src/style/Style.js @@ -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,