From: James D. Forrester <jforrester@wikimedia.org>
Date: Sat, 5 Sep 2015 18:38:47 +0000 (-0700)
Subject: build: Enable jscs jsDoc rule 'requireReturnTypes' and make pass
X-Git-Tag: 1.31.0-rc.0~10119^2
X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=b159471dd1063e397f117305f8b65e075de58131;p=lhc%2Fweb%2Fwiklou.git

build: Enable jscs jsDoc rule 'requireReturnTypes' and make pass

Change-Id: I6a73e64b2cb87fef273a196c52a1e3bbeb4f7dda
---

diff --git a/.jscsrc b/.jscsrc
index 87cae78a2d..13f7f603b3 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -3,10 +3,12 @@
 	"es3": true,
 
 	"requireVarDeclFirst": null,
-	"jsDoc": null,
 
 	"disallowQuotedKeysInObjects": "allButReserved",
 	"requireDotNotation": { "allExcept": [ "keywords" ] },
+	"jsDoc": {
+		"requireReturnTypes": true
+	},
 
 	"excludeFiles": [
 		"docs/**",
diff --git a/resources/src/mediawiki.language/mediawiki.language.js b/resources/src/mediawiki.language/mediawiki.language.js
index 81baebe433..0d324ed358 100644
--- a/resources/src/mediawiki.language/mediawiki.language.js
+++ b/resources/src/mediawiki.language/mediawiki.language.js
@@ -90,7 +90,7 @@ $.extend( mw.language, {
 	 *
 	 * @param {string} gender 'male', 'female', or anything else for neutral.
 	 * @param {Array} forms List of gender forms
-	 * @return string
+	 * @return {string}
 	 */
 	gender: function ( gender, forms ) {
 		if ( !forms || forms.length === 0 ) {
diff --git a/resources/src/mediawiki.special/mediawiki.special.upload.js b/resources/src/mediawiki.special/mediawiki.special.upload.js
index 33548d79a9..677d26d798 100644
--- a/resources/src/mediawiki.special/mediawiki.special.upload.js
+++ b/resources/src/mediawiki.special/mediawiki.special.upload.js
@@ -266,7 +266,7 @@
 		 * TODO: Put SVG back after working around Firefox 7 bug <https://bugzilla.wikimedia.org/show_bug.cgi?id=31643>
 		 *
 		 * @param {File} file
-		 * @return boolean
+		 * @return {boolean}
 		 */
 		function fileIsPreviewable( file ) {
 			var known = [ 'image/png', 'image/gif', 'image/jpeg', 'image/svg+xml' ],
diff --git a/resources/src/mediawiki/mediawiki.confirmCloseWindow.js b/resources/src/mediawiki/mediawiki.confirmCloseWindow.js
index 8d1faa625b..b3cb758c97 100644
--- a/resources/src/mediawiki/mediawiki.confirmCloseWindow.js
+++ b/resources/src/mediawiki/mediawiki.confirmCloseWindow.js
@@ -93,7 +93,7 @@
 			 * an alert to the user if he/she want to leave this page. Returns false, if options.test() returns
 			 * false or the user cancelled the alert window (~don't leave the page), true otherwise.
 			 * @ignore
-			 * @return boolean
+			 * @return {boolean}
 			 */
 			trigger: function () {
 				// use confirm to show the message to the user (if options.text() is true)
diff --git a/resources/src/mediawiki/mediawiki.htmlform.js b/resources/src/mediawiki/mediawiki.htmlform.js
index adc0b0767e..8c6f3ab9f6 100644
--- a/resources/src/mediawiki/mediawiki.htmlform.js
+++ b/resources/src/mediawiki/mediawiki.htmlform.js
@@ -203,7 +203,7 @@
 	 * jQuery plugin to fade or snap to hiding state.
 	 *
 	 * @param {boolean} [instantToggle=false]
-	 * @return jQuery
+	 * @return {jQuery}
 	 * @chainable
 	 */
 	$.fn.goOut = function ( instantToggle ) {
@@ -222,7 +222,7 @@
 	 * @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
+	 * @return {jQuery}
 	 * @chainable
 	 */
 	mw.log.deprecate( $.fn, 'liveAndTestAtStart', function ( callback ) {
diff --git a/resources/src/mediawiki/mediawiki.inspect.js b/resources/src/mediawiki/mediawiki.inspect.js
index 9a18c721a8..6bebf4d3e6 100644
--- a/resources/src/mediawiki/mediawiki.inspect.js
+++ b/resources/src/mediawiki/mediawiki.inspect.js
@@ -101,7 +101,7 @@
 		 * document.
 		 *
 		 * @param {string} css CSS source
-		 * @return Selector counts
+		 * @return {Object} Selector counts
 		 * @return {number} return.selectors Total number of selectors
 		 * @return {number} return.matched Number of matched selectors
 		 */
diff --git a/resources/src/mediawiki/mediawiki.util.js b/resources/src/mediawiki/mediawiki.util.js
index 2a3542ceaa..beb1860a1a 100644
--- a/resources/src/mediawiki/mediawiki.util.js
+++ b/resources/src/mediawiki/mediawiki.util.js
@@ -113,7 +113,7 @@
 		 *
 		 * @since 1.18
 		 * @param str string Name of script (eg. 'api'), defaults to 'index'
-		 * @return string Address to script (eg. '/w/api.php' )
+		 * @return {string} Address to script (eg. '/w/api.php' )
 		 */
 		wikiScript: function ( str ) {
 			str = str || 'index';
diff --git a/tests/qunit/suites/resources/jquery/jquery.tablesorter.test.js b/tests/qunit/suites/resources/jquery/jquery.tablesorter.test.js
index be04b97984..759322a748 100644
--- a/tests/qunit/suites/resources/jquery/jquery.tablesorter.test.js
+++ b/tests/qunit/suites/resources/jquery/jquery.tablesorter.test.js
@@ -192,7 +192,7 @@
 	 *
 	 * @param {String[]} header
 	 * @param {String[][]} data
-	 * @return jQuery
+	 * @return {jQuery}
 	 */
 	function tableCreate( header, data ) {
 		var i,
@@ -223,7 +223,7 @@
 	 * Extract text from table.
 	 *
 	 * @param {jQuery} $table
-	 * @return String[][]
+	 * @return {String[][]}
 	 */
 	function tableExtract( $table ) {
 		var data = [];
diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js
index 1fc1b0e563..e7f4517548 100644
--- a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js
+++ b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js
@@ -95,7 +95,6 @@
 	 * @param {Function[]} tasks List of functions that perform tasks
 	 *  that may be asynchronous. Invoke the callback parameter when done.
 	 * @param {Function} complete Called when all tasks are done, or when the sequence is aborted.
-	 * @return
 	 */
 	function process( tasks, complete ) {
 		/*jshint latedef:false */