From cd76c8c0e103e98cee6babd3908ce7b61cc0ac37 Mon Sep 17 00:00:00 2001 From: Jonathan Puckey Date: Sat, 28 May 2011 02:17:35 +0200 Subject: [PATCH] Documentation: remove ^n from method names, since this isn't necessary anymore. --- src/basic/Point.js | 10 +++++----- src/basic/Rectangle.js | 2 +- src/basic/Size.js | 10 +++++----- src/item/Item.js | 2 +- src/item/Raster.js | 4 ++-- src/path/Path.Constructors.js | 6 ++---- 6 files changed, 16 insertions(+), 18 deletions(-) diff --git a/src/basic/Point.js b/src/basic/Point.js index 33345bb5..15da8c20 100644 --- a/src/basic/Point.js +++ b/src/basic/Point.js @@ -124,7 +124,7 @@ var Point = this.Point = Base.extend({ * var result = point + 20; * console.log(result); // { x: 25.0, y: 30.0 } * - * @name Point#add^2 + * @name Point#add * @function * @param {Number} number the number to add * @return {Point} the addition of the point and the value as a new point @@ -160,7 +160,7 @@ var Point = this.Point = Base.extend({ * var result = point - 5; * console.log(result); // { x: 5.0, y: 15.0 } * - * @name Point#subtract^2 + * @name Point#subtract * @function * @param {Number} number the number to subtract * @return {Point} the subtraction of the point and the value as a new point @@ -196,7 +196,7 @@ var Point = this.Point = Base.extend({ * var result = point * 2; * console.log(result); // { x: 20.0, y: 40.0 } * - * @name Point#multiply^2 + * @name Point#multiply * @function * @param {Number} number the number to multiply by * @return {Point} the multiplication of the point and the value as a new point @@ -232,7 +232,7 @@ var Point = this.Point = Base.extend({ * var result = point / 2; * console.log(result); // { x: 5.0, y: 10.0 } * - * @name Point#divide^2 + * @name Point#divide * @function * @param {Number} number the number to divide by * @return {Point} the division of the point and the value as a new point @@ -266,7 +266,7 @@ var Point = this.Point = Base.extend({ * var point = new Point(12, 6); * console.log(point % 5); // {x: 2, y: 1} * - * @name Point#modulo^2 + * @name Point#modulo * @function * @param {Number} value * @return {Point} the integer remainders of dividing the point by the value diff --git a/src/basic/Rectangle.js b/src/basic/Rectangle.js index 4aac396f..36779847 100644 --- a/src/basic/Rectangle.js +++ b/src/basic/Rectangle.js @@ -360,7 +360,7 @@ var Rectangle = this.Rectangle = Base.extend({ * * Tests if the specified point is inside the boundary of the rectangle. * - * @name Rectangle#contains^2 + * @name Rectangle#contains * @function * @param {Point} point the specified point * @return {boolean} {@true if the point is inside the rectangle's boundary} diff --git a/src/basic/Size.js b/src/basic/Size.js index c614479f..65646843 100644 --- a/src/basic/Size.js +++ b/src/basic/Size.js @@ -100,7 +100,7 @@ var Size = this.Size = Base.extend({ * var result = size + 20; * console.log(result); // { width: 25.0, height: 30.0 } * - * @name Size#add^2 + * @name Size#add * @function * @param {Number} number the number to add * @return {Size} the addition of the size and the value as a new size @@ -135,7 +135,7 @@ var Size = this.Size = Base.extend({ * var result = size - 5; * console.log(result); // { width: 5.0, height: 15.0 } * - * @name Size#subtract^2 + * @name Size#subtract * @function * @param {Number} number the number to subtract * @return {Size} the subtraction of the size and the value as a new size @@ -169,7 +169,7 @@ var Size = this.Size = Base.extend({ * var result = size * 2; * console.log(result); // { width: 20.0, height: 40.0 } * - * @name Size#multiply^2 + * @name Size#multiply * @function * @param {Number} number the number to multiply by * @return {Size} the multiplication of the size and the value as a new size @@ -203,7 +203,7 @@ var Size = this.Size = Base.extend({ * var result = size / 2; * console.log(result); // { width: 5.0, height: 10.0 } * - * @name Size#divide^2 + * @name Size#divide * @function * @param {Number} number the number to divide by * @return {Size} the division of the size and the value as a new size @@ -236,7 +236,7 @@ var Size = this.Size = Base.extend({ * var size = new Size(12, 6); * console.log(size % 5); // {width: 2, height: 1} * - * @name Size#modulo^2 + * @name Size#modulo * @function * @param {Number} value * @return {Size} the integer remainders of dividing the size by the value diff --git a/src/item/Item.js b/src/item/Item.js index 14fc76fc..2cb5d4e3 100644 --- a/src/item/Item.js +++ b/src/item/Item.js @@ -905,7 +905,7 @@ var Item = this.Item = Base.extend({ * // Scale the path 200% from its bottom left corner * circle.scale(2, circle.bounds.bottomLeft); * - * @name Item#scale^1 + * @name Item#scale * @function * @param {Number} scale the scale factor * @param {Point} [center=the center point of the item] diff --git a/src/item/Raster.js b/src/item/Raster.js index 6f815797..51020109 100644 --- a/src/item/Raster.js +++ b/src/item/Raster.js @@ -278,7 +278,7 @@ var Raster = this.Raster = Item.extend({ * {@grouptitle Pixels} * Gets the color of a pixel in the raster. * - * @name Raster#getPixel^2 + * @name Raster#getPixel * @function * @param x the x offset of the pixel in pixel coordinates * @param y the y offset of the pixel in pixel coordinates @@ -301,7 +301,7 @@ var Raster = this.Raster = Item.extend({ /** * Sets the color of the specified pixel to the specified color. * - * @name Raster#setPixel^2 + * @name Raster#setPixel * @function * @param x the x offset of the pixel in pixel coordinates * @param y the y offset of the pixel in pixel coordinates diff --git a/src/path/Path.Constructors.js b/src/path/Path.Constructors.js index e5d9a1fe..ada2b34e 100644 --- a/src/path/Path.Constructors.js +++ b/src/path/Path.Constructors.js @@ -53,8 +53,7 @@ Path.inject({ statics: new function() { * var rectangle = new Rectangle(new Point(100, 100), new Size(100, 100)); * var path = new Path.Rectangle(rectangle); * - * @name Path.Rectangle^3 - * @function + * @name Path.Rectangle * @param {Point} point * @param {Size} size * @return {Path} the newly created path @@ -67,8 +66,7 @@ Path.inject({ statics: new function() { * @example * var path = new Path.Rectangle(new Point(100, 100), new Point(200, 300)); * - * @name Path.Rectangle^2 - * @function + * @name Path.Rectangle * @param {Point} point1 The first point defining the rectangle * @param {Point} point2 The second point defining the rectangle * @return {Path} the newly created path