From 69fdc220e14226ae950149418ac3ab6fb5ac0faa Mon Sep 17 00:00:00 2001 From: kangax Date: Wed, 16 Jul 2014 11:45:50 +0200 Subject: [PATCH] Add JSDoc validation in JSCS. Few style/doc fixes. --- .jscs.json | 8 +++++++- src/mixins/object_interactivity.mixin.js | 2 +- src/parser.js | 6 +++--- src/static_canvas.class.js | 2 +- src/util/misc.js | 14 +++++++------- 5 files changed, 19 insertions(+), 13 deletions(-) diff --git a/.jscs.json b/.jscs.json index 3068bf42..1f5c725f 100644 --- a/.jscs.json +++ b/.jscs.json @@ -31,5 +31,11 @@ "validateQuoteMarks": "'", "validateIndentation": 2, - "safeContextKeyword": "_this" + "safeContextKeyword": "_this", + + "validateJSDoc": { + "checkParamNames": true, + "checkRedundantParams": true, + "requireParamTypes": true + } } diff --git a/src/mixins/object_interactivity.mixin.js b/src/mixins/object_interactivity.mixin.js index 353fdf0d..bdc5ed75 100644 --- a/src/mixins/object_interactivity.mixin.js +++ b/src/mixins/object_interactivity.mixin.js @@ -366,7 +366,7 @@ } w *= this.scaleX; h *= this.scaleY; - + var wh = fabric.util.transformPoint(new fabric.Point(w, h), vpt, true), width = wh.x, height = wh.y, diff --git a/src/parser.js b/src/parser.js index e808052f..2f893185 100644 --- a/src/parser.js +++ b/src/parser.js @@ -363,7 +363,7 @@ return styles; } - + /** * @private */ @@ -433,9 +433,9 @@ return function(doc, callback, reviver) { if (!doc) return; var startTime = new Date(); - + parseUseDirectives(doc); - + var descendants = fabric.util.toArray(doc.getElementsByTagName('*')); if (descendants.length === 0 && fabric.isLikelyNode) { diff --git a/src/static_canvas.class.js b/src/static_canvas.class.js index f3ca801a..f6ab0fcf 100644 --- a/src/static_canvas.class.js +++ b/src/static_canvas.class.js @@ -651,7 +651,7 @@ */ _draw: function (ctx, object) { if (!object) return; - + ctx.save(); var v = this.viewportTransform; ctx.transform(v[0], v[1], v[2], v[3], v[4], v[5]); diff --git a/src/util/misc.js b/src/util/misc.js index 60a07ee5..b7c7365e 100644 --- a/src/util/misc.js +++ b/src/util/misc.js @@ -64,9 +64,9 @@ * Rotates `point` around `origin` with `radians` * @static * @memberOf fabric.util - * @param {fabric.Point} The point to rotate - * @param {fabric.Point} The origin of the rotation - * @param {Number} The radians of the angle for the rotation + * @param {fabric.Point} point The point to rotate + * @param {fabric.Point} origin The origin of the rotation + * @param {Number} radians The radians of the angle for the rotation * @return {fabric.Point} The new rotated point */ rotatePoint: function(point, origin, radians) { @@ -102,19 +102,19 @@ t[2] * p.x + t[3] * p.y + t[5] ); }, - + /** * Invert transformation t * @static * @memberOf fabric.util - * @param {Array} t The transform + * @param {Array} t The transform * @return {Array} The inverted transform */ invertTransform: function(t) { var r = t.slice(), a = 1 / (t[0] * t[3] - t[1] * t[2]); r = [a * t[3], -a * t[1], -a * t[2], a * t[0], 0, 0]; - var o = fabric.util.transformPoint({x: t[4], y: t[5]}, r); + var o = fabric.util.transformPoint({ x: t[4], y: t[5] }, r); r[4] = -o.x; r[5] = -o.y; return r; @@ -223,7 +223,7 @@ * @memberOf fabric.util * @param {Array} objects Objects to enliven * @param {Function} callback Callback to invoke when all objects are created - * @param {Function} [reviver] Method for further parsing of object elements, + * @param {Function} Method for further parsing of object elements, * called after each fabric object created. */ enlivenObjects: function(objects, callback, namespace, reviver) {