From: Roan Kattouw Date: Thu, 27 Jul 2017 23:18:19 +0000 (-0700) Subject: Enable jsduck for resources/src/mediawiki.rcfilters and make pass X-Git-Tag: 1.31.0-rc.0~2559^2 X-Git-Url: http://git.heureux-cyclage.org/?a=commitdiff_plain;h=1cf0acaa628688f0ad94ee8ee320c538e57247d4;p=lhc%2Fweb%2Fwiklou.git Enable jsduck for resources/src/mediawiki.rcfilters and make pass Change-Id: I2a29689e2697108a5c5206cc61b36b5fb838182f --- diff --git a/jsduck.json b/jsduck.json index f7771d1a74..cbd46762dc 100644 --- a/jsduck.json +++ b/jsduck.json @@ -16,6 +16,7 @@ "resources/src/mediawiki.action", "resources/src/mediawiki.language", "resources/src/mediawiki.messagePoster", + "resources/src/mediawiki.rcfilters", "resources/src/mediawiki.special", "resources/src/mediawiki.toolbar", "resources/src/mediawiki.widgets", diff --git a/maintenance/jsduck/categories.json b/maintenance/jsduck/categories.json index 2c8c8b0f2f..899d80daa7 100644 --- a/maintenance/jsduck/categories.json +++ b/maintenance/jsduck/categories.json @@ -66,7 +66,8 @@ "mw.Upload*", "mw.ForeignUpload", "mw.ForeignStructuredUpload*", - "mw.GallerySlideshow" + "mw.GallerySlideshow", + "mw.rcfilters*" ] }, { diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js index 3281735bfb..4ea1e03625 100644 --- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js +++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js @@ -634,7 +634,7 @@ /** * Get the highlight parameters based on current filter configuration * - * @return {Object} Object where keys are "_color" and values + * @return {Object} Object where keys are `_color` and values * are the selected highlight colors. */ mw.rcfilters.dm.FiltersViewModel.prototype.getHighlightParameters = function () { @@ -656,7 +656,7 @@ * * @param {Object} representation Object containing representation of * some or all highlight values - * @return {Object} Object where keys are "_color" and values + * @return {Object} Object where keys are `_color` and values * are the selected highlight colors. The returned object * contains all available filters either with a color value * or with null. diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js index 85365702ea..29134a5f14 100644 --- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js +++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js @@ -2,6 +2,7 @@ /** * View model for saved queries * + * @class * @mixins OO.EventEmitter * @mixins OO.EmitterList * diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueryItemModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueryItemModel.js index 729aee3973..c066a1ff4a 100644 --- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueryItemModel.js +++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueryItemModel.js @@ -2,6 +2,7 @@ /** * View model for a single saved query * + * @class * @mixins OO.EventEmitter * * @constructor @@ -31,7 +32,7 @@ /* Events */ /** - * @update + * @event update * * Model has been updated */ @@ -63,7 +64,7 @@ /** * Get query label * - * @return {label} Query label + * @return {string} Query label */ mw.rcfilters.dm.SavedQueryItemModel.prototype.getLabel = function () { return this.label; diff --git a/resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js b/resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js index 82213ea532..842ebd7f12 100644 --- a/resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js +++ b/resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js @@ -2,7 +2,9 @@ /* eslint no-underscore-dangle: "off" */ /** * Controller for the filters in Recent Changes + * @class * + * @constructor * @param {mw.rcfilters.dm.FiltersViewModel} filtersModel Filters view model * @param {mw.rcfilters.dm.ChangesListViewModel} changesListModel Changes list view model * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model @@ -889,7 +891,7 @@ * Track usage of highlight feature * * @param {string} action - * @param {array|object|string} filters + * @param {Array|Object|string} filters */ mw.rcfilters.Controller.prototype._trackHighlight = function ( action, filters ) { filters = typeof filters === 'string' ? { name: filters } : filters; diff --git a/resources/src/mediawiki.rcfilters/mw.rcfilters.HighlightColors.js b/resources/src/mediawiki.rcfilters/mw.rcfilters.HighlightColors.js index ebeaad6ed5..0bef90282e 100644 --- a/resources/src/mediawiki.rcfilters/mw.rcfilters.HighlightColors.js +++ b/resources/src/mediawiki.rcfilters/mw.rcfilters.HighlightColors.js @@ -3,7 +3,8 @@ * Supported highlight colors. * Warning: These are also hardcoded in "styles/mw.rcfilters.variables.less" * - * @type {string[]} + * @member mw.rcfilters + * @property {string[]} */ mw.rcfilters.HighlightColors = [ 'c1', 'c2', 'c3', 'c4', 'c5' ]; }( mediaWiki ) ); diff --git a/resources/src/mediawiki.rcfilters/mw.rcfilters.init.js b/resources/src/mediawiki.rcfilters/mw.rcfilters.init.js index e758f26fcd..04a3fdaec7 100644 --- a/resources/src/mediawiki.rcfilters/mw.rcfilters.init.js +++ b/resources/src/mediawiki.rcfilters/mw.rcfilters.init.js @@ -2,12 +2,11 @@ * JavaScript for Special:RecentChanges */ ( function ( mw, $ ) { - /** - * @class mw.rcfilters - * @singleton - */ var rcfilters = { - /** */ + /** + * @member mw.rcfilters + * @private + */ init: function () { var filtersModel = new mw.rcfilters.dm.FiltersViewModel(), changesListModel = new mw.rcfilters.dm.ChangesListViewModel(), diff --git a/resources/src/mediawiki.rcfilters/mw.rcfilters.js b/resources/src/mediawiki.rcfilters/mw.rcfilters.js index 8cea27e46e..c62d6f25ab 100644 --- a/resources/src/mediawiki.rcfilters/mw.rcfilters.js +++ b/resources/src/mediawiki.rcfilters/mw.rcfilters.js @@ -1,4 +1,8 @@ ( function ( mw ) { + /** + * @class + * @singleton + */ mw.rcfilters = { dm: {}, ui: {}, diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ChangesLimitButtonWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ChangesLimitButtonWidget.js index 61ee4a529b..86d74bf652 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ChangesLimitButtonWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ChangesLimitButtonWidget.js @@ -2,6 +2,7 @@ /** * Widget defining the button controlling the popup for the number of results * + * @class * @extends OO.ui.Widget * * @constructor diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.DateButtonWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.DateButtonWidget.js index 1569f38662..870aef74d8 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.DateButtonWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.DateButtonWidget.js @@ -2,6 +2,7 @@ /** * Widget defining the button controlling the popup for the date range for the results * + * @class * @extends OO.ui.Widget * * @constructor diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterItemHighlightButton.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterItemHighlightButton.js index 835cec892e..7426123626 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterItemHighlightButton.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterItemHighlightButton.js @@ -52,7 +52,6 @@ /** * @static - * @inheritdoc */ mw.rcfilters.ui.FilterItemHighlightButton.static.cancelButtonMouseDownEvents = true; diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuHeaderWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuHeaderWidget.js index da71d70603..eeb5ddc2f3 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuHeaderWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuHeaderWidget.js @@ -2,6 +2,7 @@ /** * Menu header for the RCFilters filters menu * + * @class * @extends OO.ui.Widget * * @constructor diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuSectionOptionWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuSectionOptionWidget.js index 88479c3326..e053914e2a 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuSectionOptionWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuSectionOptionWidget.js @@ -2,6 +2,7 @@ /** * A widget representing a menu section for filter groups * + * @class * @extends OO.ui.MenuSectionOptionWidget * * @constructor diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterTagMultiselectWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterTagMultiselectWidget.js index 6a6790fba8..ac22258b33 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterTagMultiselectWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterTagMultiselectWidget.js @@ -2,6 +2,7 @@ /** * List displaying all filter groups * + * @class * @extends OO.ui.MenuTagMultiselectWidget * @mixins OO.ui.mixin.PendingElement * @@ -321,7 +322,7 @@ }; /** - * @inheridoc + * @inheritdoc */ mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onChangeTags = function () { // Parent method diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListItemWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListItemWidget.js index b6b20eeb1a..cac10596cb 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListItemWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListItemWidget.js @@ -2,6 +2,7 @@ /** * Quick links menu option widget * + * @class * @extends OO.ui.Widget * @mixins OO.ui.mixin.LabelElement * @mixins OO.ui.mixin.IconElement diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListWidget.js index 27a21d693c..7eda90a8f9 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListWidget.js @@ -2,6 +2,7 @@ /** * Quick links widget * + * @class * @extends OO.ui.Widget * * @constructor diff --git a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ValuePickerWidget.js b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ValuePickerWidget.js index 7045ab6b9c..ac0e50d5bf 100644 --- a/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ValuePickerWidget.js +++ b/resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ValuePickerWidget.js @@ -3,6 +3,7 @@ * Widget defining the behavior used to choose from a set of values * in a single_value group * + * @class * @extends OO.ui.Widget * @mixins OO.ui.mixin.LabelElement *