Jforrester has uploaded a new change for review.
https://gerrit.wikimedia.org/r/232552
Change subject: build: Enable jscs jsDoc rule 'checkParamNames' and make pass
......................................................................
build: Enable jscs jsDoc rule 'checkParamNames' and make pass
Change-Id: Ifcd3f67524c32148ff3591263d6374b31ee57d3b
---
M .jscsrc
M modules/ve-mw/ce/nodes/ve.ce.MWAlienExtensionNode.js
M modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
M modules/ve-mw/dm/models/ve.dm.MWImageModel.js
M modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
M modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
M modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
M modules/ve-mw/init/ve.init.mw.Target.js
M modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
M modules/ve-mw/ui/pages/ve.ui.MWTemplatePage.js
M modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
11 files changed, 18 insertions(+), 16 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor
refs/changes/52/232552/1
diff --git a/.jscsrc b/.jscsrc
index 3a11b7e..0a38ab0 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -10,6 +10,7 @@
"see": true
}
},
+ "checkParamNames": true,
"requireNewlineAfterDescription": true
}
}
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWAlienExtensionNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWAlienExtensionNode.js
index 22b1b91..6ca8faf 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWAlienExtensionNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWAlienExtensionNode.js
@@ -82,7 +82,6 @@
* @mixins ve.ce.MWAlienExtensionNode
*
* @constructor
- * @param {ve.dm.MWAlienInlineExtensionNode} model Model to observe
* @param {Object} [config] Configuration options
*/
ve.ce.MWAlienInlineExtensionNode = function VeCeMWAlienInlineExtensionNode(
config ) {
diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
index e7fac6d..57a2dde 100644
--- a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
+++ b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
@@ -111,7 +111,7 @@
* Normalize title for comparison purposes.
* E.g. capitalisation and underscores.
*
- * @param {string} title Original title
+ * @param {string} original Original title
* @return {string} Normalized title, or the original if it is invalid
*/
ve.dm.MWInternalLinkAnnotation.static.normalizeTitle = function ( original ) {
@@ -125,7 +125,7 @@
/**
* Normalize title for lookup (search suggestion, existence) purposes.
*
- * @param {string} title Original title
+ * @param {string} original Original title
* @return {string} Normalized title, or the original if it is invalid
*/
ve.dm.MWInternalLinkAnnotation.static.getLookupTitle = function ( original ) {
diff --git a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
index 94a606a..b4bf06d 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
@@ -626,7 +626,7 @@
*
* Example values: "BITMAP" for JPEG or PNG images; "DRAWING" for SVG graphics
*
- * @param {string|undefined} Symbolic media type name, or undefined if empty
+ * @param {string|undefined} type Symbolic media type name, or undefined if
empty
*/
ve.dm.MWImageModel.prototype.setMediaType = function ( type ) {
this.mediaType = type;
@@ -678,6 +678,7 @@
* We explicitly repeat tests so to avoid recursively calling
* the other methods.
*
+ * @param {string} [imageType] Type of the image.
* @param {string} [align] Optional alignment value to test against.
* Supplying this parameter would test whether this align parameter
* would mean the image is aligned to its default position.
@@ -1153,7 +1154,7 @@
* Attach a new scalable object to the model and request the
* information from the API.
*
- * @param {ve.dm.Scalable} Scalable object
+ * @param {ve.dm.Scalable} scalable Scalable object
*/
ve.dm.MWImageModel.prototype.attachScalable = function ( scalable ) {
var imageName = this.getResourceName().replace( /^(\.+\/)*/, '' ),
@@ -1247,7 +1248,7 @@
/**
* Set image caption document.
*
- * @param {ve.dm.Document} Image caption document
+ * @param {ve.dm.Document} doc Image caption document
*/
ve.dm.MWImageModel.prototype.setCaptionDocument = function ( doc ) {
this.captionDoc = doc;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
index cd2e515..693d419 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
@@ -157,7 +157,7 @@
/**
* Insert reference at the end of a surface fragment.
*
- * @param {ve.dm.SurfaceFragment} surfaceModel Surface fragment to insert at
+ * @param {ve.dm.SurfaceFragment} surfaceFragment Surface fragment to insert at
* @param {boolean} [placeholder] Reference is a placeholder for staging
purposes
*/
ve.dm.MWReferenceModel.prototype.insertReferenceNode = function (
surfaceFragment, placeholder ) {
@@ -292,7 +292,7 @@
/**
* Set key of reference in list.
*
- * @param {string} Reference's list key
+ * @param {string} listKey Reference's list key
*/
ve.dm.MWReferenceModel.prototype.setListKey = function ( listKey ) {
this.listKey = listKey;
@@ -301,7 +301,7 @@
/**
* Set name of the group a references list is in.
*
- * @param {string} References list's group
+ * @param {string} listGroup References list's group
*/
ve.dm.MWReferenceModel.prototype.setListGroup = function ( listGroup ) {
this.listGroup = listGroup;
@@ -310,7 +310,7 @@
/**
* Set the index of reference in list.
*
- * @param {string} Reference's list index
+ * @param {string} listIndex Reference's list index
*/
ve.dm.MWReferenceModel.prototype.setListIndex = function ( listIndex ) {
this.listIndex = listIndex;
@@ -328,7 +328,7 @@
/**
* Set the reference document.
*
- * @param {ve.dm.Document} Reference document
+ * @param {ve.dm.Document} doc Reference document
*/
ve.dm.MWReferenceModel.prototype.setDocument = function ( doc ) {
this.doc = doc;
diff --git a/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
b/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
index e3b2629..2d636a9 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWTransclusionModel.js
@@ -50,7 +50,7 @@
/**
* Insert transclusion at the end of a surface fragment.
*
- * @param {ve.dm.SurfaceFragment} surfaceModel Surface fragment to
insert at
+ * @param {ve.dm.SurfaceFragment} surfaceFragment Surface fragment to
insert at
*/
ve.dm.MWTransclusionModel.prototype.insertTransclusionNode = function (
surfaceFragment ) {
surfaceFragment
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
index f9bd041..6b11420 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} imageDimensions Width and height of the image
* @param {Object} boundingBox The limit of the bounding box
* @return {Object} The new width and height of the scaled image.
*/
diff --git a/modules/ve-mw/init/ve.init.mw.Target.js
b/modules/ve-mw/init/ve.init.mw.Target.js
index 3a0efd7..7fca380 100644
--- a/modules/ve-mw/init/ve.init.mw.Target.js
+++ b/modules/ve-mw/init/ve.init.mw.Target.js
@@ -880,7 +880,7 @@
*
* @static
* @method
- * @param {Object} data API response data
+ * @param {Object} response API response data
* @param {string} status Text status message
* @fires serializeComplete
*/
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
index aa86b7d..7ba89c2 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
@@ -792,7 +792,7 @@
/**
* Handle image model type change
*
- * @param {string} alignment Image alignment
+ * @param {string} type Image type
*/
ve.ui.MWMediaDialog.prototype.onImageModelTypeChange = function ( type ) {
this.typeSelect.selectItemByData( type );
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWTemplatePage.js
b/modules/ve-mw/ui/pages/ve.ui.MWTemplatePage.js
index 6d00947..c67513b 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWTemplatePage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWTemplatePage.js
@@ -12,7 +12,7 @@
* @extends OO.ui.PageLayout
*
* @constructor
- * @param {ve.dm.MWTemplateModel} parameter Template
+ * @param {ve.dm.MWTemplateModel} template Template model
* @param {string} name Unique symbolic name of page
* @param {Object} [config] Configuration options
*/
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
index f9d9ca1..9818a3f 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
@@ -14,6 +14,7 @@
* @mixins OO.ui.mixin.TitledElement
*
* @constructor
+ * @param {Object} content API response data from which to build the display
* @param {Object} [config] Configuration options
* @cfg {string} [href] A url encapsulating the field text. If a label is
attached it will include the label.
* @cfg {string} [label] A ve.msg() label string for the field.
--
To view, visit https://gerrit.wikimedia.org/r/232552
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ifcd3f67524c32148ff3591263d6374b31ee57d3b
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Jforrester <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
