Fix all faulty {@true} doc statements.

This commit is contained in:
Jürg Lehni 2014-02-26 15:39:00 +01:00
parent 49801e4b8b
commit 737466d15c
6 changed files with 10 additions and 10 deletions

View file

@ -726,7 +726,7 @@ var Point = Base.extend(/** @lends Point# */{
/**
* Checks if this point has both the x and y coordinate set to 0.
*
* @returns {Boolean} {@true both x and y are 0}
* @returns {Boolean} {@true if both x and y are 0}
*/
isZero: function() {
return Numerical.isZero(this.x) && Numerical.isZero(this.y);
@ -792,7 +792,7 @@ var Point = Base.extend(/** @lends Point# */{
*
* @name Point#selected
* @property
* @return {Boolean} {@true the point is selected}
* @return {Boolean} {@true if the point is selected}
*/
/**

View file

@ -482,7 +482,7 @@ var Rectangle = Base.extend(/** @lends Rectangle# */{
},
/**
* @return {Boolean} {@true the rectangle is empty}
* @return {Boolean} {@true if the rectangle is empty}
*/
isEmpty: function() {
return this.width === 0 || this.height === 0;

View file

@ -375,7 +375,7 @@ var Size = Base.extend(/** @lends Size# */{
* {@grouptitle Tests}
* Checks if this size has both the width and height set to 0.
*
* @return {Boolean} {@true both width and height are 0}
* @return {Boolean} {@true if both width and height are 0}
*/
isZero: function() {
return Numerical.isZero(this.width) && Numerical.isZero(this.height);

View file

@ -2043,7 +2043,7 @@ var Item = Base.extend(Callback, /** @lends Item# */{
* Moves this item above the specified item.
*
* @param {Item} item The item above which it should be moved
* @return {Boolean} {@true it was moved}
* @return {Boolean} {@true if it was moved}
* @deprecated use {@link #insertAbove(item)} instead.
*/
moveAbove: '#insertAbove',
@ -2052,7 +2052,7 @@ var Item = Base.extend(Callback, /** @lends Item# */{
* Moves the item below the specified item.
*
* @param {Item} item the item below which it should be moved
* @return {Boolean} {@true it was moved}
* @return {Boolean} {@true if it was moved}
* @deprecated use {@link #insertBelow(item)} instead.
*/
moveBelow: '#insertBelow',
@ -2124,7 +2124,7 @@ var Item = Base.extend(Callback, /** @lends Item# */{
* Removes the item from the project. If the item has children, they are also
* removed.
*
* @return {Boolean} {@true the item was removed}
* @return {Boolean} {@true if the item was removed}
*/
remove: function() {
return this._remove(true);
@ -2215,7 +2215,7 @@ var Item = Base.extend(Callback, /** @lends Item# */{
/**
* Checks whether the item is valid, i.e. it hasn't been removed.
*
* @return {Boolean} {@true the item is valid}
* @return {Boolean} {@true if the item is valid}
*/
// TODO: isValid / checkValid

View file

@ -293,7 +293,7 @@ var Curve = Base.extend(/** @lends Curve# */{
* Checks if this curve is linear, meaning it does not define any curve
* handle.
* @return {Boolean} {@true the curve is linear}
* @return {Boolean} {@true if the curve is linear}
*/
isLinear: function() {
return this._segment1._handleOut.isZero()

View file

@ -177,7 +177,7 @@ var Gradient = Base.extend(/** @lends Gradient# */{
* Checks whether the gradient is equal to the supplied gradient.
*
* @param {Gradient} gradient
* @return {Boolean} {@true they are equal}
* @return {Boolean} {@true if they are equal}
*/
equals: function(gradient) {
if (gradient === this)