diff --git a/src/basic/Point.js b/src/basic/Point.js index 037ff883..72528a89 100644 --- a/src/basic/Point.js +++ b/src/basic/Point.js @@ -258,7 +258,7 @@ var Point = this.Point = Base.extend({ * Checks whether the point is inside the boundaries of the rectangle. * * @param rect the rectangle to check against - * @return {@true if the point is inside the rectangle} + * @return true if the point is inside the rectangle, false otherwise. */ isInside: function(rect) { return rect.contains(this); @@ -269,7 +269,7 @@ var Point = this.Point = Base.extend({ * * @param point the point to check against * @param tolerance the maximum distance allowed - * @return {@true if it is within the given distance} + * @return true if it is within the given distance, false otherwise. */ isClose: function(point, tolerance) { return this.getDistance(point) < tolerance; @@ -280,7 +280,7 @@ var Point = this.Point = Base.extend({ * another vector. * * @param point the vector to check against - * @return {@true if it is parallel} + * @return true if it is parallel, false otherwise. */ isColinear: function(point) { return this.cross(point) < Numerical.TOLERANCE; @@ -291,7 +291,7 @@ var Point = this.Point = Base.extend({ * (perpendicular) to another vector. * * @param point the vector to check against - * @return {@true if it is orthogonal} + * @return true if it is orthogonal, false otherwise. */ isOrthogonal: function(point) { return this.dot(point) < Numerical.TOLERANCE; @@ -300,7 +300,7 @@ var Point = this.Point = Base.extend({ /** * Checks if this point has both the x and y coordinate set to 0. * - * @return {@true if both x and y are 0} + * @return true if both x and y are 0, false otherwise. */ isZero: function() { return this.x == 0 && this.y == 0; @@ -310,7 +310,7 @@ var Point = this.Point = Base.extend({ * Checks if this point has an undefined value for at least one of its * coordinates. * - * @return {@true if either x or y are not a number} + * @return true if either x or y are not a number, false otherwise. */ isNaN: function() { return isNaN(this.x) || isNaN(this.y); diff --git a/src/color/Color.js b/src/color/Color.js index f51f5470..0fd395d7 100644 --- a/src/color/Color.js +++ b/src/color/Color.js @@ -91,8 +91,7 @@ var Color = this.Color = Base.extend(new function() { ? rgbColor.convert(this._colorType) : rgbColor; } else { - var components = isArray ? arg - : Array.prototype.slice.call(arguments); + var components = isArray ? arg : arguments; if (!this._colorType) { // Called on the abstract Color class. Guess color type // from arg @@ -148,7 +147,7 @@ var Color = this.Color = Base.extend(new function() { /** * Checks if the color has an alpha value. * - * @return {@true if the color has an alpha value} + * @return true if the color has an alpha value, false otherwise. */ hasAlpha: function() { return this._alpha != null; @@ -159,7 +158,7 @@ var Color = this.Color = Base.extend(new function() { * same as those of the supplied one. * * @param obj the GrayColor to compare with - * @return {@true if the GrayColor is the same} + * @return true if the GrayColor is the same, false otherwise. */ equals: function(color) { if (color && color._colorType === this._colorType) { diff --git a/src/color/GradientColor.js b/src/color/GradientColor.js index abe89d9f..fb58883b 100644 --- a/src/color/GradientColor.js +++ b/src/color/GradientColor.js @@ -89,7 +89,7 @@ var GradientColor = this.GradientColor = Color.extend({ * same as those of the supplied one. * * @param obj the GrayColor to compare with - * @return {@true if the GrayColor is the same} + * @return true if the GrayColor is the same, false otherwise. */ equals: function(color) { if (color && color._colorType === this._colorType) { diff --git a/src/item/Group.js b/src/item/Group.js index 4e3588c4..51fb029a 100644 --- a/src/item/Group.js +++ b/src/item/Group.js @@ -33,7 +33,7 @@ var Group = this.Group = Item.extend({ * When setting to true, the first child in the group is automatically * defined as the clipping mask. * - * @return {@true if the group item is to be clipped} + * @return true if the group item is to be clipped, false otherwise. */ isClipped: function() { return this._clipped; diff --git a/src/item/Item.js b/src/item/Item.js index 406f5ccd..3f945555 100644 --- a/src/item/Item.js +++ b/src/item/Item.js @@ -125,14 +125,14 @@ var Item = this.Item = Base.extend({ /** * Specifies whether the item is locked. * - * @return {@true if the item is locked} + * @return true if the item is locked, false otherwise. */ locked: false, /** * Specifies whether the item is visible. * - * @return {@true if the item is visible} + * @return true if the item is visible, false otherwise. */ visible: true, @@ -153,7 +153,7 @@ var Item = this.Item = Base.extend({ * paths, compound paths, and text frame objects, and only if the item is * already contained within a clipping group. * - * @return {@true if the item defines a clip mask} + * @return true if the item defines a clip mask, false otherwise. */ isClipMask: function() { return this._clipMask; @@ -262,7 +262,7 @@ var Item = this.Item = Base.extend({ /** * Checks if the item contains any children items. * - * @return {@true if it has one or more children} + * @return true if it has one or more children, false otherwise. */ hasChildren: function() { return this._children && this._children.length > 0; @@ -271,8 +271,8 @@ var Item = this.Item = Base.extend({ /** * Checks whether the item is editable. * - * @return {@true when neither the item, nor it's parents are locked or - * hidden} + * @return true when neither the item, nor it's parents are locked or + * hidden, false otherwise. */ isEditable: function() { var parent = this; @@ -287,7 +287,7 @@ var Item = this.Item = Base.extend({ /** * Checks whether the item is valid, i.e. it hasn't been removed. * - * @return {@true if the item is valid} + * @return true if the item is valid, false otherwise. */ // TODO: isValid / checkValid @@ -296,7 +296,7 @@ var Item = this.Item = Base.extend({ * the document. * * @param item The item to check against - * @return {@true if it is above the specified item} + * @return true if it is above the specified item, false otherwise. */ // TODO: isAbove @@ -305,7 +305,7 @@ var Item = this.Item = Base.extend({ * the document. * * @param item The item to check against - * @return {@true if it is below the specified item} + * @return true if it is below the specified item, false otherwise. */ // TODO: isBelow @@ -321,7 +321,7 @@ var Item = this.Item = Base.extend({ * Checks if the item is contained within the specified item. * * @param item The item to check against - * @return {@true if it is inside the specified item} + * @return true if it is inside the specified item, false otherwise. */ isDescendant: function(item) { var parent = this; @@ -336,7 +336,7 @@ var Item = this.Item = Base.extend({ * Checks if the item is an ancestor of the specified item. * * @param item the item to check against - * @return {@true if the item is an ancestor of the specified item} + * @return true if the item is an ancestor of the specified item, false otherwise. */ isAncestor: function(item) { var parent = item; @@ -351,7 +351,7 @@ var Item = this.Item = Base.extend({ * Checks whether the item is grouped with the specified item. * * @param item - * @return {@true if the items are grouped together} + * @return true if the items are grouped together, false otherwise. */ isGroupedWith: function(item) { var parent = this._parent; diff --git a/src/path/Curve.js b/src/path/Curve.js index 5eef4c08..7cf57562 100644 --- a/src/path/Curve.js +++ b/src/path/Curve.js @@ -164,7 +164,7 @@ var Curve = this.Curve = Base.extend({ * Checks if this curve is linear, meaning it does not define any curve * handle. - * @return {@true if the curve is linear} + * @return true if the curve is linear, false otherwise. */ isLinear: function() { return this._segment1._handleOut.isZero()