From 1b2a0b05d90426aad7f0172430fe1c20f0e7cff2 Mon Sep 17 00:00:00 2001 From: Ricordisamoa Date: Wed, 24 Feb 2016 03:47:10 +0100 Subject: [PATCH] build: Tweak jscs jsDoc rule 'checkAnnotations' and make pass * Don't override "private", the default is to require empty values for the tag * Move some @private tags after descriptions so the latter are not mistaken for tag values * Require some value for @context, @source and @see tags Change-Id: I583bb2ff3ec6537e1419732aaf1644ea8feb2255 --- .jscsrc | 7 +++---- resources/src/mediawiki/api/upload.js | 8 ++++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.jscsrc b/.jscsrc index 3b94b90f07..116c5cfbc8 100644 --- a/.jscsrc +++ b/.jscsrc @@ -10,10 +10,9 @@ "checkAnnotations": { "preset": "jsduck5", "extra": { - "context": true, - "source": true, - "see": true, - "private": true + "context": "some", + "source": "some", + "see": "some" } }, "checkParamNames": true, diff --git a/resources/src/mediawiki/api/upload.js b/resources/src/mediawiki/api/upload.js index 437ddec0d0..981a2e93c4 100644 --- a/resources/src/mediawiki/api/upload.js +++ b/resources/src/mediawiki/api/upload.js @@ -17,9 +17,9 @@ }; /** - * @private * Get nonce for iframe IDs on the page. * + * @private * @return {number} */ function getNonce() { @@ -27,9 +27,9 @@ } /** - * @private * Given a non-empty object, return one of its keys. * + * @private * @param {Object} obj * @return {string} */ @@ -42,9 +42,9 @@ } /** - * @private * Get new iframe object for an upload. * + * @private * @return {HTMLIframeElement} */ function getNewIframe( id ) { @@ -55,9 +55,9 @@ } /** - * @private * Shortcut for getting hidden inputs * + * @private * @return {jQuery} */ function getHiddenInput( name, val ) { -- 2.20.1