Clean up comments.

This commit is contained in:
Jürg Lehni 2011-02-15 22:51:02 +00:00
parent 14bfb4c78e
commit 27f291ec80

View file

@ -161,9 +161,7 @@ var Matrix = Base.extend({
}, },
/** /**
* @return {string} A string representation of this transform. The format of * @return {string} A string representation of this transform.
* of the string is compatible with SVG matrix notation, i.e.
* "matrix(a,b,c,d,e,f)".
*/ */
toString: function() { toString: function() {
return '[[' return '[['
@ -290,12 +288,12 @@ var Matrix = Base.extend({
* @param {Point} point The point to be transformed. * @param {Point} point The point to be transformed.
* *
* @param {Array} src The array containing the source points * @param {Array} src The array containing the source points
* as x, y value pairs. * as x, y value pairs.
* @param {number} srcOff The offset to the first point to be transformed. * @param {number} srcOff The offset to the first point to be transformed.
* @param {Array} dst The array into which to store the transformed * @param {Array} dst The array into which to store the transformed
* point pairs. * point pairs.
* @param {number} dstOff The offset of the location of the first transformed * @param {number} dstOff The offset of the location of the first
* point in the destination array. * transformed point in the destination array.
* @param {number} numPts The number of points to tranform. * @param {number} numPts The number of points to tranform.
*/ */
transform: function(/* point | */ src, srcOff, dst, dstOff, numPts) { transform: function(/* point | */ src, srcOff, dst, dstOff, numPts) {
@ -339,8 +337,8 @@ var Matrix = Base.extend({
}, },
/** /**
* Returns whether the transform is invertible. A transform is not invertible * Returns whether the transform is invertible. A transform is not
* if the determinant is 0 or any value is non-finite or NaN. * invertible if the determinant is 0 or any value is non-finite or NaN.
* *
* @return {boolean} Whether the transform is invertible. * @return {boolean} Whether the transform is invertible.
*/ */
@ -361,7 +359,8 @@ var Matrix = Base.extend({
}, },
/** /**
* @return {Matrix} An Matrix object representing the inverse transformation. * @return {Matrix} An Matrix object representing the inverse
* transformation.
*/ */
createInverse: function() { createInverse: function() {
var det = this.getDeterminant(); var det = this.getDeterminant();
@ -444,7 +443,7 @@ var Matrix = Base.extend({
* @param {number} sx The x-axis scaling factor. * @param {number} sx The x-axis scaling factor.
* @param {number} sy The y-axis scaling factor. * @param {number} sy The y-axis scaling factor.
* @return {Matrix} A transform representing a scaling * @return {Matrix} A transform representing a scaling
* transformation. * transformation.
*/ */
getScaleInstance: function(sx, sy) { getScaleInstance: function(sx, sy) {
var mx = new Matrix(); var mx = new Matrix();
@ -456,8 +455,8 @@ var Matrix = Base.extend({
* *
* @param {number} dx The distance to translate in the x direction. * @param {number} dx The distance to translate in the x direction.
* @param {number} dy The distance to translate in the y direction. * @param {number} dy The distance to translate in the y direction.
* @return {Matrix} A transform representing a * @return {Matrix} A transform representing a translation
* translation transformation. * transformation.
*/ */
getTranslateInstance: function(delta) { getTranslateInstance: function(delta) {
var mx = new Matrix(); var mx = new Matrix();
@ -469,8 +468,7 @@ var Matrix = Base.extend({
* *
* @param {number} shx The x-axis shear factor. * @param {number} shx The x-axis shear factor.
* @param {number} shy The y-axis shear factor. * @param {number} shy The y-axis shear factor.
* @return {Matrix} A transform representing a shearing * @return {Matrix} A transform representing a shearing transformation.
* transformation.
*/ */
getShearInstance: function(shx, shy, center) { getShearInstance: function(shx, shy, center) {
var mx = new Matrix(); var mx = new Matrix();
@ -483,8 +481,7 @@ var Matrix = Base.extend({
* @param {number} angle The angle of rotation measured in degrees. * @param {number} angle The angle of rotation measured in degrees.
* @param {number} x The x coordinate of the anchor point. * @param {number} x The x coordinate of the anchor point.
* @param {number} y The y coordinate of the anchor point. * @param {number} y The y coordinate of the anchor point.
* @return {Matrix} A transform representing a rotation * @return {Matrix} A transform representing a rotation transformation.
* transformation.
*/ */
getRotateInstance: function(angle, center) { getRotateInstance: function(angle, center) {
var mx = new Matrix(); var mx = new Matrix();