jenkins-bot has submitted this change and it was merged.
Change subject: eslint: Remove unused exception and fix documentation errors
......................................................................
eslint: Remove unused exception and fix documentation errors
Don't enable valid-jsdoc yet though, due to @chainable bug.
Change-Id: I4d2a6de19c72c6e4c20733446616d8046419d431
---
M .eslintrc.json
M modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
M modules/ve-mw/ce/nodes/ve.ce.MWExtensionNode.js
M modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
M modules/ve-mw/ce/nodes/ve.ce.MWTransclusionNode.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/nodes/ve.dm.MWMagicLinkNode.js
M modules/ve-mw/init/targets/ve.init.mw.DesktopWikitextArticleTarget.js
M modules/ve-mw/ui/inspectors/ve.ui.MWAlienExtensionInspector.js
M modules/ve-mw/ui/inspectors/ve.ui.MWMagicLinkNodeInspector.js
M modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
M modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWTemplateTitleInputWidget.js
14 files changed, 38 insertions(+), 10 deletions(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.eslintrc.json b/.eslintrc.json
index 58ac2b1..be3fe6f 100644
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -17,7 +17,6 @@
"rules": {
"dot-notation": 0,
"wrap-iife": 0,
- "no-use-before-define": ["error", { "functions": true,
"classes": true }],
"valid-jsdoc": 0
}
}
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
index dda1c9a..ea966ee 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
@@ -232,6 +232,7 @@
*
* @param {string} type 'none' or 'default'
* @param {string} alignment 'left', 'right', 'center', 'none' or 'default'
+ * @return {string} CSS class
*/
ve.ce.MWBlockImageNode.prototype.getCssClass = function ( type, alignment ) {
// TODO use this.model.getAttribute( 'type' ) etc., see bug 52065
@@ -312,7 +313,9 @@
}
};
-/** */
+/**
+ * @param {Object} dimensions New dimensions
+ */
ve.ce.MWBlockImageNode.prototype.onResizableResizing = function ( dimensions )
{
if ( !this.outline ) {
ve.ce.ResizableNode.prototype.onResizableResizing.call( this,
dimensions );
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWExtensionNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWExtensionNode.js
index 398854e..0904123 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWExtensionNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWExtensionNode.js
@@ -48,7 +48,9 @@
/* Methods */
-/** */
+/**
+ * @inheritdoc ve.ce.GeneratedContentNode
+ */
ve.ce.MWExtensionNode.prototype.generateContents = function ( config ) {
var xhr, attr, wikitext,
deferred = $.Deferred(),
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
index 9296dab..b5e0ab9 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWImageNode.js
@@ -80,7 +80,9 @@
*/
ve.ce.MWImageNode.prototype.onAttributeChange = function () {};
-/** */
+/**
+ * @inheritdoc ve.ce.GeneratedContentNode
+ */
ve.ce.MWImageNode.prototype.generateContents = function () {
var xhr,
width = this.getModel().getAttribute( 'width' ),
@@ -126,7 +128,9 @@
}
};
-/** */
+/**
+ * @inheritdoc ve.ce.GeneratedContentNode
+ */
ve.ce.MWImageNode.prototype.render = function ( generatedContents ) {
this.$image.attr( 'src', generatedContents );
// As we only re-render when the image is larger than last rendered size
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWTransclusionNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWTransclusionNode.js
index 9654097..9488dec 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWTransclusionNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWTransclusionNode.js
@@ -170,7 +170,7 @@
*
* Check if the final result of the imported template is empty.
*
- * @see ve.ce.GeneratedContentNode#render
+ * @inheritdoc ve.ce.GeneratedContentNode
*/
ve.ce.MWTransclusionNode.prototype.render = function ( generatedContents ) {
// Call parent mixin
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
index 779de66..9d1c256 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
@@ -324,6 +324,8 @@
/**
* Set original data, to be used as a base for serialization.
+ *
+ * @param {Object} data Original 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 bcdeec7..aecb2b9 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
@@ -42,7 +42,7 @@
* @param {string} [data.description] Template description
* @param {string[]} [data.paramOrder] Canonically ordered parameter names
* @param {Object} [data.params] Template param specs keyed by param name
- * @param {string[][]} [data.sets] Lists of param sets
+ * @param {Array} [data.sets] Lists of param sets
*/
ve.dm.MWTemplateSpecModel.prototype.extend = function ( data ) {
var key, param, i, len;
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWMagicLinkNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWMagicLinkNode.js
index e63fdf7..e567335 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWMagicLinkNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWMagicLinkNode.js
@@ -44,6 +44,7 @@
/**
* Determine whether the given `element` is a magic link.
*
+ * @param {HTMLElement} element Element
* @return {boolean} True if the element is a magic link
*/
ve.dm.MWMagicLinkNode.static.matchFunction = function ( element ) {
@@ -113,6 +114,7 @@
* with the given content into a simple link, or `null` if the given
* content is not a valid magic link.
*
+ * @param {string} content Content
* @return {ve.dm.MWExternalLinkAnnotation|ve.dm.MWInternalLinkAnnotation|null}
*/
ve.dm.MWMagicLinkNode.static.annotationFromContent = function ( content ) {
diff --git
a/modules/ve-mw/init/targets/ve.init.mw.DesktopWikitextArticleTarget.js
b/modules/ve-mw/init/targets/ve.init.mw.DesktopWikitextArticleTarget.js
index 56cdc38..d40e01e 100644
--- a/modules/ve-mw/init/targets/ve.init.mw.DesktopWikitextArticleTarget.js
+++ b/modules/ve-mw/init/targets/ve.init.mw.DesktopWikitextArticleTarget.js
@@ -162,6 +162,8 @@
/**
* Reload the target surface in the new editor mode
+ *
+ * @param {jQuery.Promise} [dataPromise] Data promise, if any
*/
ve.init.mw.DesktopWikitextArticleTarget.prototype.reloadSurface = function (
dataPromise ) {
var target = this;
diff --git a/modules/ve-mw/ui/inspectors/ve.ui.MWAlienExtensionInspector.js
b/modules/ve-mw/ui/inspectors/ve.ui.MWAlienExtensionInspector.js
index 8ea2bd0..aea1c6b 100644
--- a/modules/ve-mw/ui/inspectors/ve.ui.MWAlienExtensionInspector.js
+++ b/modules/ve-mw/ui/inspectors/ve.ui.MWAlienExtensionInspector.js
@@ -90,7 +90,9 @@
}, this );
};
-/** */
+/**
+ * @inheritdoc ve.ui.MWExtensionWindow
+ */
ve.ui.MWAlienExtensionInspector.prototype.updateMwData = function ( mwData ) {
var key;
diff --git a/modules/ve-mw/ui/inspectors/ve.ui.MWMagicLinkNodeInspector.js
b/modules/ve-mw/ui/inspectors/ve.ui.MWMagicLinkNodeInspector.js
index a46161e..4554818 100644
--- a/modules/ve-mw/ui/inspectors/ve.ui.MWMagicLinkNodeInspector.js
+++ b/modules/ve-mw/ui/inspectors/ve.ui.MWMagicLinkNodeInspector.js
@@ -63,6 +63,8 @@
* appropriate type.
*
* @private
+ * @param {string} str String to validate
+ * @return {boolean} String is valid
*/
ve.ui.MWMagicLinkNodeInspector.prototype.validate = function ( str ) {
var node = this.getFragment().getSelectedNode();
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
index 681c780..2a471e6 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWLanguagesPage.js
@@ -102,6 +102,9 @@
/**
* Handle language items being loaded.
+ *
+ * @param {jQuery.Deferred} deferred Deferred to resolve with language data
+ * @param {Object} response API response
*/
ve.ui.MWLanguagesPage.prototype.onAllLanguageItemsSuccess = function (
deferred, response ) {
var i, iLen, languages = [],
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
index 05cb30c..81709da 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
@@ -221,7 +221,11 @@
}
};
-/** */
+/**
+ * Set the default sort key.
+ *
+ * @param {string} value Default sort key value
+ */
ve.ui.MWCategoryWidget.prototype.setDefaultSortKey = function ( value ) {
this.popup.setDefaultSortKey( value );
};
@@ -230,7 +234,7 @@
* Get list of category names.
*
* @method
- * @param {string[]} List of category names
+ * @return {string[]} List of category names
*/
ve.ui.MWCategoryWidget.prototype.getCategories = function () {
return Object.keys( this.categories );
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWTemplateTitleInputWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWTemplateTitleInputWidget.js
index a953954..5c3c210 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWTemplateTitleInputWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWTemplateTitleInputWidget.js
@@ -118,6 +118,9 @@
/**
* See the parent documentation at
<https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.widgets.TitleInputWidget>
+ *
+ * @param {string} title
+ * @return {Object}
*/
ve.ui.MWTemplateTitleInputWidget.prototype.getOptionWidgetData = function (
title ) {
return ve.extendObject(
--
To view, visit https://gerrit.wikimedia.org/r/318576
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4d2a6de19c72c6e4c20733446616d8046419d431
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Esanders <esand...@wikimedia.org>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
