diff options
Diffstat (limited to 'resources/src')
44 files changed, 92 insertions, 60 deletions
diff --git a/resources/src/mediawiki.widgets.datetime/CalendarWidget.js b/resources/src/mediawiki.widgets.datetime/CalendarWidget.js index 508b18728767..c8871f204965 100644 --- a/resources/src/mediawiki.widgets.datetime/CalendarWidget.js +++ b/resources/src/mediawiki.widgets.datetime/CalendarWidget.js @@ -1,8 +1,6 @@ ( function () { /** - * A widget for selecting a date from a calendar. - * * @classdesc CalendarWidget displays a calendar that can be used to select a date. It * uses {@link mw.widgets.datetime.DateTimeFormatter DateTimeFormatter} to get the details of * the calendar. @@ -16,6 +14,7 @@ * @mixes OO.ui.mixin.TabIndexedElement * * @constructor + * @description Create an instance of `mw.widgets.CalendarWidget`. * @param {Object} [config] Configuration options * @param {Object|mw.widgets.datetime.DateTimeFormatter} [config.formatter={}] Configuration options for * {@link mw.widgets.datetime.ProlepticGregorianDateTimeFormatter}, or an diff --git a/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js index 80fe6a242a97..11aa621a3fb1 100644 --- a/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js @@ -1,14 +1,13 @@ ( function () { /** - * Abstract class for datetime formatters. - * * @class * @classdesc Provides various methods needed for formatting dates and times. * @abstract * @mixes OO.EventEmitter * * @constructor + * @description Create an instance of `mw.widgets.datetime.DateTimeFormatter`. * @param {Object} [config] Configuration options * @param {string} [config.format='@default'] May be a key from the * {@link mw.widgets.datetime.DateTimeFormatter.formats}, or a format diff --git a/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js b/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js index 0b00f421b0e5..1b9fa262f0d8 100644 --- a/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js +++ b/resources/src/mediawiki.widgets.datetime/DateTimeInputWidget.js @@ -1,8 +1,6 @@ ( function () { /** - * A widget with a series of inputs for date and time. - * * @classdesc DateTimeInputWidgets can be used to input a date, a time, or * a date and time, in either UTC or the user's local timezone. * Please see the [OOUI documentation on MediaWiki](https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs) @@ -23,6 +21,7 @@ * @mixes OO.ui.mixin.FlaggedElement * * @constructor + * @description Create an instance of `mw.widgets.datetime.DateTimeInputWidget`. * @param {Object} [config] Configuration options * @param {string} [config.type='datetime'] Whether to act like a 'date', 'time', or 'datetime' input. * Affects values stored in the relevant `<input>` and the formatting and diff --git a/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js index e8c4df779795..c0adbcc1fa5f 100644 --- a/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/DiscordianDateTimeFormatter.js @@ -1,9 +1,9 @@ ( function () { /** - * A DateTimeFormatter for the Discordian calendar. + * @classdesc DateTimeFormatter for the Discordian calendar. * - * @classdesc Provides various methods needed for formatting dates and times. This + * Provides various methods needed for formatting dates and times. This * implementation implements the [Discordian calendar](https://en.wikipedia.org/wiki/Discordian_calendar), * mainly for testing with something very different from the usual Gregorian * calendar. @@ -15,6 +15,7 @@ * @extends mw.widgets.datetime.DateTimeFormatter * * @constructor + * @description Create an instance of `mw.widgets.datetime.DiscordianDateTimeFormatter`. * @param {Object} [config] Configuration options */ mw.widgets.datetime.DiscordianDateTimeFormatter = function MwWidgetsDatetimeDiscordianDateTimeFormatter( config ) { diff --git a/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js b/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js index aa98741a5b19..9e25c6c7c812 100644 --- a/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js +++ b/resources/src/mediawiki.widgets.datetime/ProlepticGregorianDateTimeFormatter.js @@ -1,9 +1,9 @@ ( function () { /** - * A DateTimeFormatter for the proleptic Gregorian calendar. + * @classdesc DateTimeFormatter for the proleptic Gregorian calendar. * - * @classdesc Provides various methods needed for formatting dates and times. This + * Provides various methods needed for formatting dates and times. This * implementation implements the proleptic Gregorian calendar over years * 0000–9999. * @@ -11,6 +11,7 @@ * @extends mw.widgets.datetime.DateTimeFormatter * * @constructor + * @description Create an instance of `mw.widgets.datetime.ProlepticGregorianDateTimeFormatter`. * @param {Object} [config] Configuration options * @param {Object} [config.fullMonthNames] Mapping 1–12 to full month names. * @param {Object} [config.shortMonthNames] Mapping 1–12 to abbreviated month names. diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js index 829e1b1bd147..790c9b56f6f6 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsProvider.js @@ -6,12 +6,13 @@ ( function () { /** - * API Results Provider object. + * @classdesc API results provider. * * @class * @mixes OO.EventEmitter * * @constructor + * @description Create an instance of `mw.widgets.APIResultsProvider`. * @param {string} apiurl The URL to the api * @param {Object} [config] Configuration options * @param {number} config.fetchLimit The default number of results to fetch diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js index 30b1631fcfb8..519fd962913b 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.APIResultsQueue.js @@ -6,7 +6,7 @@ ( function () { /** - * API Results Queue object. + * @classdesc API results queue. * * @class * @mixes OO.EventEmitter diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js index 53524455d807..4685df76883c 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceProvider.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media resource provider. + * @classdesc Media resource provider. * * @class * @extends mw.widgets.APIResultsProvider * * @constructor + * @description Create an instance of `mw.widgets.MediaResourceProvider`. * @param {string} apiurl The API url * @param {Object} [config] Configuration options * @param {string} [config.scriptDirUrl] The url of the API script diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js index ba789ca2ef66..1224575dc3e1 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResourceQueue.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media resource queue. + * @classdesc Media resource queue. * * @class * @extends mw.widgets.APIResultsQueue * * @constructor + * @description Create an instance of `mw.widgets.MediaResourceQueue`. * @param {Object} [config] Configuration options * @param {number} config.maxHeight The maximum height of the media, used in the * search call to the API. diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js index 40e7b028170f..f73c6d79bd17 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaResultWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Creates an mw.widgets.MediaResultWidget object. + * @classdesc Media result widget. * * @class * @extends OO.ui.OptionWidget * * @constructor + * @description Creates an mw.widgets.MediaResultWidget object. * @param {Object} [config] Configuration options * @param {number} [config.rowHeight] Height of the row this result is part of * @param {number} [config.maxRowWidth] A limit for the width of the row this diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js index da2cde39a226..c467bb810c45 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchProvider.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media search provider. + * @classdesc Media search provider. * * @class * @extends mw.widgets.MediaResourceProvider * * @constructor + * @description Create an instance of `mw.widgets.MediaSearchProvider`. * @param {string} apiurl The API url * @param {Object} [config] Configuration options */ diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js index 1d70cc339a1e..780c56773658 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchQueue.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media resource queue. + * @classdesc Media resource queue. * * @class * @extends mw.widgets.MediaResourceQueue * * @constructor + * @description Create an instance of `mw.widgets.MediaSearchQueue`. * @param {Object} [config] Configuration options * @param {number} config.maxHeight The maximum height of the media, used in the * search call to the API. diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js index d8a504dc9e29..63db3c6934a1 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaSearchWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Creates an mw.widgets.MediaSearchWidget object. + * @classdesc Media search widget. * * @class * @extends OO.ui.SearchWidget * * @constructor + * @description Creates an mw.widgets.MediaSearchWidget object. * @param {Object} [config] Configuration options * @param {number} [size] Vertical size of thumbnails */ diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsProvider.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsProvider.js index e95488c67b3f..6b4db30286a2 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsProvider.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsProvider.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media search provider. + * @classdesc User uploads provider. * * @class * @extends mw.widgets.MediaResourceProvider * * @constructor + * @description Create an instance of `mw.widgets.MediaUserUploadsProvider`. * @param {string} apiurl The API url * @param {Object} [config] Configuration options */ diff --git a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsQueue.js b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsQueue.js index 6d5da16add03..5995c1b1ba73 100644 --- a/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsQueue.js +++ b/resources/src/mediawiki.widgets/MediaSearch/mw.widgets.MediaUserUploadsQueue.js @@ -7,12 +7,13 @@ ( function () { /** - * MediaWiki media resource queue. + * @classdesc Media resource queue. * * @class * @extends mw.widgets.MediaResourceQueue * * @constructor + * @description Create an instance of `mw.widgets.MediaUserUploadsQueue`. * @param {Object} [config] Configuration options * @param {number} config.maxHeight The maximum height of the media, used in the * search call to the API. diff --git a/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidget.js b/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidget.js index 94e02a64fb9c..f66e2b1ecf0c 100644 --- a/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidget.js +++ b/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidget.js @@ -1,7 +1,7 @@ /** - * A RowWidget is used in conjunction with {@link mw.widgets.TableWidget table widgets} - * and should not be instantiated by themselves. They group together - * {@link OO.ui.TextInputWidget text input widgets} to form a unified row of + * @classdesc Table row widget. A RowWidget is used in conjunction with + * {@link mw.widgets.TableWidget table widgets} and should not be instantiated by themselves. + * They group together {@link OO.ui.TextInputWidget text input widgets} to form a unified row of * editable data. * * @class @@ -9,6 +9,7 @@ * @mixes OO.ui.mixin.GroupElement * * @constructor + * @description Create an instance of `mw.widgets.RowWidget`. * @param {Object} [config] Configuration options * @param {Array} [config.data] The data of the cells * @param {Array} [config.keys] An array of keys for easy cell selection diff --git a/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidgetModel.js b/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidgetModel.js index dbb3b0df172f..9deade450969 100644 --- a/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidgetModel.js +++ b/resources/src/mediawiki.widgets/Table/mw.widgets.RowWidgetModel.js @@ -5,12 +5,13 @@ */ /** - * RowWidget model. + * @classdesc RowWidget model. * * @class * @mixes OO.EventEmitter * * @constructor + * @description Create an instance of `mw.widgets.RowWidgetModel`. * @param {Object} [config] Configuration options * @param {Array} [config.data] An array containing all values of the row * @param {Array} [config.keys] An array of keys for easy cell selection diff --git a/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidget.js b/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidget.js index aa43dd460e71..5c188693c676 100644 --- a/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidget.js +++ b/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidget.js @@ -1,5 +1,5 @@ /** - * A TableWidget groups {@link mw.widgets.RowWidget row widgets} together to form a bidimensional + * @classdesc Groups {@link mw.widgets.RowWidget row widgets} together to form a bidimensional * grid of text inputs. * * @class @@ -7,6 +7,7 @@ * @mixes OO.ui.mixin.GroupElement * * @constructor + * @description Create an instance of `mw.widgets.TableWidget`. * @param {mw.widgets.TableWidgetModel~Config} [config] Configuration options */ mw.widgets.TableWidget = function MwWidgetsTableWidget( config ) { diff --git a/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidgetModel.js b/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidgetModel.js index 31c5b8459008..b557a88c603c 100644 --- a/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidgetModel.js +++ b/resources/src/mediawiki.widgets/Table/mw.widgets.TableWidgetModel.js @@ -18,12 +18,13 @@ */ /** - * TableWidget model. + * @classdesc TableWidget model. * * @class * @mixes OO.EventEmitter * * @constructor + * @description Create an instance of `mw.widgets.TableWidgetModel`. * @param {mw.widgets.TableWidgetModel~Config} [config] Configuration options */ mw.widgets.TableWidgetModel = function MwWidgetsTableWidgetModel( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.AbandonEditDialog.js b/resources/src/mediawiki.widgets/mw.widgets.AbandonEditDialog.js index 321b93b35e02..94b010fc9d9d 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.AbandonEditDialog.js +++ b/resources/src/mediawiki.widgets/mw.widgets.AbandonEditDialog.js @@ -6,7 +6,7 @@ */ /** - * Confirm dialog shown when the users is leaving an editor without saving. + * @classdesc Confirm dialog shown when the user is leaving an editor without saving. * * The `useeditwarning` user option should be checked before showing this dialog. * @@ -14,6 +14,7 @@ * @extends OO.ui.MessageDialog * * @constructor + * @description Create an instance of `mw.widgets.AbandonEditDialog`. * @param {Object} [config] Configuration options */ mw.widgets.AbandonEditDialog = function VeUiAbandonEditDialog( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js index 55365ee04c3f..0d94dfcb1b8f 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CalendarWidget.js @@ -8,9 +8,9 @@ ( function () { /** - * Creates an mw.widgets.CalendarWidget object. + * @classdesc Calendar widget. * - * You will most likely want to use mw.widgets.DateInputWidget instead of CalendarWidget directly. + * You will most likely want to use {@link mw.widgets.DateInputWidget} instead of CalendarWidget directly. * * @class * @extends OO.ui.Widget @@ -19,6 +19,7 @@ * @mixes OO.ui.mixin.ClippableElement * * @constructor + * @description Creates an mw.widgets.CalendarWidget object. * @param {Object} [config] Configuration options * @param {boolean} [config.lazyInitOnToggle=false] Don't build most of the interface until * `.toggle( true )` is called. Meant to be used when the calendar is not immediately visible. diff --git a/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js index ca441eeabeba..e25386168b03 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CategoryMultiselectWidget.js @@ -9,7 +9,7 @@ NS_CATEGORY = mw.config.get( 'wgNamespaceIds' ).category; /** - * Category selector widget. Displays an {@link OO.ui.MenuTagMultiselectWidget} + * @classdesc Displays an {@link OO.ui.MenuTagMultiselectWidget} * and autocompletes with available categories. * * @example @@ -32,6 +32,7 @@ * @mixes OO.ui.mixin.PendingElement * * @constructor + * @description Create an instance of `mw.widgets.CategoryMultiselectWidget`. * @param {Object} [config] Configuration options * @param {mw.Api} [config.api] Instance of mw.Api (or subclass thereof) to use for queries * @param {number} [config.limit=10] Maximum number of results to load diff --git a/resources/src/mediawiki.widgets/mw.widgets.CategoryTagItemWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CategoryTagItemWidget.js index 6d5aa37442b1..0ff725021636 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CategoryTagItemWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CategoryTagItemWidget.js @@ -111,14 +111,15 @@ }; /** - * Category selector tag item widget. Extends OO.ui.TagItemWidget with the ability to link - * to the given page, and to show its existence status (i.e., whether it is a redlink). + * @classdesc Extends OO.ui.TagItemWidget with the ability to link to the given page, + * and to show its existence status (whether it is a redlink). * * @class mw.widgets.CategoryTagItemWidget * @uses mw.Api * @extends OO.ui.TagItemWidget * * @constructor + * @description Create an instance of `mw.widgets.CategoryTagItemWidget`. * @param {Object} config Configuration options * @param {mw.Title} config.title Page title to use (required) * @param {string} [config.apiUrl] API URL, if not the current wiki's API diff --git a/resources/src/mediawiki.widgets/mw.widgets.CheckMatrixWidget.js b/resources/src/mediawiki.widgets/mw.widgets.CheckMatrixWidget.js index f7d4f211980a..1aedd5b88ffb 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CheckMatrixWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CheckMatrixWidget.js @@ -1,11 +1,12 @@ ( function () { /** - * A JavaScript version of CheckMatrixWidget. + * @classdesc A JavaScript version of CheckMatrixWidget. * * @class * @extends OO.ui.Widget * * @constructor + * @description Create an instance of `mw.widgets.CheckMatrixWidget`. * @param {Object} [config] Configuration options * @param {Object} config.columns Required object mapping column labels (as HTML) to * their tags. diff --git a/resources/src/mediawiki.widgets/mw.widgets.ComplexNamespaceInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.ComplexNamespaceInputWidget.js index 977a3f5442a1..c30a44f53bc8 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.ComplexNamespaceInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.ComplexNamespaceInputWidget.js @@ -7,13 +7,14 @@ ( function () { /** - * Namespace input widget. Displays a dropdown box with the choice of available namespaces, plus - * two checkboxes to include associated namespace or to invert selection. + * @classdesc Displays a dropdown box with the choice of available namespaces, + * plus two checkboxes to include associated namespace or to invert selection. * * @class * @extends OO.ui.Widget * * @constructor + * @description Create an instance of `mw.widgets.ComplexNamespaceInputWidget`. * @param {Object} [config] Configuration options * @param {Object} config.namespace Configuration for the NamespaceInputWidget dropdown with list * of namespaces diff --git a/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js index 26dbcc359b98..59b293223316 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.ComplexTitleInputWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Like TitleInputWidget, but the namespace has to be input through a separate dropdown field. + * @classdesc Like TitleInputWidget, but the namespace has to be input through a separate dropdown field. * * @class * @extends OO.ui.Widget * * @constructor + * @description Create an instance of `mw.widgets.ComplexTitleInputWidget`. * @param {Object} [config] Configuration options * @param {Object} config.namespace Configuration for the NamespaceInputWidget dropdown with list of * namespaces diff --git a/resources/src/mediawiki.widgets/mw.widgets.CopyTextLayout.js b/resources/src/mediawiki.widgets/mw.widgets.CopyTextLayout.js index 3373fb31f4ce..e431d6adc05c 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.CopyTextLayout.js +++ b/resources/src/mediawiki.widgets/mw.widgets.CopyTextLayout.js @@ -6,12 +6,13 @@ */ /** - * Extends CopyTextLayout with MediaWiki notifications. + * @classdesc Extends CopyTextLayout with MediaWiki notifications. * * @class * @extends OO.ui.CopyTextLayout * * @constructor + * @description Create an instance of `mw.widgets.CopyTextLayout`. * @param {Object} [config] Configuration options * @param {string} [config.successMessage] Success message, * defaults to the {@link mw.Message} 'mw-widgets-copytextlayout-copy-success'. diff --git a/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js index 43a07f8937d1..78599c375e7f 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.DateInputWidget.js @@ -8,7 +8,7 @@ ( function () { /** - * Creates an mw.widgets.DateInputWidget object. + * @classdesc Date input widget. * * @example * // Date input widget showcase @@ -60,6 +60,7 @@ * @mixes OO.ui.mixin.IndicatorElement * * @constructor + * @description Create an mw.widgets.DateInputWidget object. * @param {Object} [config] Configuration options * @param {string} [config.precision='day'] Date precision to use, 'day' or 'month' * @param {string} [config.value] Day or month date (depending on `precision`), in the format 'YYYY-MM-DD' diff --git a/resources/src/mediawiki.widgets/mw.widgets.ExpiryInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.ExpiryInputWidget.js index fbca3fd14c03..444e30c75d16 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.ExpiryInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.ExpiryInputWidget.js @@ -8,12 +8,13 @@ ( function () { /** - * Creates a mw.widgets.ExpiryWidget object. + * @classdesc Expiry widget. * * @class mw.widgets.ExpiryWidget * @extends OO.ui.Widget * * @constructor + * @description Create a mw.widgets.ExpiryWidget object. * @param {Object} [config] Configuration options */ mw.widgets.ExpiryWidget = function ( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js index beba51891b89..40652e617e0d 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.NamespaceInputWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Namespace input widget. Displays a dropdown box with the choice of available namespaces. + * @classdesc Displays a dropdown box with the choice of available namespaces. * * @class * @extends OO.ui.DropdownInputWidget * * @constructor + * @description Create an instance of `mw.widgets.NamespaceInputWidget`. * @param {Object} [config] Configuration options * @param {string|null} [config.includeAllValue] Value for "all namespaces" option, if any * @param {boolean} [config.userLang=false] Display namespaces in user language diff --git a/resources/src/mediawiki.widgets/mw.widgets.NamespacesMenuOptionWidget.js b/resources/src/mediawiki.widgets/mw.widgets.NamespacesMenuOptionWidget.js index 4c87518f6103..28293467216a 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.NamespacesMenuOptionWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.NamespacesMenuOptionWidget.js @@ -7,15 +7,14 @@ ( function () { /** - * Creates an mw.widgets.NamespacesMenuOptionWidget object. - * - * This MenuOptionWidget widget returns an item match text that includes - * both the label and the data, so the menu can filter on either. + * @classdesc Returns an item match text that includes both the label + * and the data, so the menu can filter on either. * * @class * @extends OO.ui.MenuOptionWidget * * @constructor + * @description Create an mw.widgets.NamespacesMenuOptionWidget object. * @param {Object} [config] Configuration options */ mw.widgets.NamespacesMenuOptionWidget = function MwWidgetsNamespacesMenuOptionWidget( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.NamespacesMultiselectWidget.js b/resources/src/mediawiki.widgets/mw.widgets.NamespacesMultiselectWidget.js index 8348106e4cc4..d18312f28a1e 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.NamespacesMultiselectWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.NamespacesMultiselectWidget.js @@ -7,7 +7,7 @@ ( function () { /** - * Creates an mw.widgets.NamespacesMultiselectWidget object. + * @classdesc Namespaces multiselect widget. * * TODO: A lot of this is duplicated in mw.widgets.UsersMultiselectWidget * and mw.widgets.TitlesMultiselectWidget. These classes should be @@ -17,6 +17,7 @@ * @extends OO.ui.MenuTagMultiselectWidget * * @constructor + * @description Create an mw.widgets.NamespacesMultiselectWidget object. * @param {Object} [config] Configuration options */ mw.widgets.NamespacesMultiselectWidget = function MwWidgetsNamespacesMultiselectWidget( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js index caf9c36d7dd4..dacf61427899 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.SearchInputWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Creates a mw.widgets.SearchInputWidget object. + * @classdesc Search input widget. * * @class * @extends mw.widgets.TitleInputWidget * * @constructor + * @description Create a mw.widgets.SearchInputWidget object. * @param {Object} [config] Configuration options * @param {boolean} [config.performSearchOnClick=true] If true, the script will start a search when- * ever a user hits a suggestion. If false, the text of the suggestion is inserted into the diff --git a/resources/src/mediawiki.widgets/mw.widgets.SelectWithInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.SelectWithInputWidget.js index c68fb52a3033..bdf5a8b08cb6 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.SelectWithInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.SelectWithInputWidget.js @@ -7,7 +7,7 @@ ( function () { /** - * Select with input widget. Displays an OO.ui.TextInputWidget along with + * @classdesc Select with input widget. Displays an OO.ui.TextInputWidget along with * an OO.ui.DropdownInputWidget. * TODO Explain the OTHER option * @@ -34,6 +34,7 @@ * @extends OO.ui.Widget * * @constructor + * @description Create an instance of `mw.widgets.SelectWithInputWidget`. * @param {Object} [config] Configuration options * @param {Object} [config.dropdowninput] Config for the dropdown * @param {Object} [config.textinput] Config for the text input diff --git a/resources/src/mediawiki.widgets/mw.widgets.SizeFilterWidget.js b/resources/src/mediawiki.widgets/mw.widgets.SizeFilterWidget.js index 16c9fe806235..d199ea9769ef 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.SizeFilterWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.SizeFilterWidget.js @@ -7,7 +7,7 @@ ( function () { /** - * RadioSelectInputWidget and a TextInputWidget to set minimum or maximum byte size. + * @classdesc Size filter widget. * * @example * mw.loader.using( 'mediawiki.widgets.SizeFilterWidget', function () { @@ -21,6 +21,7 @@ * @uses OO.ui.TextInputWidget * * @constructor + * @description Use a RadioSelectInputWidget and a TextInputWidget to set minimum or maximum byte size. * @param {Object} [config] Configuration options * @param {Object} [config.radioselectinput] Config for the radio select input * @param {Object} [config.textinput] Config for the text input diff --git a/resources/src/mediawiki.widgets/mw.widgets.TagMultiselectWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TagMultiselectWidget.js index bc55fa9b1d25..d7b770bef791 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TagMultiselectWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TagMultiselectWidget.js @@ -6,8 +6,7 @@ */ ( function () { /** - * TagMultiselectWidget can be used to input list of tags in a single - * line. + * @classdesc Input list of tags in a single line. * * This extends TagMultiselectWidget by adding an invisible textarea * element which will be used to submit the values of the tags @@ -19,6 +18,7 @@ * @extends OO.ui.TagMultiselectWidget * * @constructor + * @description Create an instance of `mw.widgets.TagMultiselectWidget`. * @param {Object} [config] Configuration options * @param {string} [config.name] Name of input to submit results (when used in HTML forms) */ diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js index ae0375d11d18..f99c65839a9c 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleInputWidget.js @@ -9,7 +9,7 @@ var trimByteLength = require( 'mediawiki.String' ).trimByteLength; /** - * Creates an mw.widgets.TitleInputWidget object. + * @classdesc Title input widget. * * @class * @extends OO.ui.TextInputWidget @@ -17,6 +17,7 @@ * @mixes OO.ui.mixin.LookupElement * * @constructor + * @description Create an mw.widgets.TitleInputWidget object. * @param {Object} [config] Configuration options * @param {boolean} [config.suggestions=true] Display search suggestions * @param {RegExp|Function|string} [config.validate] Perform title validation diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleOptionWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleOptionWidget.js index 953ddcaf1dc0..b557a768af75 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleOptionWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleOptionWidget.js @@ -7,12 +7,13 @@ ( function () { /** - * Creates a mw.widgets.TitleOptionWidget object. + * @classdesc Title option widget. * * @class * @extends OO.ui.MenuOptionWidget * * @constructor + * @description Create a mw.widgets.TitleOptionWidget object. * @param {Object} config Configuration options * @param {string} config.data Label to display * @param {string} config.url URL of page diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js index 84d5b67a27b7..9ef253975d39 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleSearchWidget.js @@ -7,7 +7,7 @@ ( function () { /** - * Creates an mw.widgets.TitleSearchWidget object. + * @classdesc Title search widget. * * @class * @extends OO.ui.SearchWidget @@ -15,6 +15,7 @@ * @mixes mw.widgets.TitleWidget * * @constructor + * @description Create an mw.widgets.TitleSearchWidget object. * @param {Object} [config] Configuration options */ mw.widgets.TitleSearchWidget = function MwWidgetsTitleSearchWidget( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js index 5f52067f8f1e..b8069c84878d 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitleWidget.js @@ -8,12 +8,13 @@ var hasOwn = Object.prototype.hasOwnProperty; /** - * Mixin for title widgets. + * @classdesc Mixin for title widgets. * * @class * @abstract * * @constructor + * @description Create an instance of `mw.widgets.TitleWidget`. * @param {Object} [config] Configuration options * @param {number} [config.limit=10] Number of results to show * @param {number} [config.namespace] Namespace to prepend to queries diff --git a/resources/src/mediawiki.widgets/mw.widgets.TitlesMultiselectWidget.js b/resources/src/mediawiki.widgets/mw.widgets.TitlesMultiselectWidget.js index 4ee219186b47..a6ac2d773437 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.TitlesMultiselectWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.TitlesMultiselectWidget.js @@ -7,7 +7,7 @@ ( function () { /** - * Creates an mw.widgets.TitlesMultiselectWidget object. + * @classdesc Titles multiselect widget. * * @class * @extends OO.ui.MenuTagMultiselectWidget @@ -16,6 +16,7 @@ * @mixes mw.widgets.TitleWidget * * @constructor + * @description Create an mw.widgets.TitlesMultiselectWidget object. * @param {Object} [config] Configuration options */ mw.widgets.TitlesMultiselectWidget = function MwWidgetsTitlesMultiselectWidget( config ) { diff --git a/resources/src/mediawiki.widgets/mw.widgets.ToggleSwitchWidget.js b/resources/src/mediawiki.widgets/mw.widgets.ToggleSwitchWidget.js index 59e94600c4e3..53825d0afa7b 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.ToggleSwitchWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.ToggleSwitchWidget.js @@ -6,13 +6,13 @@ */ ( function () { /** - * This extends ToggleSwitchWidget by adding an invisible checkbox - * element which will be used to submit the value. + * @classdesc Add an invisible checkbox element which will be used to submit the value. * * @class * @extends OO.ui.ToggleSwitchWidget * * @constructor + * @description Create an instance of `mw.widgets.ToggleSwitchWidget`. * @param {Object} [config] Configuration options * @param {string} [config.name] Name of input to submit results (when used in HTML forms) */ diff --git a/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js b/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js index 1d94ed2fa504..97852a843899 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.UserInputWidget.js @@ -7,13 +7,14 @@ ( function () { /** - * Creates a mw.widgets.UserInputWidget object. + * @classdesc User input widget. * * @class * @extends OO.ui.TextInputWidget * @mixes OO.ui.mixin.LookupElement * * @constructor + * @description Create a mw.widgets.UserInputWidget object. * @param {Object} [config] Configuration options * @param {number} [config.limit=10] Number of results to show * @param {mw.Api} [config.api] API object to use, creates a default mw.Api instance if not specified diff --git a/resources/src/mediawiki.widgets/mw.widgets.UsersMultiselectWidget.js b/resources/src/mediawiki.widgets/mw.widgets.UsersMultiselectWidget.js index f5eeda6370c8..f386193b5bfc 100644 --- a/resources/src/mediawiki.widgets/mw.widgets.UsersMultiselectWidget.js +++ b/resources/src/mediawiki.widgets/mw.widgets.UsersMultiselectWidget.js @@ -7,8 +7,7 @@ ( function () { /** - * UsersMultiselectWidget can be used to input list of users in a single - * line. + * @classdesc Input list of users in a single line. * * If used inside HTML form the results will be sent as the list of * newline-separated usernames. @@ -20,6 +19,7 @@ * @extends OO.ui.MenuTagMultiselectWidget * * @constructor + * @description Create an instance of `mw.widgets.UsersMultiselectWidget`. * @param {Object} [config] Configuration options * @param {mw.Api} [config.api] Instance of mw.Api (or subclass thereof) to use for queries * @param {number} [config.limit=10] Number of results to show in autocomplete menu |