Merge pull request #138 from resin-io/feat/jscs-jsdoc

Lint JSDoc annotations with JSCS
This commit is contained in:
Juan Cruz Viotti 2016-02-01 11:09:14 -04:00
commit 16cb141308
2 changed files with 22 additions and 0 deletions

21
.jscsrc
View File

@ -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, "disallowAnonymousFunctions": false,
"disallowShorthandArrowFunctions": true, "disallowShorthandArrowFunctions": true,
"disallowCapitalizedComments": false, "disallowCapitalizedComments": false,

View File

@ -103,6 +103,7 @@ imageWriter.service('ImageWriterService', function($q, $timeout) {
* *
* @param {String} image - image path * @param {String} image - image path
* @param {Object} drive - drive * @param {Object} drive - drive
* @param {Function} onProgress - in progress callback (state)
* *
* @returns {Promise} * @returns {Promise}
* *