jenkins-bot has submitted this change and it was merged.
Change subject: build: Enable jscs jsDoc rule 'checkAnnotations' and make pass
......................................................................
build: Enable jscs jsDoc rule 'checkAnnotations' and make pass
Change-Id: I76abb1eb1f3e1a2e8a4c03f577a080f4889b3a6d
---
M .jscsrc
M modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
M modules/ve-mw/ce/ve.ce.MWResizableNode.js
M modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js
M modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
M modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
M modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
M modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
M modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
M modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
M modules/ve-mw/dm/models/ve.dm.MWTransclusionContentModel.js
M modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
M modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
M modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
M modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
M modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
M modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
M modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
M modules/ve-mw/init/ve.init.mw.Target.js
M modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
M modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
M modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
M modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js
M modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
M modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
M modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
M modules/ve-mw/ui/pages/ve.ui.MWCategoriesPage.js
M modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
M modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
M modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
34 files changed, 131 insertions(+), 122 deletions(-)
Approvals:
Cscott: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.jscsrc b/.jscsrc
index deae449..0a5a7af 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -1,5 +1,14 @@
{
"preset": "wikimedia",
- "jsDoc": null
+ "jsDoc": {
+ "checkAnnotations": {
+ "preset": "jsduck5",
+ "extra": {
+ "this": true,
+ "source": true,
+ "see": true
+ }
+ }
+ }
}
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
index b67ea9c..9f11a69 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
@@ -111,7 +111,7 @@
/**
* Set up an object that converts from the type to rdfa, based
* on the rdfaToType object in the model.
- * @returns {Object.<string,string>} A type to Rdfa conversion object
+ * @return {Object.<string,string>} A type to Rdfa conversion object
*/
ve.ce.MWBlockImageNode.prototype.getTypeToRdfa = function () {
var rdfa, obj = {};
diff --git a/modules/ve-mw/ce/ve.ce.MWResizableNode.js
b/modules/ve-mw/ce/ve.ce.MWResizableNode.js
index 4afab05..df7d097 100644
--- a/modules/ve-mw/ce/ve.ce.MWResizableNode.js
+++ b/modules/ve-mw/ce/ve.ce.MWResizableNode.js
@@ -31,7 +31,7 @@
*
* @param {number} width New image width
* @param {number} height New image height
- * @returns {Object} Attribute changes
+ * @return {Object} Attribute changes
*/
ve.ce.MWResizableNode.prototype.getAttributeChanges = function ( width, height
) {
var attrChanges =
ve.ce.ResizableNode.prototype.getAttributeChanges.call( this, width, height );
diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js
b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js
index 58543ea..8d3f9a3 100644
--- a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js
+++ b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js
@@ -50,7 +50,7 @@
/* Methods */
/**
- * @returns {Object}
+ * @return {Object}
*/
ve.dm.MWExternalLinkAnnotation.prototype.getComparableObject = function () {
return {
diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
index aa83ca4..24e8ac2 100644
--- a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
+++ b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
@@ -54,7 +54,7 @@
* Parse URL to get title it points to.
* @param {string} href
* @param {HTMLDocument|string} doc Document whose base URL to use, or base
URL as a string.
- * @returns {Object} Plain object with 'title' and 'hrefPrefix' keys.
+ * @return {Object} Plain object with 'title' and 'hrefPrefix' keys.
*/
ve.dm.MWInternalLinkAnnotation.static.getTargetDataFromHref = function ( href,
doc ) {
var relativeBase, relativeBaseRegex, relativeHref, matches;
@@ -110,7 +110,7 @@
* Normalize title for comparison purposes.
* E.g. capitalisation and underscores.
* @param {string} title Original title
- * @returns {string} Normalized title, or the original if it is invalid
+ * @return {string} Normalized title, or the original if it is invalid
*/
ve.dm.MWInternalLinkAnnotation.static.normalizeTitle = function ( original ) {
var title = mw.Title.newFromText( original );
@@ -123,7 +123,7 @@
/**
* Normalize title for lookup (search suggestion, existence) purposes.
* @param {string} title Original title
- * @returns {string} Normalized title, or the original if it is invalid
+ * @return {string} Normalized title, or the original if it is invalid
*/
ve.dm.MWInternalLinkAnnotation.static.getLookupTitle = function ( original ) {
var title = mw.Title.newFromText( original );
diff --git a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
index 85b3864..a3d8dba 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
@@ -89,7 +89,7 @@
* Override parent method and get results from the source
*
* @param {number} [howMany] The number of items to pull from the API
- * @returns {jQuery.Promise} Promise that is resolved into an array
+ * @return {jQuery.Promise} Promise that is resolved into an array
* of available results, or is rejected if no results are available.
*/
ve.dm.MWMediaResourceProvider.prototype.getResults = function ( howMany ) {
@@ -212,7 +212,7 @@
/**
* Get name
*
- * @returns {string} name
+ * @return {string} name
*/
ve.dm.MWMediaResourceProvider.prototype.getName = function () {
return this.name;
@@ -269,7 +269,7 @@
/**
* Get thumb sizes
*
- * @returns {number[]} sizes Available thumbnail sizes
+ * @return {number[]} sizes Available thumbnail sizes
*/
ve.dm.MWMediaResourceProvider.prototype.getThumbSizes = function () {
return this.thumbSizes;
@@ -278,7 +278,7 @@
/**
* Get image sizes
*
- * @returns {number[]} sizes Available image sizes
+ * @return {number[]} sizes Available image sizes
*/
ve.dm.MWMediaResourceProvider.prototype.getImageSizes = function () {
return this.imageSizes;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
b/modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
index 5576074..2dc22d6 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
@@ -44,7 +44,7 @@
* Check if parameter is required.
*
* @method
- * @returns {boolean} Parameter is required
+ * @return {boolean} Parameter is required
*/
ve.dm.MWParameterModel.prototype.isRequired = function () {
return this.template.getSpec().isParameterRequired( this.name );
@@ -55,7 +55,7 @@
*
* @method
* @param {string} name Parameter name
- * @returns {boolean} Parameter is suggested
+ * @return {boolean} Parameter is suggested
*/
ve.dm.MWParameterModel.prototype.isSuggested = function () {
return this.template.getSpec().isParameterSuggested( this.name );
@@ -65,7 +65,7 @@
* Check if parameter is deprecated.
*
* @method
- * @returns {boolean} Parameter is deprecated
+ * @return {boolean} Parameter is deprecated
*/
ve.dm.MWParameterModel.prototype.isDeprecated = function () {
return this.template.getSpec().isParameterDeprecated( this.name );
@@ -74,7 +74,7 @@
/**
* Get template of which this parameter is part.
*
- * @returns {ve.dm.MWTemplateModel} Template
+ * @return {ve.dm.MWTemplateModel} Template
*/
ve.dm.MWParameterModel.prototype.getTemplate = function () {
return this.template;
@@ -83,7 +83,7 @@
/**
* Get unique parameter ID within the transclusion.
*
- * @returns {string} Unique ID
+ * @return {string} Unique ID
*/
ve.dm.MWParameterModel.prototype.getId = function () {
return this.id;
@@ -92,7 +92,7 @@
/**
* Get parameter name.
*
- * @returns {string} Parameter name
+ * @return {string} Parameter name
*/
ve.dm.MWParameterModel.prototype.getName = function () {
return this.name;
@@ -101,7 +101,7 @@
/**
* Get parameter name.
*
- * @returns {string} Parameter name
+ * @return {string} Parameter name
*/
ve.dm.MWParameterModel.prototype.getOriginalName = function () {
return this.originalName;
@@ -110,7 +110,7 @@
/**
* Get parameter value.
*
- * @returns {string} Parameter value, or automatic value if there is none
stored.
+ * @return {string} Parameter value, or automatic value if there is none
stored.
* Otherwise an empty string.
*/
ve.dm.MWParameterModel.prototype.getValue = function () {
@@ -120,7 +120,7 @@
/**
* Get default parameter value.
*
- * @returns {string} Default parameter value
+ * @return {string} Default parameter value
*/
ve.dm.MWParameterModel.prototype.getDefaultValue = function () {
return this.template.getSpec().getParameterDefaultValue( this.name );
@@ -129,7 +129,7 @@
/**
* Get default parameter value.
*
- * @returns {string} Default parameter value
+ * @return {string} Default parameter value
*/
ve.dm.MWParameterModel.prototype.getExampleValue = function () {
return this.template.getSpec().getParameterExampleValue( this.name );
@@ -138,7 +138,7 @@
/**
* Get automatic parameter value.
*
- * @returns {string} Automatic parameter name.
+ * @return {string} Automatic parameter name.
*/
ve.dm.MWParameterModel.prototype.getAutoValue = function () {
return this.template.getSpec().getParameterAutoValue( this.name );
diff --git a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
index 69fbef2..7ec0546 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
@@ -183,7 +183,7 @@
/**
* Get the key of a reference in the references list.
*
- * @returns {string} Reference's list key
+ * @return {string} Reference's list key
*/
ve.dm.MWReferenceModel.prototype.getListKey = function () {
return this.listKey;
@@ -192,7 +192,7 @@
/**
* Get the name of the group a references list is in.
*
- * @returns {string} References list's group
+ * @return {string} References list's group
*/
ve.dm.MWReferenceModel.prototype.getListGroup = function () {
return this.listGroup;
@@ -201,7 +201,7 @@
/**
* Get the index of reference in the references list.
*
- * @returns {string} Reference's index
+ * @return {string} Reference's index
*/
ve.dm.MWReferenceModel.prototype.getListIndex = function () {
return this.listIndex;
@@ -210,7 +210,7 @@
/**
* Get the name of the group a reference is in.
*
- * @returns {string} Reference's group
+ * @return {string} Reference's group
*/
ve.dm.MWReferenceModel.prototype.getGroup = function () {
return this.group;
@@ -263,7 +263,7 @@
/**
* Get the directionality of the reference document
- * @returns {string} Document directionality
+ * @return {string} Document directionality
*/
ve.dm.MWReferenceModel.prototype.getDir = function () {
return this.dir;
@@ -279,7 +279,7 @@
/**
* Get the language of the reference document
- * @returns {string} Document language
+ * @return {string} Document language
*/
ve.dm.MWReferenceModel.prototype.getLang = function () {
return this.lang;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
index 2ca256d..049e29f 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
@@ -57,7 +57,7 @@
*
* @param {ve.dm.MWTransclusionModel} transclusion Transclusion template is in
* @param {Object} data Template data
- * @returns {ve.dm.MWTemplateModel} New template model
+ * @return {ve.dm.MWTemplateModel} New template model
*/
ve.dm.MWTemplateModel.newFromData = function ( transclusion, data ) {
var key,
@@ -82,7 +82,7 @@
*
* @param {ve.dm.MWTransclusionModel} transclusion Transclusion template is in
* @param {string|mw.Title} name Template name
- * @returns {ve.dm.MWTemplateModel|null} New template model
+ * @return {ve.dm.MWTemplateModel|null} New template model
*/
ve.dm.MWTemplateModel.newFromName = function ( transclusion, name ) {
var href, title,
@@ -106,7 +106,7 @@
/**
* Get template target.
*
- * @returns {Object} Template target
+ * @return {Object} Template target
*/
ve.dm.MWTemplateModel.prototype.getTarget = function () {
return this.target;
@@ -115,7 +115,7 @@
/**
* Get template title.
*
- * @returns {string|null} Template title, if available
+ * @return {string|null} Template title, if available
*/
ve.dm.MWTemplateModel.prototype.getTitle = function () {
return this.title;
@@ -124,7 +124,7 @@
/**
* Get template specification.
*
- * @returns {ve.dm.MWTemplateSpecModel} Template specification
+ * @return {ve.dm.MWTemplateSpecModel} Template specification
*/
ve.dm.MWTemplateModel.prototype.getSpec = function () {
return this.spec;
@@ -133,7 +133,7 @@
/**
* Get all params.
*
- * @returns {Object.<string,ve.dm.MWParameterModel>} Parameters keyed by name
+ * @return {Object.<string,ve.dm.MWParameterModel>} Parameters keyed by name
*/
ve.dm.MWTemplateModel.prototype.getParameters = function () {
return this.params;
@@ -143,7 +143,7 @@
* Get a parameter.
*
* @param {string} name Parameter name
- * @returns {ve.dm.MWParameterModel} Parameter
+ * @return {ve.dm.MWParameterModel} Parameter
*/
ve.dm.MWTemplateModel.prototype.getParameter = function ( name ) {
return this.params[ name ];
@@ -153,7 +153,7 @@
* Check if a parameter exists.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter exists
+ * @return {boolean} Parameter exists
*/
ve.dm.MWTemplateModel.prototype.hasParameter = function ( name ) {
var i, len, primaryName, names;
@@ -188,7 +188,7 @@
* Numeric names, whether strings or real numbers, are placed at the begining,
followed by
* alphabetically sorted names.
*
- * @returns {string[]} List of parameter names
+ * @return {string[]} List of parameter names
*/
ve.dm.MWTemplateModel.prototype.getParameterNames = function () {
var i, len, index, paramOrder, paramNames;
@@ -241,7 +241,7 @@
* Get parameter from its ID.
*
* @param {string} id Parameter ID
- * @returns {ve.dm.MWParameterModel|null} Parameter with matching ID, null if
no parameters match
+ * @return {ve.dm.MWParameterModel|null} Parameter with matching ID, null if
no parameters match
*/
ve.dm.MWTemplateModel.prototype.getParameterFromId = function ( id ) {
var name;
@@ -291,7 +291,7 @@
* Add all non-existing required and suggested parameters, if any.
*
* @method
- * @returns {number} Number of parameters added
+ * @return {number} Number of parameters added
*/
ve.dm.MWTemplateModel.prototype.addPromptedParameters = function () {
var i, len, addedCount = 0,
@@ -317,7 +317,7 @@
/**
* Set original data, to be used as a base for serialization.
*
- * @returns {Object} Template data
+ * @return {Object} Template data
*/
ve.dm.MWTemplateModel.prototype.setOriginalData = function ( data ) {
this.originalData = data;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
index 0d103c8..5857ab3 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
@@ -97,7 +97,7 @@
* Get the default spec for a parameter.
*
* @param {string} name Parameter name
- * @returns {Object} Parameter spec
+ * @return {Object} Parameter spec
*/
ve.dm.MWTemplateSpecModel.prototype.getDefaultParameterSpec = function ( name
) {
return {
@@ -116,7 +116,7 @@
/**
* Get template label.
*
- * @returns {string} Template label
+ * @return {string} Template label
*/
ve.dm.MWTemplateSpecModel.prototype.getLabel = function () {
var titleObj,
@@ -138,7 +138,7 @@
* Get template description.
*
* @param {string} [lang] Language to get description in
- * @returns {string|null} Template description or null if not available
+ * @return {string|null} Template description or null if not available
*/
ve.dm.MWTemplateSpecModel.prototype.getDescription = function ( lang ) {
var value = this.description;
@@ -149,7 +149,7 @@
* Get parameter order.
*
* @method
- * @returns {string[]} Canonically ordered parameter names
+ * @return {string[]} Canonically ordered parameter names
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterOrder = function () {
return this.paramOrder.slice();
@@ -161,7 +161,7 @@
* Could be a primary name or alias.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter name is known
+ * @return {boolean} Parameter name is known
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterKnown = function ( name ) {
return this.params[ name ] !== undefined;
@@ -171,7 +171,7 @@
* Check if a parameter name is an alias.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter name is an alias
+ * @return {boolean} Parameter name is an alias
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterAlias = function ( name ) {
return this.params[ name ] !== undefined && this.params[ name ].name
!== name;
@@ -182,7 +182,7 @@
*
* @param {string} name Parameter name
* @param {string} [lang] Language to get label in
- * @returns {string} Parameter label
+ * @return {string} Parameter label
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterLabel = function ( name, lang
) {
var value = this.params[ name ].label || name;
@@ -194,7 +194,7 @@
*
* @param {string} name Parameter name
* @param {string} [lang] Language to get description
- * @returns {string|null} Parameter description
+ * @return {string|null} Parameter description
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterDescription = function ( name,
lang ) {
var value = this.params[ name ].description;
@@ -205,7 +205,7 @@
* Get a parameter value.
*
* @param {string} name Parameter name
- * @returns {string} Default parameter value
+ * @return {string} Default parameter value
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterDefaultValue = function ( name
) {
return this.params[ name ].default;
@@ -216,7 +216,7 @@
*
* @param {string} name Parameter name
* @param {string} [lang] Language to get description
- * @returns {string} Example parameter value
+ * @return {string} Example parameter value
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterExampleValue = function (
name, lang ) {
var value = this.params[ name ].example;
@@ -227,7 +227,7 @@
* Get a parameter auto value.
*
* @param {string} name Parameter name
- * @returns {string} Auto-value for the parameter
+ * @return {string} Auto-value for the parameter
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterAutoValue = function ( name ) {
return this.params[ name ].autovalue;
@@ -237,7 +237,7 @@
* Get a parameter type.
*
* @param {string} name Parameter name
- * @returns {string} Parameter type
+ * @return {string} Parameter type
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterType = function ( name ) {
return this.params[ name ].type;
@@ -247,7 +247,7 @@
* Get parameter aliases.
*
* @param {string} name Parameter name
- * @returns {string[]} Alternate parameter names
+ * @return {string[]} Alternate parameter names
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterAliases = function ( name ) {
return this.params[ name ].aliases;
@@ -259,7 +259,7 @@
* If a parameter is not an alias of another, the output will be the same as
the input.
*
* @param {string} name Parameter alias
- * @returns {string} Parameter name
+ * @return {string} Parameter name
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterName = function ( name ) {
return this.params[ name ].name;
@@ -269,7 +269,7 @@
* Check if parameter is required.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter is required
+ * @return {boolean} Parameter is required
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterRequired = function ( name ) {
return !!this.params[ name ].required;
@@ -279,7 +279,7 @@
* Check if parameter is suggsted.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter is suggested
+ * @return {boolean} Parameter is suggested
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterSuggested = function ( name ) {
return !!this.params[ name ].suggested;
@@ -289,7 +289,7 @@
* Check if parameter is deprecated.
*
* @param {string} name Parameter name
- * @returns {boolean} Parameter is deprecated
+ * @return {boolean} Parameter is deprecated
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterDeprecated = function ( name ) {
return this.params[ name ].deprecated !== false;
@@ -299,7 +299,7 @@
* Get parameter deprecation description.
*
* @param {string} name Parameter name
- * @returns {string} Explaining of why parameter is deprecated, empty if
parameter is either not
+ * @return {string} Explaining of why parameter is deprecated, empty if
parameter is either not
* deprecated or no description has been specified
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterDeprecationDescription =
function ( name ) {
@@ -310,7 +310,7 @@
/**
* Get all primary parameter names.
*
- * @returns {string[]} Parameter names
+ * @return {string[]} Parameter names
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterNames = function () {
var name,
@@ -328,7 +328,7 @@
/**
* Get parameter sets.
*
- * @returns {Object[]} Lists of parameter set descriptors
+ * @return {Object[]} Lists of parameter set descriptors
*/
ve.dm.MWTemplateSpecModel.prototype.getParameterSets = function () {
return this.sets;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTransclusionContentModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTransclusionContentModel.js
index 3d93f1a..2be179f 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTransclusionContentModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTransclusionContentModel.js
@@ -38,7 +38,7 @@
/**
* Get content value.
*
- * @returns {string} Content value
+ * @return {string} Content value
*/
ve.dm.MWTransclusionContentModel.prototype.getValue = function () {
return this.value;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
index b1238e6..e3b2629 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
@@ -87,7 +87,7 @@
* Load from transclusion data, and fetch spec from server.
*
* @param {Object} data Transclusion data
- * @returns {jQuery.Promise} Promise, resolved when spec is loaded
+ * @return {jQuery.Promise} Promise, resolved when spec is loaded
*/
ve.dm.MWTransclusionModel.prototype.load = function ( data ) {
var i, len, part, deferred,
@@ -309,7 +309,7 @@
/**
* Get plain object representation of template transclusion.
*
- * @returns {Object|null} Plain object representation, or null if empty
+ * @return {Object|null} Plain object representation, or null if empty
*/
ve.dm.MWTransclusionModel.prototype.getPlainObject = function () {
var i, len, part, serialization,
@@ -333,7 +333,7 @@
/**
* Get the wikitext for this transclusion.
*
- * @returns {string} Wikitext like `{{foo|1=bar|baz=quux}}`
+ * @return {string} Wikitext like `{{foo|1=bar|baz=quux}}`
*/
ve.dm.MWTransclusionModel.prototype.getWikitext = function () {
var i, len,
@@ -351,7 +351,7 @@
*
* This is used to give parts unique IDs, and returns a different value
each time it's called.
*
- * @returns {number} Unique ID
+ * @return {number} Unique ID
*/
ve.dm.MWTransclusionModel.prototype.getUniquePartId = function () {
return this.uid++;
@@ -366,7 +366,7 @@
* @param {ve.dm.MWTransclusionPartModel} add Part to add
* @throws {Error} If part to remove is not valid
* @throws {Error} If part to add is not valid
- * @returns {jQuery.Promise} Promise, resolved when part is added
+ * @return {jQuery.Promise} Promise, resolved when part is added
*/
ve.dm.MWTransclusionModel.prototype.replacePart = function ( remove,
add ) {
var deferred = $.Deferred();
@@ -393,7 +393,7 @@
* @param {ve.dm.MWTransclusionPartModel} part Part to add
* @param {number} [index] Specific index to add content at, defaults
to the end
* @throws {Error} If part is not valid
- * @returns {jQuery.Promise} Promise, resolved when part is added
+ * @return {jQuery.Promise} Promise, resolved when part is added
*/
ve.dm.MWTransclusionModel.prototype.addPart = function ( part, index ) {
var deferred = $.Deferred();
@@ -427,7 +427,7 @@
/**
* Get all parts.
*
- * @returns {ve.dm.MWTransclusionPartModel[]} Parts in transclusion
+ * @return {ve.dm.MWTransclusionPartModel[]} Parts in transclusion
*/
ve.dm.MWTransclusionModel.prototype.getParts = function () {
return this.parts;
@@ -439,7 +439,7 @@
* Matching is performed against the first section of the `id`,
delimited by a '/'.
*
* @param {string} id Part ID
- * @returns {ve.dm.MWTransclusionPartModel|null} Part with matching ID,
if found
+ * @return {ve.dm.MWTransclusionPartModel|null} Part with matching ID,
if found
*/
ve.dm.MWTransclusionModel.prototype.getPartFromId = function ( id ) {
var i, len,
@@ -461,7 +461,7 @@
* Indexes are linear depth-first addresses in the transclusion tree.
*
* @param {ve.dm.MWTransclusionPartModel|ve.dm.MWParameterModel} model
Part or parameter
- * @returns {number} Page index of model
+ * @return {number} Page index of model
*/
ve.dm.MWTransclusionModel.prototype.getIndex = function ( model ) {
var i, iLen, j, jLen, part, names,
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
index 0657c9a..076ac9c 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTransclusionPartModel.js
@@ -38,7 +38,7 @@
/**
* Get transclusion part is in.
*
- * @returns {ve.dm.MWTransclusionModel} Transclusion
+ * @return {ve.dm.MWTransclusionModel} Transclusion
*/
ve.dm.MWTransclusionPartModel.prototype.getTransclusion = function () {
return this.transclusion;
@@ -47,7 +47,7 @@
/**
* Get a unique part ID within the transclusion.
*
- * @returns {string} Unique ID
+ * @return {string} Unique ID
*/
ve.dm.MWTransclusionPartModel.prototype.getId = function () {
return this.id;
@@ -63,7 +63,7 @@
/**
* Get serialized representation of transclusion part.
*
- * @returns {Mixed} Serialized representation, or undefined if empty
+ * @return {Mixed} Serialized representation, or undefined if empty
*/
ve.dm.MWTransclusionPartModel.prototype.serialize = function () {
return undefined;
@@ -72,7 +72,7 @@
/**
* Get the wikitext for this part.
*
- * @returns {string} Wikitext
+ * @return {string} Wikitext
*/
ve.dm.MWTransclusionPartModel.prototype.getWikitext = function () {
return '';
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
index 2b7cde3..52a94bf 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWBlockImageNode.js
@@ -238,7 +238,7 @@
* Get the caption node of the image.
*
* @method
- * @returns {ve.dm.MWImageCaptionNode|null} Caption node, if present
+ * @return {ve.dm.MWImageCaptionNode|null} Caption node, if present
*/
ve.dm.MWBlockImageNode.prototype.getCaptionNode = function () {
var node = this.children[ 0 ];
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
index a3a1050..fd4df92 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
@@ -113,7 +113,7 @@
*
* @static
* @param {Object} dataElement Data element
- * @returns {string} Extension name
+ * @return {string} Extension name
*/
ve.dm.MWExtensionNode.static.getExtensionName = function () {
return this.extensionName;
@@ -124,7 +124,7 @@
/**
* Get the extension's name
* @method
- * @returns {string} Extension name
+ * @return {string} Extension name
*/
ve.dm.MWExtensionNode.prototype.getExtensionName = function () {
return this.constructor.static.getExtensionName( this.element );
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
index 55a307a..316447a 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
@@ -91,7 +91,7 @@
* Translate the image dimensions into new ones according to the bounding box.
* @param {Object} imageDimension Width and height of the image
* @param {Object} boundingBox The limit of the bounding box
- * @returns {Object} The new width and height of the scaled image.
+ * @return {Object} The new width and height of the scaled image.
*/
ve.dm.MWImageNode.static.resizeToBoundingBox = function ( imageDimensions,
boundingBox ) {
var newDimensions = ve.copy( imageDimensions ),
@@ -161,7 +161,7 @@
/**
* Get the scalable promise which fetches original dimensions from the API
* @param {string} filename The image filename whose details the scalable will
represent
- * @returns {jQuery.Promise} Promise which resolves after the image size
details are fetched from the API
+ * @return {jQuery.Promise} Promise which resolves after the image size
details are fetched from the API
*/
ve.dm.MWImageNode.static.getScalablePromise = function ( filename ) {
// On the first call set off an async call to update the scalable's
@@ -199,7 +199,7 @@
/**
* Get the normalised filename of the image
*
- * @returns {string} Filename
+ * @return {string} Filename
*/
ve.dm.MWImageNode.prototype.getFilename = function () {
// Strip ./ stuff and decode URI encoding
@@ -212,7 +212,7 @@
/**
* Get the store hash for the original dimensions of the image
*
- * @returns {string} Store hash
+ * @return {string} Store hash
*/
ve.dm.MWImageNode.prototype.getSizeHash = function () {
return 'MWImageOriginalSize:' + this.getFilename();
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
index 306fc26..23df152 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWTransclusionNode.js
@@ -192,7 +192,7 @@
*
* @static
* @param {string} param Parameter value
- * @returns {string} Escaped parameter value
+ * @return {string} Escaped parameter value
*/
ve.dm.MWTransclusionNode.static.escapeParameter = function ( param ) {
var match, needsNowiki,
@@ -316,7 +316,7 @@
/**
* Get a simplified description of the transclusion's parts.
*
- * @returns {Object[]} List of objects with either template or content
properties
+ * @return {Object[]} List of objects with either template or content
properties
*/
ve.dm.MWTransclusionNode.prototype.getPartsList = function () {
var i, len, part, content;
@@ -341,7 +341,7 @@
* Get the wikitext for this transclusion.
*
* @method
- * @returns {string} Wikitext like `{{foo|1=bar|baz=quux}}`
+ * @return {string} Wikitext like `{{foo|1=bar|baz=quux}}`
*/
ve.dm.MWTransclusionNode.prototype.getWikitext = function () {
var i, len, part, template, param,
diff --git a/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
b/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
index edaf131..28a96cf 100644
--- a/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
+++ b/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
@@ -70,7 +70,7 @@
* returns an already-resolved promise. Otherwise, it returns a pending
promise and schedules
* an request to retrieve the data.
* @param {string} title Title
- * @returns {jQuery.Promise} Promise that will be resolved with the data once
it's available
+ * @return {jQuery.Promise} Promise that will be resolved with the data once
it's available
*/
ve.init.mw.ApiResponseCache.prototype.get = function ( title ) {
if ( typeof title !== 'string' ) {
@@ -93,7 +93,7 @@
* this returns that data. Otherwise, it returns undefined.
*
* @param {string} name Normalized page title
- * @returns {Object|undefined} Cache data for this name.
+ * @return {Object|undefined} Cache data for this name.
*/
ve.init.mw.ApiResponseCache.prototype.getCached = function ( name ) {
if ( Object.prototype.hasOwnProperty.call( this.cacheValues, name ) ) {
diff --git a/modules/ve-mw/init/ve.init.mw.Target.js
b/modules/ve-mw/init/ve.init.mw.Target.js
index 93b11a5..3a0efd7 100644
--- a/modules/ve-mw/init/ve.init.mw.Target.js
+++ b/modules/ve-mw/init/ve.init.mw.Target.js
@@ -1103,7 +1103,7 @@
* html and body tags.
*
* @param {HTMLDocument} newDoc Document generated by ve.dm.Converter. Will be
modified.
- * @returns {string} Full HTML document
+ * @return {string} Full HTML document
*/
ve.init.mw.Target.prototype.getHtml = function ( newDoc ) {
var i, len, oldDoc = this.doc;
@@ -1161,7 +1161,7 @@
* in which case it waits for that promise instead.
*
* @param {jQuery.Promise} [dataPromise] Promise for pending request, if any
- * @returns {boolean} Loading has been started
+ * @return {boolean} Loading has been started
*/
ve.init.mw.Target.prototype.load = function ( dataPromise ) {
// Prevent duplicate requests
@@ -1222,7 +1222,7 @@
* the same promise (which will already have been resolved) until
clearPreparedCacheKey() is called.
*
* @param {HTMLDocument} doc Document to serialize
- * @returns {jQuery.Promise} Abortable promise, resolved with the cache key.
+ * @return {jQuery.Promise} Abortable promise, resolved with the cache key.
*/
ve.init.mw.Target.prototype.prepareCacheKey = function ( doc ) {
var xhr, deflated,
@@ -1287,7 +1287,7 @@
* if one isn't already pending or finished. Instead, it returns a rejected
promise in that case.
*
* @param {HTMLDocument} doc Document to serialize
- * @returns {jQuery.Promise} Abortable promise, resolved with the cache key.
+ * @return {jQuery.Promise} Abortable promise, resolved with the cache key.
*/
ve.init.mw.Target.prototype.getPreparedCacheKey = function ( doc ) {
var deferred;
@@ -1319,7 +1319,7 @@
* @param {string} [eventName] If set, log an event when the request completes
successfully. The
* full event name used will be 'performance.system.{eventName}.withCacheKey'
or .withoutCacheKey
* depending on whether or not a cache key was used.
- * @returns {jQuery.Promise}
+ * @return {jQuery.Promise}
*/
ve.init.mw.Target.prototype.tryWithPreparedCacheKey = function ( doc, options,
eventName ) {
var data,
@@ -1448,7 +1448,7 @@
/**
* Get save form fields from the save dialog form.
*
- * @returns {Object} Form data for submission to the MediaWiki action=edit UI
+ * @return {Object} Form data for submission to the MediaWiki action=edit UI
*/
ve.init.mw.Target.prototype.getSaveFields = function () {
var fields = {
@@ -1467,7 +1467,7 @@
*
* @param {Object} fields Fields to add in addition to those from
#getSaveFields
* @param {string} wikitext Wikitext to submit
- * @returns {boolean} Whether submission was started
+ * @return {boolean} Whether submission was started
*/
ve.init.mw.Target.prototype.submitWithSaveFields = function ( fields, wikitext
) {
return this.submit( wikitext, $.extend( this.getSaveFields(), fields )
);
@@ -1476,7 +1476,7 @@
/**
* Get edit API options from the save dialog form.
*
- * @returns {Object} Save options for submission to the MediaWiki API
+ * @return {Object} Save options for submission to the MediaWiki API
*/
ve.init.mw.Target.prototype.getSaveOptions = function () {
var key,
@@ -1512,7 +1512,7 @@
* - {string} summary Edit summary
* - {boolean} minor Edit is a minor edit
* - {boolean} watch Watch the page
- * @returns {boolean} Saving has been started
+ * @return {boolean} Saving has been started
*/
ve.init.mw.Target.prototype.save = function ( doc, options ) {
var data;
@@ -1542,7 +1542,7 @@
*
* @method
* @param {HTMLDocument} doc Document to compare against (via wikitext)
- * @returns {boolean} Diffing has been started
+ * @return {boolean} Diffing has been started
*/
ve.init.mw.Target.prototype.showChanges = function ( doc ) {
if ( this.diffing ) {
@@ -1571,7 +1571,7 @@
* @param {string} wikitext Wikitext to submit
* @param {Object} fields Other form fields to add (e.g. wpSummary,
wpWatchthis, etc.). To actually
* save the wikitext, add { wpSave: 1 }. To go to the diff view, add {
wpDiff: 1 }.
- * @returns {boolean} Submitting has been started
+ * @return {boolean} Submitting has been started
*/
ve.init.mw.Target.prototype.submit = function ( wikitext, fields ) {
var key, $form, params;
@@ -1617,7 +1617,7 @@
* @method
* @param {HTMLDocument} doc Document to serialize
* @param {Function} callback Function to call when complete, accepts error
and wikitext arguments
- * @returns {boolean} Serializing has been started
+ * @return {boolean} Serializing has been started
*/
ve.init.mw.Target.prototype.serialize = function ( doc, callback ) {
// Prevent duplicate requests
@@ -1639,7 +1639,7 @@
/**
* Get list of edit notices.
*
- * @returns {Object|null} List of edit notices or null if none are loaded
+ * @return {Object|null} List of edit notices or null if none are loaded
*/
ve.init.mw.Target.prototype.getEditNotices = function () {
return this.editNotices;
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
index 8f5a3c4..bd93667 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
@@ -39,7 +39,7 @@
/**
* Get the reference node to be edited.
*
- * @returns {ve.dm.MWReferenceNode|null} Reference node to be edited, null if
none exists
+ * @return {ve.dm.MWReferenceNode|null} Reference node to be edited, null if
none exists
*/
ve.ui.MWCitationDialog.prototype.getReferenceNode = function () {
var selectedNode = this.getFragment().getSelectedNode();
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
index 0bbd541..70c3b8a 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
@@ -144,7 +144,7 @@
* Swap state in the save dialog.
*
* @param {string} panel One of 'save', 'review', 'conflict' or 'nochanges'
- * @returns {jQuery} The now active panel
+ * @return {jQuery} The now active panel
* @throws {Error} Unknown saveDialog panel
*/
ve.ui.MWSaveDialog.prototype.swapPanel = function ( panel ) {
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
index d5435ac..04dcf70 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
@@ -305,7 +305,7 @@
* Get the label of a template or template placeholder.
*
* @param {ve.dm.MWTemplateModel|ve.dm.MWTemplatePlaceholderModel} part Part
to check
- * @returns {string} Label of template or template placeholder
+ * @return {string} Label of template or template placeholder
*/
ve.ui.MWTemplateDialog.prototype.getTemplatePartLabel = function ( part ) {
return part instanceof ve.dm.MWTemplateModel ?
@@ -379,7 +379,7 @@
* If no required parameters were left blank, or if they were but the user
decided to go ahead
* anyway, the returned deferred will be resolved.
* Otherwise, the returned deferred will be rejected.
- * @returns {jQuery.Deferred}
+ * @return {jQuery.Deferred}
*/
ve.ui.MWTemplateDialog.prototype.checkRequiredParameters = function () {
var blankRequired = [],
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js
index 9a985d3..bede4f0 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWTransclusionDialog.js
@@ -191,7 +191,7 @@
/**
* Checks if transclusion only contains a single template or template
placeholder.
*
- * @returns {boolean} Transclusion only contains a single template or template
placeholder
+ * @return {boolean} Transclusion only contains a single template or template
placeholder
*/
ve.ui.MWTransclusionDialog.prototype.isSingleTemplateTransclusion = function
() {
var parts = this.transclusionModel && this.transclusionModel.getParts();
diff --git a/modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
b/modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
index ade013a..9d3264f 100644
--- a/modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
+++ b/modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
@@ -72,7 +72,7 @@
/**
* Get the placeholder text for the content input area.
*
- * @returns {string} Placeholder text
+ * @return {string} Placeholder text
*/
ve.ui.MWExtensionInspector.prototype.getInputPlaceholder = function () {
return '';
@@ -137,7 +137,7 @@
/**
* Create an new data element for the model class associated with this
inspector
*
- * @returns {Object} Element data
+ * @return {Object} Element data
*/
ve.ui.MWExtensionInspector.prototype.getNewElement = function () {
// Extension inspectors which create elements should either match
diff --git a/modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
b/modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
index 65da6eb..9149fca 100644
--- a/modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
+++ b/modules/ve-mw/ui/inspectors/ve.ui.MWLinkAnnotationInspector.js
@@ -209,7 +209,7 @@
*
* @method
* @param {ve.dm.SurfaceFragment} fragment Current selection
- * @returns
{ve.dm.MWInternalLinkAnnotation|ve.dm.MWExternalLinkAnnotation|null}
+ * @return {ve.dm.MWInternalLinkAnnotation|ve.dm.MWExternalLinkAnnotation|null}
*/
ve.ui.MWLinkAnnotationInspector.prototype.getAnnotationFromFragment = function
( fragment ) {
var target = fragment.getText(),
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
index 87ea21d..5f9a343 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
@@ -191,7 +191,7 @@
* Get the first meta item of a given name
*
* @param {string} name Name of the meta item
- * @returns {Object|null} Meta item, if any
+ * @return {Object|null} Meta item, if any
*/
ve.ui.MWAdvancedSettingsPage.prototype.getMetaItem = function ( name ) {
return this.metaList.getItemsInGroup( name )[ 0 ] || null;
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWCategoriesPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWCategoriesPage.js
index 6b13a2f..a19f567 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWCategoriesPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWCategoriesPage.js
@@ -160,7 +160,7 @@
/**
* Get default sort key item.
*
- * @returns {string} Default sort key item
+ * @return {string} Default sort key item
*/
ve.ui.MWCategoriesPage.prototype.getDefaultSortKeyItem = function () {
return this.metaList.getItemsInGroup( 'mwDefaultSort' )[ 0 ] || null;
@@ -169,7 +169,7 @@
/**
* Get array of category items from meta list
*
- * @returns {Object[]} items
+ * @return {Object[]} items
*/
ve.ui.MWCategoriesPage.prototype.getCategoryItems = function () {
var i,
@@ -187,7 +187,7 @@
* Gets category item from meta list item
*
* @param {ve.dm.MWCategoryMetaItem} metaItem
- * @returns {Object} item
+ * @return {Object} item
*/
ve.ui.MWCategoriesPage.prototype.getCategoryItemFromMetaListItem = function (
metaItem ) {
var title = mw.Title.newFromText( metaItem.element.attributes.category
),
@@ -207,7 +207,7 @@
*
* @param {Object} item category widget item
* @param {Object} [oldData] Metadata object that was previously associated
with this item, if any
- * @returns {Object} metaBase
+ * @return {Object} metaBase
*/
ve.ui.MWCategoriesPage.prototype.getCategoryItemForInsertion = function (
item, oldData ) {
var newData = {
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
index 473dcd4..7ca64cd 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
@@ -123,7 +123,7 @@
* Gets language item from meta list item
*
* @param {ve.dm.MWLanguageMetaItem} metaItem
- * @returns {Object} item
+ * @return {Object} item
*/
ve.ui.MWLanguagesPage.prototype.getLanguageItemFromMetaListItem = function (
metaItem ) {
// TODO: get real values from metaItem once Parsoid actually provides
them - bug 48970
@@ -138,7 +138,7 @@
/**
* Get array of language items from meta list
*
- * @returns {Object[]} items
+ * @return {Object[]} items
*/
ve.ui.MWLanguagesPage.prototype.getLocalLanguageItems = function () {
var i,
@@ -157,7 +157,7 @@
/**
* Get array of language items from meta list
*
- * @returns {jQuery.Promise}
+ * @return {jQuery.Promise}
*/
ve.ui.MWLanguagesPage.prototype.getAllLanguageItems = function () {
var deferred = $.Deferred();
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
index adeafc1..4c764b6 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
@@ -223,7 +223,7 @@
* Get the first meta item of a given name
*
* @param {string} name Name of the meta item
- * @returns {Object|null} Meta item, if any
+ * @return {Object|null} Meta item, if any
*/
ve.ui.MWSettingsPage.prototype.getMetaItem = function ( name ) {
return this.metaList.getItemsInGroup( name )[ 0 ] || null;
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
index 290482c..109283d 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryInputWidget.js
@@ -228,7 +228,7 @@
*
* @method
* @param {string} name Category name
- * @returns {OO.ui.MenuOptionWidget} Menu item widget to be shown
+ * @return {OO.ui.MenuOptionWidget} Menu item widget to be shown
*/
ve.ui.MWCategoryInputWidget.prototype.getCategoryWidgetFromName = function (
name ) {
var cachedData = ve.init.platform.linkCache.getCached(
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
index ae0c393..106ab25 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
@@ -115,7 +115,7 @@
* Get a category item.
*
* @param {string} value Category name
- * @returns {Object} Category item with name, value and metaItem properties
+ * @return {Object} Category item with name, value and metaItem properties
*/
ve.ui.MWCategoryWidget.prototype.getCategoryItemFromValue = function ( value )
{
var title;
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
index 3e16c93..4f0b7b2 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
@@ -201,7 +201,7 @@
/**
* Set the row height for all size calculations
*
- * @returns {number} rowHeight Row height
+ * @return {number} rowHeight Row height
*/
ve.ui.MWMediaResultWidget.prototype.getRowHeight = function () {
return this.rowHeight;
@@ -241,7 +241,7 @@
/**
* Check if the image has a src attribute already
- * @returns {boolean} Thumbnail has its source attribute set
+ * @return {boolean} Thumbnail has its source attribute set
*/
ve.ui.MWMediaResultWidget.prototype.hasSrc = function () {
return !!this.src;
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
index 2666d0f..ad74cab 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
@@ -424,7 +424,7 @@
/**
* Get language for the search results.
- * @returns {string} lang Language
+ * @return {string} lang Language
*/
ve.ui.MWMediaSearchWidget.prototype.getLang = function () {
return this.lang;
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
index 09b441e..beb8a6f 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
@@ -193,7 +193,7 @@
/**
* Check whether buildIndex will create an empty index based on the current
internalList.
*
- * @returns {boolean} Index is empty
+ * @return {boolean} Index is empty
*/
ve.ui.MWReferenceSearchWidget.prototype.isIndexEmpty = function () {
return this.indexEmpty;
--
To view, visit https://gerrit.wikimedia.org/r/232550
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I76abb1eb1f3e1a2e8a4c03f577a080f4889b3a6d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Jforrester <[email protected]>
Gerrit-Reviewer: Cscott <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
