Replace {@true} tags in documentation ({@true ([^}]*)} -> true $1, false otherwise.)

This commit is contained in:
Jürg Lehni 2011-05-15 15:06:10 +01:00
parent ee8b66e19a
commit 252a3635dc
6 changed files with 24 additions and 25 deletions

View file

@ -258,7 +258,7 @@ var Point = this.Point = Base.extend({
* Checks whether the point is inside the boundaries of the rectangle. * Checks whether the point is inside the boundaries of the rectangle.
* *
* @param rect the rectangle to check against * @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) { isInside: function(rect) {
return rect.contains(this); return rect.contains(this);
@ -269,7 +269,7 @@ var Point = this.Point = Base.extend({
* *
* @param point the point to check against * @param point the point to check against
* @param tolerance the maximum distance allowed * @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) { isClose: function(point, tolerance) {
return this.getDistance(point) < tolerance; return this.getDistance(point) < tolerance;
@ -280,7 +280,7 @@ var Point = this.Point = Base.extend({
* another vector. * another vector.
* *
* @param point the vector to check against * @param point the vector to check against
* @return {@true if it is parallel} * @return true if it is parallel, false otherwise.
*/ */
isColinear: function(point) { isColinear: function(point) {
return this.cross(point) < Numerical.TOLERANCE; return this.cross(point) < Numerical.TOLERANCE;
@ -291,7 +291,7 @@ var Point = this.Point = Base.extend({
* (perpendicular) to another vector. * (perpendicular) to another vector.
* *
* @param point the vector to check against * @param point the vector to check against
* @return {@true if it is orthogonal} * @return true if it is orthogonal, false otherwise.
*/ */
isOrthogonal: function(point) { isOrthogonal: function(point) {
return this.dot(point) < Numerical.TOLERANCE; 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. * 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() { isZero: function() {
return this.x == 0 && this.y == 0; 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 * Checks if this point has an undefined value for at least one of its
* coordinates. * 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() { isNaN: function() {
return isNaN(this.x) || isNaN(this.y); return isNaN(this.x) || isNaN(this.y);

View file

@ -91,8 +91,7 @@ var Color = this.Color = Base.extend(new function() {
? rgbColor.convert(this._colorType) ? rgbColor.convert(this._colorType)
: rgbColor; : rgbColor;
} else { } else {
var components = isArray ? arg var components = isArray ? arg : arguments;
: Array.prototype.slice.call(arguments);
if (!this._colorType) { if (!this._colorType) {
// Called on the abstract Color class. Guess color type // Called on the abstract Color class. Guess color type
// from arg // from arg
@ -148,7 +147,7 @@ var Color = this.Color = Base.extend(new function() {
/** /**
* Checks if the color has an alpha value. * 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() { hasAlpha: function() {
return this._alpha != null; return this._alpha != null;
@ -159,7 +158,7 @@ var Color = this.Color = Base.extend(new function() {
* same as those of the supplied one. * same as those of the supplied one.
* *
* @param obj the GrayColor to compare with * @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) { equals: function(color) {
if (color && color._colorType === this._colorType) { if (color && color._colorType === this._colorType) {

View file

@ -89,7 +89,7 @@ var GradientColor = this.GradientColor = Color.extend({
* same as those of the supplied one. * same as those of the supplied one.
* *
* @param obj the GrayColor to compare with * @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) { equals: function(color) {
if (color && color._colorType === this._colorType) { if (color && color._colorType === this._colorType) {

View file

@ -33,7 +33,7 @@ var Group = this.Group = Item.extend({
* When setting to true, the first child in the group is automatically * When setting to true, the first child in the group is automatically
* defined as the clipping mask. * 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() { isClipped: function() {
return this._clipped; return this._clipped;

View file

@ -125,14 +125,14 @@ var Item = this.Item = Base.extend({
/** /**
* Specifies whether the item is locked. * Specifies whether the item is locked.
* *
* @return {@true if the item is locked} * @return true if the item is locked, false otherwise.
*/ */
locked: false, locked: false,
/** /**
* Specifies whether the item is visible. * Specifies whether the item is visible.
* *
* @return {@true if the item is visible} * @return true if the item is visible, false otherwise.
*/ */
visible: true, 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 * paths, compound paths, and text frame objects, and only if the item is
* already contained within a clipping group. * 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() { isClipMask: function() {
return this._clipMask; return this._clipMask;
@ -262,7 +262,7 @@ var Item = this.Item = Base.extend({
/** /**
* Checks if the item contains any children items. * 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() { hasChildren: function() {
return this._children && this._children.length > 0; return this._children && this._children.length > 0;
@ -271,8 +271,8 @@ var Item = this.Item = Base.extend({
/** /**
* Checks whether the item is editable. * Checks whether the item is editable.
* *
* @return {@true when neither the item, nor it's parents are locked or * @return true when neither the item, nor it's parents are locked or
* hidden} * hidden, false otherwise.
*/ */
isEditable: function() { isEditable: function() {
var parent = this; 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. * 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 // TODO: isValid / checkValid
@ -296,7 +296,7 @@ var Item = this.Item = Base.extend({
* the document. * the document.
* *
* @param item The item to check against * @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 // TODO: isAbove
@ -305,7 +305,7 @@ var Item = this.Item = Base.extend({
* the document. * the document.
* *
* @param item The item to check against * @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 // TODO: isBelow
@ -321,7 +321,7 @@ var Item = this.Item = Base.extend({
* Checks if the item is contained within the specified item. * Checks if the item is contained within the specified item.
* *
* @param item The item to check against * @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) { isDescendant: function(item) {
var parent = this; var parent = this;
@ -336,7 +336,7 @@ var Item = this.Item = Base.extend({
* Checks if the item is an ancestor of the specified item. * Checks if the item is an ancestor of the specified item.
* *
* @param item the item to check against * @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) { isAncestor: function(item) {
var parent = item; var parent = item;
@ -351,7 +351,7 @@ var Item = this.Item = Base.extend({
* Checks whether the item is grouped with the specified item. * Checks whether the item is grouped with the specified item.
* *
* @param item * @param item
* @return {@true if the items are grouped together} * @return true if the items are grouped together, false otherwise.
*/ */
isGroupedWith: function(item) { isGroupedWith: function(item) {
var parent = this._parent; var parent = this._parent;

View file

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