Jforrester has uploaded a new change for review.
https://gerrit.wikimedia.org/r/232551
Change subject: build: Enable jscs jsDoc rule 'requireNewlineAfterDescription'
and make pass
......................................................................
build: Enable jscs jsDoc rule 'requireNewlineAfterDescription' and make pass
Change-Id: I7c0fabc93834d19198caea8f5dd1834e9e473d0a
---
M .jscsrc
M modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
M modules/ve-mw/ce/nodes/ve.ce.MWReferenceNode.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.MWMediaResourceProvider.js
M modules/ve-mw/dm/models/ve.dm.MWMediaResourceQueue.js
M modules/ve-mw/dm/models/ve.dm.MWReferenceModel.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.MWReferenceNode.js
M modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.init.js
M modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
M modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
M modules/ve-mw/init/ve.init.mw.ImageInfoCache.js
M modules/ve-mw/init/ve.init.mw.LinkCache.js
M modules/ve-mw/init/ve.init.mw.TargetEvents.js
M modules/ve-mw/init/ve.init.mw.TargetLoader.js
M modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
M modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
M modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.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/pages/ve.ui.MWParameterPlaceholderPage.js
M modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
M modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
M modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.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
30 files changed, 93 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor
refs/changes/51/232551/1
diff --git a/.jscsrc b/.jscsrc
index 0a5a7af..3a11b7e 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -9,6 +9,7 @@
"source": true,
"see": true
}
- }
+ },
+ "requireNewlineAfterDescription": true
}
}
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
index 9f11a69..75412f7 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWBlockImageNode.js
@@ -111,6 +111,7 @@
/**
* Set up an object that converts from the type to rdfa, based
* on the rdfaToType object in the model.
+ *
* @return {Object.<string,string>} A type to Rdfa conversion object
*/
ve.ce.MWBlockImageNode.prototype.getTypeToRdfa = function () {
diff --git a/modules/ve-mw/ce/nodes/ve.ce.MWReferenceNode.js
b/modules/ve-mw/ce/nodes/ve.ce.MWReferenceNode.js
index 7c21e48..8c83636 100644
--- a/modules/ve-mw/ce/nodes/ve.ce.MWReferenceNode.js
+++ b/modules/ve-mw/ce/nodes/ve.ce.MWReferenceNode.js
@@ -62,6 +62,7 @@
/**
* Handle setup event.
+ *
* @method
*/
ve.ce.MWReferenceNode.prototype.onSetup = function () {
@@ -71,6 +72,7 @@
/**
* Handle teardown event.
+ *
* @method
*/
ve.ce.MWReferenceNode.prototype.onTeardown = function () {
diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
index 24e8ac2..e7fac6d 100644
--- a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
+++ b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js
@@ -52,6 +52,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.
* @return {Object} Plain object with 'title' and 'hrefPrefix' keys.
@@ -109,6 +110,7 @@
/**
* Normalize title for comparison purposes.
* E.g. capitalisation and underscores.
+ *
* @param {string} title Original title
* @return {string} Normalized title, or the original if it is invalid
*/
@@ -122,6 +124,7 @@
/**
* Normalize title for lookup (search suggestion, existence) purposes.
+ *
* @param {string} title Original title
* @return {string} Normalized title, or the original if it is invalid
*/
diff --git a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
index c0ce7fc..94a606a 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWImageModel.js
@@ -115,6 +115,7 @@
/**
* Create a new image node based on given parameters.
+ *
* @param {Object} attributes Image attributes
* @param {string} [imageType] Image node type 'mwInlineImage' or
'mwBlockImage'.
* Defaults to 'mwBlockImage'
@@ -224,6 +225,7 @@
/**
* Get the hash object of the current image model state.
+ *
* @return {Object} Hash object
*/
ve.dm.MWImageModel.prototype.getHashObject = function () {
@@ -264,6 +266,7 @@
/**
* Adjust the model parameters based on a new image
+ *
* @param {Object} attrs New image source attributes
* @param {Object} [APIinfo] The image's API info
* @throws {Error} Image has insufficient details to compute the imageModel
details.
@@ -365,6 +368,7 @@
/**
* Get the original bounding box
+ *
* @return {Object} Bounding box with width and height
*/
ve.dm.MWImageModel.prototype.getBoundingBox = function () {
@@ -483,6 +487,7 @@
/**
* Get linear data representation of the image
+ *
* @return {Array} Linear data
*/
ve.dm.MWImageModel.prototype.getData = function () {
@@ -515,6 +520,7 @@
/**
* Return all updated attributes that belong to the node.
+ *
* @return {Object} Updated attributes
*/
ve.dm.MWImageModel.prototype.getUpdatedAttributes = function () {
@@ -571,6 +577,7 @@
/**
* Set the image file source
+ *
* @param {string} src The source of the given media file
*/
ve.dm.MWImageModel.prototype.setImageSource = function ( src ) {
@@ -579,6 +586,7 @@
/**
* Set the image file resource name
+ *
* @param {string} resourceName The resource name of the given image file
*/
ve.dm.MWImageModel.prototype.setImageResourceName = function ( resourceName ) {
@@ -587,6 +595,7 @@
/**
* Set the image href value
+ *
* @param {string} href The destination href of the given media file
*/
ve.dm.MWImageModel.prototype.setImageHref = function ( href ) {
@@ -595,6 +604,7 @@
/**
* Set the original bounding box
+ *
* @param {Object} box Bounding box with width and height
*/
ve.dm.MWImageModel.prototype.setBoundingBox = function ( box ) {
@@ -624,6 +634,7 @@
/**
* Check whether the image is set to default size
+ *
* @return {boolean} Default size flag on or off
*/
ve.dm.MWImageModel.prototype.isDefaultSize = function () {
@@ -632,6 +643,7 @@
/**
* Check whether the image has the border flag set
+ *
* @return {boolean} Border flag on or off
*/
ve.dm.MWImageModel.prototype.hasBorder = function () {
@@ -640,6 +652,7 @@
/**
* Check whether the image source is changed
+ *
* @return {boolean} changedImageSource flag on or off
*/
ve.dm.MWImageModel.prototype.isChangedImageSource = function () {
@@ -648,6 +661,7 @@
/**
* Check whether the image has floating alignment set
+ *
* @param {string} [align] Optional. Alignment value to test against.
* @return {boolean} hasAlignment flag on or off
*/
@@ -663,6 +677,7 @@
* Check whether the image is set to default alignment
* We explicitly repeat tests so to avoid recursively calling
* the other methods.
+ *
* @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.
@@ -701,6 +716,7 @@
/**
* Check whether the image can have a border set on it
+ *
* @return {boolean} Border possible or not
*/
ve.dm.MWImageModel.prototype.isBorderable = function () {
@@ -709,6 +725,7 @@
/**
* Get the image file resource name
+ *
* @return {string} resourceName The resource name of the given media file
*/
ve.dm.MWImageModel.prototype.getResourceName = function () {
@@ -717,6 +734,7 @@
/**
* Get the image alternate text
+ *
* @return {string} Alternate text
*/
ve.dm.MWImageModel.prototype.getAltText = function () {
@@ -725,6 +743,7 @@
/**
* Get image wikitext type; 'thumb', 'frame', 'frameless' or 'none/inline'
+ *
* @return {string} Image type
*/
ve.dm.MWImageModel.prototype.getType = function () {
@@ -751,6 +770,7 @@
/**
* Get image alignment 'left', 'right', 'center', 'none' or 'default'
+ *
* @return {string|null} Image alignment. Inline images have initial alignment
* value of null.
*/
@@ -761,6 +781,7 @@
/**
* Get image vertical alignment
* 'middle', 'baseline', 'sub', 'super', 'top', 'text-top', 'bottom',
'text-bottom' or 'default'
+ *
* @return {string} Image alignment
*/
ve.dm.MWImageModel.prototype.getVerticalAlignment = function () {
@@ -770,6 +791,7 @@
/**
* Get the scalable object responsible for size manipulations
* for the given image
+ *
* @return {ve.dm.Scalable} Scalable object
*/
ve.dm.MWImageModel.prototype.getScalable = function () {
@@ -778,6 +800,7 @@
/**
* Get the image current dimensions
+ *
* @return {Object} Current dimensions width/height
* @return {number} dimensions.width The width of the image
* @return {number} dimensions.height The height of the image
@@ -845,6 +868,7 @@
/**
* Toggle the default size flag of the image
+ *
* @param {boolean} [isDefault] Default size flag. Omit to toggle current
value.
* @fires sizeDefaultChange
*/
@@ -860,6 +884,7 @@
/**
* Cache all image attributes
+ *
* @param {Object} attrs Image attributes
*/
ve.dm.MWImageModel.prototype.cacheOriginalImageAttributes = function ( attrs )
{
@@ -868,6 +893,7 @@
/**
* Get the cache of all image attributes
+ *
* @return {Object} attrs Image attributes
*/
ve.dm.MWImageModel.prototype.getOriginalImageAttributes = function () {
@@ -877,6 +903,7 @@
/**
* Set the current dimensions of the image.
* Normalize in case only one dimension is available.
+ *
* @param {Object} dimensions Dimensions width and height
* @param {number} dimensions.width The width of the image
* @param {number} dimensions.height The height of the image
@@ -888,6 +915,7 @@
/**
* Set alternate text
+ *
* @param {string} text Alternate text
*/
ve.dm.MWImageModel.prototype.setAltText = function ( text ) {
@@ -896,6 +924,7 @@
/**
* Set image type
+ *
* @see #getType
*
* @param {string} type Image type
@@ -1056,6 +1085,7 @@
/**
* Set the directionality of the image, especially important for
* default alignment.
+ *
* @param {string} dir 'rtl' or 'ltr'
*/
ve.dm.MWImageModel.prototype.setDir = function ( dir ) {
@@ -1065,6 +1095,7 @@
/**
* Get the language of the image document. Specifically relevant
* for the caption document.
+ *
* @return {string} Document language
*/
ve.dm.MWImageModel.prototype.getLang = function () {
@@ -1074,6 +1105,7 @@
/**
* Set the language of the image document. Specifically relevant
* for the caption document.
+ *
* @param {string} lang Document language
*/
ve.dm.MWImageModel.prototype.setLang = function ( lang ) {
@@ -1083,8 +1115,9 @@
/**
* Get the image file source
* The image file source that points to the location of the
- * file on the web.
+ * file on the Web.
* For instance, '//upload.wikimedia.org/wikipedia/commons/0/0f/Foo.jpg'
+ *
* @return {string} The source of the given media file
*/
ve.dm.MWImageModel.prototype.getImageSource = function () {
@@ -1096,6 +1129,7 @@
* The resource name represents the filename without the full
* source url.
* For example, './File:Foo.jpg'
+ *
* @return {string} The resource name of the given media file
*/
ve.dm.MWImageModel.prototype.getImageResourceName = function () {
@@ -1108,6 +1142,7 @@
* the link to the source of the image in commons or locally, but
* may hold an alternative link if link= is supplied in the wikitext.
* For example, './File:Foo.jpg' or 'http://www.wikipedia.org'
+ *
* @return {string} The destination href of the given media file
*/
ve.dm.MWImageModel.prototype.getImageHref = function () {
@@ -1161,6 +1196,7 @@
/**
* Set the filename of the current image
+ *
* @param {string} filename Image filename
*/
ve.dm.MWImageModel.prototype.setFilename = function ( filename ) {
@@ -1169,6 +1205,7 @@
/**
* Get the filename of the current image
+ *
* @return {string} filename Image filename
*/
ve.dm.MWImageModel.prototype.getFilename = function () {
@@ -1177,6 +1214,7 @@
/**
* If the image changed, update scalable definitions.
+ *
* @param {Object} originalDimensions Image original dimensions
*/
ve.dm.MWImageModel.prototype.updateScalableDetails = function (
originalDimensions ) {
@@ -1218,6 +1256,7 @@
/**
* Check if the model attributes and parameters have been modified by
* comparing the current hash to the new hash object.
+ *
* @return {boolean} Model has been modified
*/
ve.dm.MWImageModel.prototype.hasBeenModified = function () {
diff --git a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
index a3d8dba..b035dc0 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceProvider.js
@@ -286,6 +286,7 @@
/**
* Check if this source is valid and ready for search.
+ *
* @return {boolean} Source is valid
*/
ve.dm.MWMediaResourceProvider.prototype.isValid = function () {
diff --git a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceQueue.js
b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceQueue.js
index 57e1005..1203ba8 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWMediaResourceQueue.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWMediaResourceQueue.js
@@ -97,6 +97,7 @@
/**
* Get the search query
+ *
* @return {string} API search query
*/
ve.dm.MWMediaResourceQueue.prototype.getSearchQuery = function () {
@@ -106,6 +107,7 @@
/**
* Get image maximum height
+ *
* @return {string} Image max height
*/
ve.dm.MWMediaResourceQueue.prototype.getMaxHeight = function () {
diff --git a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
index 7ec0546..cd2e515 100644
--- a/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
+++ b/modules/ve-mw/dm/models/ve.dm.MWReferenceModel.js
@@ -255,6 +255,7 @@
/**
* Set the directionality of the reference document
+ *
* @param {string} dir Document directionality
*/
ve.dm.MWReferenceModel.prototype.setDir = function ( dir ) {
@@ -263,6 +264,7 @@
/**
* Get the directionality of the reference document
+ *
* @return {string} Document directionality
*/
ve.dm.MWReferenceModel.prototype.getDir = function () {
@@ -271,6 +273,7 @@
/**
* Set the language of the reference document
+ *
* @param {string} lang Document language
*/
ve.dm.MWReferenceModel.prototype.setLang = function ( lang ) {
@@ -279,6 +282,7 @@
/**
* Get the language of the reference document
+ *
* @return {string} Document language
*/
ve.dm.MWReferenceModel.prototype.getLang = function () {
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
index fd4df92..d0efc99 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWExtensionNode.js
@@ -123,6 +123,7 @@
/**
* Get the extension's name
+ *
* @method
* @return {string} Extension name
*/
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
index 316447a..f9bd041 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWImageNode.js
@@ -64,6 +64,7 @@
/**
* Take the given dimensions and scale them to thumbnail size.
+ *
* @param {Object} dimensions Width and height of the image
* @param {string} [mediaType] Media type 'DRAWING' or 'BITMAP'
* @return {Object} The new width and height of the scaled image
@@ -89,6 +90,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
* @return {Object} The new width and height of the scaled image.
@@ -160,6 +162,7 @@
/**
* Get the scalable promise which fetches original dimensions from the API
+ *
* @param {string} filename The image filename whose details the scalable will
represent
* @return {jQuery.Promise} Promise which resolves after the image size
details are fetched from the API
*/
diff --git a/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
b/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
index 422f120..703cf95 100644
--- a/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
+++ b/modules/ve-mw/dm/nodes/ve.dm.MWReferenceNode.js
@@ -249,6 +249,7 @@
/**
* Gets the index for the reference
+ *
* @static
* @param {Object} dataElement Element data
* @param {ve.dm.InternalList} internalList Internal list
@@ -264,6 +265,7 @@
/**
* Gets the group for the reference
+ *
* @static
* @param {Object} dataElement Element data
* @return {string} Group
@@ -274,6 +276,7 @@
/**
* Gets the index label for the reference
+ *
* @static
* @param {Object} dataElement Element data
* @param {ve.dm.InternalList} internalList Internal list
diff --git a/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.init.js
b/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.init.js
index 40e6ab3..a843036 100644
--- a/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.init.js
+++ b/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.init.js
@@ -83,6 +83,7 @@
/**
* Use deferreds to avoid loading and instantiating Target multiple
times.
+ *
* @private
* @return {jQuery.Promise}
*/
diff --git a/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
b/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
index 19a623f..87efefb 100644
--- a/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
+++ b/modules/ve-mw/init/targets/ve.init.mw.DesktopArticleTarget.js
@@ -601,6 +601,7 @@
/**
* Handle Escape key presses.
+ *
* @param {jQuery.Event} e Keydown event
*/
ve.init.mw.DesktopArticleTarget.prototype.onDocumentKeyDown = function ( e ) {
diff --git a/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
b/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
index 28a96cf..245897f 100644
--- a/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
+++ b/modules/ve-mw/init/ve.init.mw.ApiResponseCache.js
@@ -69,6 +69,7 @@
* Look up data about a title. If the data about this title is already in the
cache, this
* returns an already-resolved promise. Otherwise, it returns a pending
promise and schedules
* an request to retrieve the data.
+ *
* @param {string} title Title
* @return {jQuery.Promise} Promise that will be resolved with the data once
it's available
*/
diff --git a/modules/ve-mw/init/ve.init.mw.ImageInfoCache.js
b/modules/ve-mw/init/ve.init.mw.ImageInfoCache.js
index 8c20038..a29ea60 100644
--- a/modules/ve-mw/init/ve.init.mw.ImageInfoCache.js
+++ b/modules/ve-mw/init/ve.init.mw.ImageInfoCache.js
@@ -7,6 +7,7 @@
/**
* Get information about images.
+ *
* @class
* @extends ve.init.mw.ApiResponseCache
* @constructor
diff --git a/modules/ve-mw/init/ve.init.mw.LinkCache.js
b/modules/ve-mw/init/ve.init.mw.LinkCache.js
index 39694c9..6eb8e3c 100644
--- a/modules/ve-mw/init/ve.init.mw.LinkCache.js
+++ b/modules/ve-mw/init/ve.init.mw.LinkCache.js
@@ -7,6 +7,7 @@
/**
* Caches information about titles.
+ *
* @class
* @extends ve.init.mw.ApiResponseCache
* @constructor
diff --git a/modules/ve-mw/init/ve.init.mw.TargetEvents.js
b/modules/ve-mw/init/ve.init.mw.TargetEvents.js
index 19f0c72..2cdd089 100644
--- a/modules/ve-mw/init/ve.init.mw.TargetEvents.js
+++ b/modules/ve-mw/init/ve.init.mw.TargetEvents.js
@@ -91,6 +91,7 @@
/**
* Track when the save is complete
+ *
* @param {string} content
* @param {string} categoriesHtml
* @param {number} newRevId
@@ -156,6 +157,7 @@
/**
* Record activation having started.
+ *
* @param {number} [startTime] Timestamp activation started. Defaults to
current time
*/
ve.init.mw.TargetEvents.prototype.trackActivationStart = function ( startTime
) {
diff --git a/modules/ve-mw/init/ve.init.mw.TargetLoader.js
b/modules/ve-mw/init/ve.init.mw.TargetLoader.js
index 7fbeb8d..19c0f51 100644
--- a/modules/ve-mw/init/ve.init.mw.TargetLoader.js
+++ b/modules/ve-mw/init/ve.init.mw.TargetLoader.js
@@ -87,6 +87,7 @@
/**
* Request the page HTML and various metadata from the
MediaWiki API and Parsoid.
+ *
* @return {jQuery.Promise} Abortable promise resolved with a
JSON object
*/
requestPageData: function ( pageName, oldid, targetName ) {
diff --git a/modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
b/modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
index 107c177..ad2badd 100644
--- a/modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
+++ b/modules/ve-mw/ui/actions/ve.ui.MWLinkAction.js
@@ -40,6 +40,7 @@
* Closing parens are only stripped if open parens are missing from the
* candidate text, so that URLs with embedded matched parentheses (like
* wiki articles with disambiguation text) autolink nicely.
+ *
* @method
* @inheritdoc
*/
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
index bd93667..83168bd 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWCitationDialog.js
@@ -144,6 +144,7 @@
/**
* Works out whether there are any set parameters that aren't just placeholders
+ *
* @return boolean
*/
ve.ui.MWCitationDialog.prototype.hasUsefulParameter = function () {
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
index 01901cc..aa86b7d 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
@@ -592,6 +592,7 @@
/**
* Fetch a bigger image thumbnail from the API.
+ *
* @param {string} imageName Image source
* @param {Object} dimensions Image dimensions
* @return {jQuery.Promise} Thumbnail promise that resolves with new thumb url
@@ -633,6 +634,7 @@
/**
* Clean the API responses and return it in plaintext. If needed, truncate.
+ *
* @param {string} rawResponse Raw response from the API
* @param {Object} config Configuration options
* @return {string} Plaintext clean response
@@ -660,6 +662,7 @@
/**
* Get the file type from the suffix of the url
+ *
* @param {string} url Full file url
* @return {string} File type
*/
@@ -676,6 +679,7 @@
/**
* Get the proper icon for the license if it is recognized
* or general info icon if it is not recognized.
+ *
* @param {string} license License short name
* @return {string} Icon name
*/
@@ -884,6 +888,7 @@
/**
* Respond to change in alternate text
+ *
* @param {string} text New alternate text
*/
ve.ui.MWMediaDialog.prototype.onAlternateTextChange = function ( text ) {
@@ -977,6 +982,7 @@
/**
* Switch between the edit and insert/search panels
+ *
* @param {string} panel Panel name
* @param {boolean} [stopSearchRequery] Do not re-query the API for the search
panel
*/
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
index 70c3b8a..13af0c6 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWSaveDialog.js
@@ -267,6 +267,7 @@
/**
* Remove a message from the save dialog.
+ *
* @param {string} name Message's unique name
*/
ve.ui.MWSaveDialog.prototype.clearMessage = function ( name ) {
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
index 04dcf70..f665c62 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
@@ -379,6 +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.
+ *
* @return {jQuery.Deferred}
*/
ve.ui.MWTemplateDialog.prototype.checkRequiredParameters = function () {
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
index 092907d..77fafcf 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
@@ -67,6 +67,7 @@
/**
* Respond to the parameter search widget showAll event
+ *
* @fires showAll
*/
ve.ui.MWParameterPlaceholderPage.prototype.onParameterShowAll = function () {
diff --git a/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
b/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
index 4c764b6..f29b2bf 100644
--- a/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
+++ b/modules/ve-mw/ui/pages/ve.ui.MWSettingsPage.js
@@ -152,6 +152,7 @@
/**
* Add a checkbox to the list of changeable page settings
+ *
* @param {string} metaName The name of the DM meta item
* @param {string} label The label to show next to the checkbox
*/
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
index 106ab25..0429eac 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWCategoryWidget.js
@@ -203,6 +203,7 @@
/**
* Toggles popup menu per category item
+ *
* @param {Object} item
*/
ve.ui.MWCategoryWidget.prototype.onTogglePopupMenu = function ( item ) {
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
index 327b063..f9d9ca1 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaInfoFieldWidget.js
@@ -149,6 +149,7 @@
/**
* Get field type; 'attribute' or 'description'
+ *
* @return {string} Field type
*/
ve.ui.MWMediaInfoFieldWidget.prototype.getType = function () {
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
index 4f0b7b2..e27035e 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaResultWidget.js
@@ -144,6 +144,7 @@
/**
* Retrieve the store dimensions object
+ *
* @return {Object} Thumb dimensions
*/
ve.ui.MWMediaResultWidget.prototype.getDimensions = function () {
@@ -225,6 +226,7 @@
/**
* Set the row this result is in.
+ *
* @param {number} row Row number
*/
ve.ui.MWMediaResultWidget.prototype.setRow = function ( row ) {
@@ -233,6 +235,7 @@
/**
* Get the row this result is in.
+ *
* @return {number} row Row number
*/
ve.ui.MWMediaResultWidget.prototype.getRow = function () {
@@ -241,6 +244,7 @@
/**
* Check if the image has a src attribute already
+ *
* @return {boolean} Thumbnail has its source attribute set
*/
ve.ui.MWMediaResultWidget.prototype.hasSrc = function () {
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
index ad74cab..3eac83e 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWMediaSearchWidget.js
@@ -328,6 +328,7 @@
* Respond to add results event in the results widget.
* Override the way SelectWidget and GroupElement append the items
* into the group so we can append them in groups of rows.
+ *
* @param {ve.ui.MWMediaResultWidget[]} items An array of item elements
*/
ve.ui.MWMediaSearchWidget.prototype.onResultsAdd = function ( items ) {
@@ -403,6 +404,7 @@
/**
* Respond to removing results event in the results widget.
* Clear the relevant rows.
+ *
* @param {OO.ui.OptionWidget[]} items Removed items
*/
ve.ui.MWMediaSearchWidget.prototype.onResultsRemove = function ( items ) {
@@ -416,6 +418,7 @@
/**
* Set language for the search results.
+ *
* @param {string} lang Language
*/
ve.ui.MWMediaSearchWidget.prototype.setLang = function ( lang ) {
@@ -424,6 +427,7 @@
/**
* Get language for the search results.
+ *
* @return {string} lang Language
*/
ve.ui.MWMediaSearchWidget.prototype.getLang = function () {
diff --git a/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
b/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
index beb8a6f..3fb8493 100644
--- a/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
+++ b/modules/ve-mw/ui/widgets/ve.ui.MWReferenceSearchWidget.js
@@ -54,6 +54,7 @@
/**
* Set the internal list and check if it contains any references
+ *
* @param {ve.dm.InternalList} internalList Internal list
*/
ve.ui.MWReferenceSearchWidget.prototype.setInternalList = function (
internalList ) {
--
To view, visit https://gerrit.wikimedia.org/r/232551
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I7c0fabc93834d19198caea8f5dd1834e9e473d0a
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
