Documentation: use inline code tags for boolean and number values,

This commit is contained in:
Jonathan Puckey 2011-05-31 14:28:42 +02:00
parent 31bf3ffa70
commit 2b8f1b71ec
6 changed files with 14 additions and 13 deletions

View file

@ -308,8 +308,8 @@ var Color = this.Color = Base.extend(new function() {
}, },
/** /**
* A value between 0 and 1 that specifies the color's alpha value. * A value between {@code 0} and {@code 1} that specifies the color's alpha
* All colors of the different subclasses support alpha values. * value. All colors of the different subclasses support alpha values.
* *
* @type Number * @type Number
* @bean * @bean

View file

@ -54,7 +54,8 @@ var GradientStop = this.GradientStop = Base.extend({
}, },
/** /**
* The ramp-point of the gradient stop as a value between 0 and 1. * The ramp-point of the gradient stop as a value between {@code 0} and
* {@code 1}.
* *
* @type Number * @type Number
* @bean * @bean

View file

@ -73,8 +73,8 @@ var Group = this.Group = Item.extend({
/** /**
* Specifies whether the group item is to be clipped. * Specifies whether the group item is to be clipped.
* When setting to true, the first child in the group is automatically * When setting to {@code true}, the first child in the group is
* defined as the clipping mask. * automatically defined as the clipping mask.
* *
* @type Boolean * @type Boolean
* @bean * @bean

View file

@ -279,7 +279,7 @@ var Item = this.Item = Base.extend({
blendMode: 'normal', blendMode: 'normal',
/** /**
* The opacity of the item as a value between 0 and 1. * The opacity of the item as a value between {@code 0} and {@code 1}.
* *
* @example * @example
* // Making an item 50% transparent: * // Making an item 50% transparent:
@ -470,7 +470,7 @@ var Item = this.Item = Base.extend({
}, },
/** /**
* Removes all of the item's children (if any). * Removes all of the item's {@link #children} (if any).
* *
* @return {Boolean} {@true removing was successful} * @return {Boolean} {@true removing was successful}
*/ */

View file

@ -417,7 +417,7 @@ var Curve = this.Curve = Base.extend({
* Returns the point on the curve at the specified position. * Returns the point on the curve at the specified position.
* *
* @param {Number} parameter the position at which to find the point as * @param {Number} parameter the position at which to find the point as
* a value between 0 and 1. * a value between {@code 0} and {@code 1}.
* @return {Point} * @return {Point}
*/ */
getPoint: function(parameter) { getPoint: function(parameter) {
@ -428,7 +428,7 @@ var Curve = this.Curve = Base.extend({
* Returns the tangent point on the curve at the specified position. * Returns the tangent point on the curve at the specified position.
* *
* @param {Number} parameter the position at which to find the tangent * @param {Number} parameter the position at which to find the tangent
* point as a value between 0 and 1. * point as a value between {@code 0} and {@code 1}.
*/ */
getTangent: function(parameter) { getTangent: function(parameter) {
return evaluate(this, parameter, 1); return evaluate(this, parameter, 1);
@ -438,7 +438,7 @@ var Curve = this.Curve = Base.extend({
* Returns the normal point on the curve at the specified position. * Returns the normal point on the curve at the specified position.
* *
* @param {Number} parameter the position at which to find the normal * @param {Number} parameter the position at which to find the normal
* point as a value between 0 and 1. * point as a value between {@code 0} and {@code 1}.
*/ */
getNormal: function(parameter) { getNormal: function(parameter) {
return evaluate(this, parameter, 2); return evaluate(this, parameter, 2);

View file

@ -157,10 +157,10 @@ Path.inject({ statics: new function() {
* Creates an oval shaped Path Item. * Creates an oval shaped Path Item.
* *
* @param {Rectangle} rect * @param {Rectangle} rect
* @param {Boolean} [circumscribed=false] if this is set to true the * @param {Boolean} [circumscribed=false] when set to {@code true} the
* oval shaped path will be created so the rectangle fits into * oval shaped path will be created so the rectangle fits into
* it. If it's set to false the oval path will fit within the * it. When set to {@code false} the oval path will fit within
* rectangle. * the rectangle.
* @return {Path} the newly created path * @return {Path} the newly created path
* *
* @example * @example