From 89f04ea5760c40a505b0b1dd14cce57e196f74e6 Mon Sep 17 00:00:00 2001 From: "James D. Forrester" Date: Sat, 5 Sep 2015 12:15:01 -0700 Subject: [PATCH] build: Enable jscs jsDoc rule 'checkRedundantReturns' and make pass Change-Id: I5006ea3df6798201edfacbf8ad4624266554f064 --- .jscsrc | 1 + resources/src/jquery/jquery.suggestions.js | 4 +++- .../mediawiki.messagePoster.MessagePoster.js | 1 + resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js | 1 - resources/src/mediawiki/mediawiki.htmlform.js | 4 ++-- 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.jscsrc b/.jscsrc index aaa876c3e2..46d98aa9db 100644 --- a/.jscsrc +++ b/.jscsrc @@ -7,6 +7,7 @@ "disallowQuotedKeysInObjects": "allButReserved", "requireDotNotation": { "allExcept": [ "keywords" ] }, "jsDoc": { + "checkRedundantReturns": true, "requireNewlineAfterDescription": true, "requireParamTypes": true, "requireReturnTypes": true diff --git a/resources/src/jquery/jquery.suggestions.js b/resources/src/jquery/jquery.suggestions.js index dc1c7794f6..4d5354633b 100644 --- a/resources/src/jquery/jquery.suggestions.js +++ b/resources/src/jquery/jquery.suggestions.js @@ -18,10 +18,11 @@ * * @class jQuery.plugin.suggestions */ + /** * @method suggestions - * @return {jQuery} * @chainable + * @return {jQuery} * * @param {Object} options * @@ -92,6 +93,7 @@ * @param {boolean} [options.highlightInput=false] Whether to highlight matched portions of the * input or not. */ + ( function ( $ ) { var hasOwn = Object.hasOwnProperty; diff --git a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js index 91366ff593..113fb00cd5 100644 --- a/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js +++ b/resources/src/mediawiki.messagePoster/mediawiki.messagePoster.MessagePoster.js @@ -16,6 +16,7 @@ /** * Post a message (with subject and body) to a talk page. * + * @abstract * @param {string} subject Subject/topic title; plaintext only (no wikitext or HTML) * @param {string} body Body, as wikitext. Signature code will automatically be added * by MessagePosters that require one, unless the message already contains the string diff --git a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js index 49acfefe4e..9535481d4b 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js @@ -152,7 +152,6 @@ * @param {string|null} [fade=null] Direction in which to fade out current calendar contents, * 'previous', 'next', 'up' or 'down'; or 'auto', which has the same result as 'previous' or * 'next' depending on whether the current date is later or earlier than the previous. - * @returns {string} Format */ mw.widgets.CalendarWidget.prototype.updateUI = function ( fade ) { var items, today, selected, currentMonth, currentYear, currentDay, i, needsFade, diff --git a/resources/src/mediawiki/mediawiki.htmlform.js b/resources/src/mediawiki/mediawiki.htmlform.js index 8c6f3ab9f6..c323e8df24 100644 --- a/resources/src/mediawiki/mediawiki.htmlform.js +++ b/resources/src/mediawiki/mediawiki.htmlform.js @@ -222,11 +222,11 @@ * @param {Function} callback * @param {boolean|jQuery.Event} callback.immediate True when the event is called immediately, * an event object when triggered from an event. - * @return {jQuery} * @chainable + * @return {jQuery} */ mw.log.deprecate( $.fn, 'liveAndTestAtStart', function ( callback ) { - this + return this // Can't really migrate to .on() generically, needs knowledge of // calling code to know the correct selector. Fix callers and // get rid of this .liveAndTestAtStart() hack. -- 2.20.1