scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2024-12-29 09:22:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix Rectangle documentation

Browse source 
Add missing return values in Rectangle boolean operations.
Closes #1399
This commit is contained in:
sasensi 2018-11-04 13:41:35 +01:00 committed by Jürg Lehni
parent 97b87e3836
commit c44f56d52f
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/basic/Rectangle.js
View file

@ -772,6 +772,8 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* Rectangle#contains(point)} returns `false` for that point.
*
* @param {Point} point
* @return {Rectangle} the smallest rectangle that contains both the
* original rectangle and the specified point
*/
include: function(/* point */) {
var point = Point.read(arguments);
@ -783,17 +785,18 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
},
/**
* Expands the rectangle by the specified amount in horizontal and
* vertical directions.
* Returns a new rectangle expanded by the specified amount in horizontal
* and vertical directions.
*
* @name Rectangle#expand
* @function
* @param {Number|Size|Point} amount the amount to expand the rectangle in
* both directions
* @return {Rectangle} the expanded rectangle
*/
/**
* Expands the rectangle by the specified amounts in horizontal and
* vertical directions.
* Returns a new rectangle expanded by the specified amounts in horizontal
* and vertical directions.
*
* @name Rectangle#expand
* @function
@ -801,6 +804,7 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
* direction
* @param {Number} ver the amount to expand the rectangle in vertical
* direction
* @return {Rectangle} the expanded rectangle
*/
expand: function(/* amount */) {
var amount = Size.read(arguments),
@ -811,21 +815,23 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
},
/**
* Scales the rectangle by the specified amount from its center.
* Returns a new rectangle scaled by the specified amount from its center.
*
* @name Rectangle#scale
* @function
* @param {Number} amount
* @return {Rectangle} the scaled rectangle
*/
/**
* Scales the rectangle in horizontal direction by the specified `hor`
* amount and in vertical direction by the specified `ver` amount from its
* center.
* Returns a new rectangle scaled in horizontal direction by the specified
* `hor` amount and in vertical direction by the specified `ver` amount
* from its center.
*
* @name Rectangle#scale
* @function
* @param {Number} hor
* @param {Number} ver
* @return {Rectangle} the scaled rectangle
*/
scale: function(hor, ver) {
return this.expand(this.width * hor - this.width,