Enable jsduck for resources/src/mediawiki.rcfilters and make pass
authorRoan Kattouw <roan.kattouw@gmail.com>
Thu, 27 Jul 2017 23:18:19 +0000 (16:18 -0700)
committerRoan Kattouw <roan.kattouw@gmail.com>
Fri, 28 Jul 2017 01:16:47 +0000 (18:16 -0700)
Change-Id: I2a29689e2697108a5c5206cc61b36b5fb838182f

18 files changed:
jsduck.json
maintenance/jsduck/categories.json
resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js
resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js
resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueryItemModel.js
resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js
resources/src/mediawiki.rcfilters/mw.rcfilters.HighlightColors.js
resources/src/mediawiki.rcfilters/mw.rcfilters.init.js
resources/src/mediawiki.rcfilters/mw.rcfilters.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ChangesLimitButtonWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.DateButtonWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterItemHighlightButton.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuHeaderWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterMenuSectionOptionWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FilterTagMultiselectWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListItemWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.SavedLinksListWidget.js
resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.ValuePickerWidget.js

index f7771d1..cbd4676 100644 (file)
@@ -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",
index 2c8c8b0..899d80d 100644 (file)
@@ -66,7 +66,8 @@
                                        "mw.Upload*",
                                        "mw.ForeignUpload",
                                        "mw.ForeignStructuredUpload*",
-                                       "mw.GallerySlideshow"
+                                       "mw.GallerySlideshow",
+                                       "mw.rcfilters*"
                                ]
                        },
                        {
index 3281735..4ea1e03 100644 (file)
        /**
         * Get the highlight parameters based on current filter configuration
         *
-        * @return {Object} Object where keys are "<filter name>_color" and values
+        * @return {Object} Object where keys are `<filter name>_color` and values
         *                  are the selected highlight colors.
         */
        mw.rcfilters.dm.FiltersViewModel.prototype.getHighlightParameters = function () {
         *
         * @param {Object} representation Object containing representation of
         *  some or all highlight values
-        * @return {Object} Object where keys are "<filter name>_color" and values
+        * @return {Object} Object where keys are `<filter name>_color` and values
         *                  are the selected highlight colors. The returned object
         *                  contains all available filters either with a color value
         *                  or with null.
index 8536570..29134a5 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * View model for saved queries
         *
+        * @class
         * @mixins OO.EventEmitter
         * @mixins OO.EmitterList
         *
index 729aee3..c066a1f 100644 (file)
@@ -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;
index 82213ea..842ebd7 100644 (file)
@@ -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
         * 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;
index ebeaad6..0bef902 100644 (file)
@@ -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 ) );
index e758f26..04a3fda 100644 (file)
@@ -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(),
index 8cea27e..c62d6f2 100644 (file)
@@ -1,4 +1,8 @@
 ( function ( mw ) {
+       /**
+        * @class
+        * @singleton
+        */
        mw.rcfilters = {
                dm: {},
                ui: {},
index 61ee4a5..86d74bf 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * Widget defining the button controlling the popup for the number of results
         *
+        * @class
         * @extends OO.ui.Widget
         *
         * @constructor
index 1569f38..870aef7 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * Widget defining the button controlling the popup for the date range for the results
         *
+        * @class
         * @extends OO.ui.Widget
         *
         * @constructor
index 835cec8..7426123 100644 (file)
@@ -52,7 +52,6 @@
 
        /**
         * @static
-        * @inheritdoc
         */
        mw.rcfilters.ui.FilterItemHighlightButton.static.cancelButtonMouseDownEvents = true;
 
index da71d70..eeb5ddc 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * Menu header for the RCFilters filters menu
         *
+        * @class
         * @extends OO.ui.Widget
         *
         * @constructor
index 88479c3..e053914 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * A widget representing a menu section for filter groups
         *
+        * @class
         * @extends OO.ui.MenuSectionOptionWidget
         *
         * @constructor
index 6a6790f..ac22258 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * List displaying all filter groups
         *
+        * @class
         * @extends OO.ui.MenuTagMultiselectWidget
         * @mixins OO.ui.mixin.PendingElement
         *
        };
 
        /**
-        * @inheridoc
+        * @inheritdoc
         */
        mw.rcfilters.ui.FilterTagMultiselectWidget.prototype.onChangeTags = function () {
                // Parent method
index b6b20ee..cac1059 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * Quick links menu option widget
         *
+        * @class
         * @extends OO.ui.Widget
         * @mixins OO.ui.mixin.LabelElement
         * @mixins OO.ui.mixin.IconElement
index 27a21d6..7eda90a 100644 (file)
@@ -2,6 +2,7 @@
        /**
         * Quick links widget
         *
+        * @class
         * @extends OO.ui.Widget
         *
         * @constructor
index 7045ab6..ac0e50d 100644 (file)
@@ -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
         *