"es3": true,
"requireVarDeclFirst": null,
- "jsDoc": null,
"disallowQuotedKeysInObjects": "allButReserved",
"requireDotNotation": { "allExcept": [ "keywords" ] },
+ "jsDoc": {
+ "requireReturnTypes": true
+ },
"excludeFiles": [
"docs/**",
*
* @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 ) {
* 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' ],
* 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)
* jQuery plugin to fade or snap to hiding state.
*
* @param {boolean} [instantToggle=false]
- * @return jQuery
+ * @return {jQuery}
* @chainable
*/
$.fn.goOut = function ( instantToggle ) {
* @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 ) {
* 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
*/
*
* @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';
*
* @param {String[]} header
* @param {String[][]} data
- * @return jQuery
+ * @return {jQuery}
*/
function tableCreate( header, data ) {
var i,
* Extract text from table.
*
* @param {jQuery} $table
- * @return String[][]
+ * @return {String[][]}
*/
function tableExtract( $table ) {
var data = [];
* @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 */