From 28a6d786c82d870601975b699ad2feea8196853c Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Sun, 31 Jan 2016 21:15:28 -0400 Subject: [PATCH 1/2] Lint JSDoc annotations with JSCS See http://jscs.info/rule/jsDoc --- .jscsrc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/.jscsrc b/.jscsrc index 3b48a913..c7d6cc49 100644 --- a/.jscsrc +++ b/.jscsrc @@ -1,4 +1,25 @@ { + "jsDoc": { + "checkAnnotations": { + "preset": "jsdoc3", + "extra": { + "fulfil": true + } + }, + "checkParamExistence": true, + "checkParamNames": true, + "requireParamTypes": true, + "checkReturnTypes": true, + "checkRedundantReturns": true, + "requireReturnTypes": true, + "checkTypes": "capitalizedNativeCase", + "checkRedundantAccess": true, + "requireHyphenBeforeDescription": true, + "requireNewlineAfterDescription": true, + "requireDescriptionCompleteSentence": true, + "requireParamDescription": true, + "checkRedundantParams": true + }, "disallowAnonymousFunctions": false, "disallowShorthandArrowFunctions": true, "disallowCapitalizedComments": false, From bad9500bc6484c2ab11f508cf5ee1f8e1fb93e99 Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Sun, 31 Jan 2016 21:15:40 -0400 Subject: [PATCH 2/2] Add missin param annotation caught by JSCS --- lib/browser/modules/image-writer.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/browser/modules/image-writer.js b/lib/browser/modules/image-writer.js index 28dc6e34..9416bb94 100644 --- a/lib/browser/modules/image-writer.js +++ b/lib/browser/modules/image-writer.js @@ -103,6 +103,7 @@ imageWriter.service('ImageWriterService', function($q, $timeout) { * * @param {String} image - image path * @param {Object} drive - drive + * @param {Function} onProgress - in progress callback (state) * * @returns {Promise} *