mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-07 13:22:07 -05:00
Documentation: remove ^n from method names, since this isn't necessary anymore.
This commit is contained in:
parent
69732bcbad
commit
cd76c8c0e1
6 changed files with 16 additions and 18 deletions
|
@ -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
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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]
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue