Jforrester has uploaded a new change for review.
https://gerrit.wikimedia.org/r/247738
Change subject: build: Enable jscs-jsdoc's 'requireNewlineAfterDescription'
rule and make pass
......................................................................
build: Enable jscs-jsdoc's 'requireNewlineAfterDescription' rule and make pass
Change-Id: Ife11abc7e86da00c0e84825b8821f3fa1f5d4eb3
---
M .jscsrc
M resources/mw.FlickrChecker.js
M resources/mw.UploadWizardLicenseInput.js
M resources/mw.UploadWizardUpload.js
M resources/mw.UploadWizardUploadInterface.js
M resources/transports/mw.FirefoggTransport.js
M resources/transports/mw.FormDataTransport.js
M resources/transports/mw.IframeTransport.js
M resources/ui/uw.ui.Deed.js
M resources/ui/uw.ui.DeedPreview.js
M resources/ui/uw.ui.Details.js
M resources/ui/uw.ui.Step.js
M resources/ui/uw.ui.Thanks.js
M resources/ui/uw.ui.Tutorial.js
M resources/ui/uw.ui.Upload.js
M resources/ui/uw.ui.Wizard.js
M resources/uw.EventFlowLogger.js
M resources/uw/model/uw.model.Description.js
18 files changed, 93 insertions(+), 3 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/UploadWizard
refs/changes/38/247738/1
diff --git a/.jscsrc b/.jscsrc
index dcb0f23..e7be582 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -8,6 +8,7 @@
"see": true
}
},
+ "requireNewlineAfterDescription": true,
"requireParamTypes": true,
"requireReturnTypes": true
},
diff --git a/resources/mw.FlickrChecker.js b/resources/mw.FlickrChecker.js
index e645d49..8b12a8f 100644
--- a/resources/mw.FlickrChecker.js
+++ b/resources/mw.FlickrChecker.js
@@ -60,6 +60,7 @@
* retrieved, do nothing. Note that the license look-up system
is fragile on purpose. If Flickr
* changes the name associated with a license ID, it's better
for the lookup to fail than to use
* an incorrect license.
+ *
* @param {string} url The source URL to check
* @param {string} $selector The element to insert the license
name into
* @param {UploadWizardUpload} upload The upload object to set
the deed for
@@ -618,6 +619,7 @@
/**
* Retrieve the URL of the largest version available on Flickr
and set that
* as the upload URL.
+ *
* @param {number} index Index of the image for which we need
to set the URL
*/
setImageURL: function ( index ) {
diff --git a/resources/mw.UploadWizardLicenseInput.js
b/resources/mw.UploadWizardLicenseInput.js
index d9242d2..581c6a3 100644
--- a/resources/mw.UploadWizardLicenseInput.js
+++ b/resources/mw.UploadWizardLicenseInput.js
@@ -241,6 +241,7 @@
/**
* Return a radio button or checkbox with appropriate values,
depending on config
+ *
* @param {Array} of template strings
* @param {Object} config for this license input
* @return {jQuery} wrapped input
@@ -270,6 +271,7 @@
/**
* Get a label for the form element
+ *
* @param {Object} license definition from global config. Will
tell us the messages, and maybe icons.
* @param {jQuery} wrapped input
* @return {jQuery} wrapped label referring to that input, with
appropriate HTML, decorations, etc.
@@ -303,6 +305,7 @@
/**
* Given an input, return another textarea to be appended below.
* When text entered here, auto-selects the input.
+ *
* @param {jQuery} wrapped input
* @return {jQuery} wrapped textarea
*/
@@ -374,6 +377,7 @@
/**
* Sets the value(s) of a license input. This is a little bit
klugey because it relies on an inverted dict, and in some
* cases we are now letting license inputs create multiple
templates.
+ *
* @param {object} values License-key to boolean values, e.g. {
'cc_by_sa_30': true, gfdl: true, 'flickrreview|cc_by_sa_30': false }
*/
setValues: function ( values ) {
@@ -431,6 +435,7 @@
/**
* Gets the wikitext associated with all selected inputs. Some
inputs also have associated textareas so we append their contents too.
+ *
* @return {string} of wikitext (empty string if no inputs set)
*/
getWikiText: function () {
@@ -453,6 +458,7 @@
/**
* Get the value of the associated textarea, if any
+ *
* @return {string}
*/
getInputTextAreaVal: function ( $input ) {
@@ -465,6 +471,7 @@
/**
* Gets which inputs have user-entered values
+ *
* @return {jQuery Array} of inputs
*/
getSelectedInputs: function () {
@@ -477,6 +484,7 @@
* Side effect: if no valid value, add error notices to the
interface. Add listeners to interface, to revalidate and remove notices
* If I was sufficiently clever, most of these could just be
dynamically added & subtracted validation rules.
* Instead this is a bit of a recapitulation of jquery.validate
+ *
* @return {boolean} true if a value set and all is well, false
otherwise
*/
valid: function () {
@@ -535,6 +543,7 @@
/**
* Returns true if any license is set
+ *
* @return {boolean}
*/
isSet: function () {
@@ -543,6 +552,7 @@
/**
* Preview wikitext in a popup window
+ *
* @param {string} wikitext
*/
showPreview: function ( wikiText ) {
diff --git a/resources/mw.UploadWizardUpload.js
b/resources/mw.UploadWizardUpload.js
index 4dfbe30..711b55b 100644
--- a/resources/mw.UploadWizardUpload.js
+++ b/resources/mw.UploadWizardUpload.js
@@ -79,6 +79,7 @@
/**
* Manually fill the file input with a file.
+ *
* @param {File} providedFile
*/
mw.UploadWizardUpload.prototype.fill = function ( providedFile ) {
@@ -107,6 +108,7 @@
/**
* start
+ *
* @return {jQuery.Promise}
*/
mw.UploadWizardUpload.prototype.start = function () {
@@ -135,6 +137,7 @@
/**
* Wear our current progress, for observing processes to see
+ *
* @param {number} fraction
*/
mw.UploadWizardUpload.prototype.setTransportProgress = function (
fraction ) {
@@ -171,6 +174,7 @@
/**
* To be executed when an individual upload finishes. Processes the
result and updates step 2's details
+ *
* @param {Object} result The API result in parsed JSON form
*/
mw.UploadWizardUpload.prototype.setTransported = function ( result ) {
@@ -266,6 +270,7 @@
/**
* Helper function to generate duplicate errors in a possibly
collapsible list.
* Works with existing duplicates and deleted dupes.
+ *
* @param {string} code Error code, should have matching strings in
.i18n.php
* @param {Object} resultDuplicate Portion of the API error result
listing duplicates
* @return {jQuery}
@@ -319,6 +324,7 @@
/**
* Called from any upload success condition
+ *
* @param {Mixed} result -- result of AJAX call
*/
mw.UploadWizardUpload.prototype.setSuccess = function ( result ) {
@@ -358,6 +364,7 @@
/**
* Shows a filename error in the UI.
+ *
* @param {string} code Short code for i18n strings
* @param {string} info More information
*/
@@ -554,6 +561,7 @@
/**
* Sanitize and set the title of the upload.
+ *
* @param {string} title Unsanitized title.
*/
mw.UploadWizardUpload.prototype.setTitle = function ( title ) {
@@ -569,6 +577,7 @@
/**
* Shows an error dialog informing the user that the selected file is
to large
+ *
* @param {number} size Size of the file in bytes
* @param {number} maxSize Maximum file size
*/
@@ -587,6 +596,7 @@
/**
* Map fields from jpegmeta's metadata return into our format (which is
more like the imageinfo returned from the API
+ *
* @param {Object} (as returned by jpegmeta)
*/
mw.UploadWizardUpload.prototype.extractMetadataFromJpegMeta = function
( meta ) {
@@ -645,6 +655,7 @@
* Extract image info into our upload object
* Image info is obtained from various different API methods
* This may overwrite metadata obtained from FileReader.
+ *
* @param {Object} imageinfo JSON object obtained from API result.
*/
mw.UploadWizardUpload.prototype.extractImageInfo = function ( imageinfo
) {
@@ -674,7 +685,9 @@
/**
* Get information about stashed images
+ *
* See API documentation for prop=stashimageinfo for what 'props' can
contain
+ *
* @param {Function} callback -- called with null if failure, with
imageinfo data structure if success
* @param {Array} properties to extract
* @param {number} optional, width of thumbnail. Will force 'url' to be
added to props
@@ -724,6 +737,7 @@
* Get information about published images
* (There is some overlap with getStashedImageInfo, but it's different
at every stage so it's clearer to have separate functions)
* See API documentation for prop=imageinfo for what 'props' can contain
+ *
* @param {Function} callback -- called with null if failure, with
imageinfo data structure if success
* @param {Array} properties to extract
* @param {number} optional, width of thumbnail. Will force 'url' to be
added to props
@@ -786,6 +800,7 @@
/**
* Get the upload handler per browser capabilities
+ *
* @return {ApiUploadHandler} upload handler object
*/
mw.UploadWizardUpload.prototype.getUploadHandler = function () {
@@ -897,6 +912,7 @@
/**
* Return the orientation of the image in degrees. Relies on metadata
that
* may have been extracted at filereader stage, or after the upload
when we fetch metadata. Default returns 0.
+ *
* @return {Integer} orientation in degrees: 0, 90, 180 or 270
*/
mw.UploadWizardUpload.prototype.getOrientationDegrees = function () {
@@ -927,6 +943,7 @@
/**
* Fit an image into width & height constraints with scaling factor
+ *
* @param {HTMLImageElement}
* @param {Object} with width & height properties
* @return {number}
@@ -948,6 +965,7 @@
/**
* Given an image (already loaded), dimension constraints
* return canvas object scaled & transformedi ( & rotated if metadata
indicates it's needed )
+ *
* @param {HTMLImageElement}
* @param {Object} containing width & height constraints
* @return {HTMLCanvasElement}
@@ -1020,6 +1038,7 @@
/**
* Return a browser-scaled image element, given an image and
constraints.
+ *
* @param {HTMLImageElement}
* @param {Object} with width and height properties
* @return {HTMLImageElement} with same src, but different attrs
@@ -1039,6 +1058,7 @@
/**
* Return an element suitable for the preview of a certain size. Uses
canvas when possible
+ *
* @param {HTMLImageElement}
* @param {Integer} width
* @param {Integer} height
@@ -1072,6 +1092,7 @@
/**
* This callback will add an image to the selector, using
in-browser scaling if necessary
+ *
* @param {HTMLImageElement|null}
*/
function placeImageCallback( image ) {
diff --git a/resources/mw.UploadWizardUploadInterface.js
b/resources/mw.UploadWizardUploadInterface.js
index 42c000c..4b1d7a7 100644
--- a/resources/mw.UploadWizardUploadInterface.js
+++ b/resources/mw.UploadWizardUploadInterface.js
@@ -2,6 +2,7 @@
/**
* Create an interface fragment corresponding to a file input, suitable
for Upload Wizard.
+ *
* @class mw.UploadWizardUploadInterface
* @mixins OO.EventEmitter
* @constructor
@@ -129,6 +130,7 @@
/**
* Manually fill the file input with a file.
+ *
* @param {File} providedFile
*/
mw.UploadWizardUploadInterface.prototype.fill = function ( providedFile
) {
@@ -141,7 +143,8 @@
};
/**
- * change the graphic indicator at the far end of the row for this file
+ * Change the graphic indicator at the far end of the row for this file
+ *
* @param {string} statusClass Corresponds to a class mwe-upwiz-status
which changes style of indicator.
*/
mw.UploadWizardUploadInterface.prototype.showIndicator = function (
statusClass ) {
@@ -164,6 +167,7 @@
/**
* Set the preview image on the file page for this upload.
+ *
* @param {HTMLImageElement} image
*/
mw.UploadWizardUploadInterface.prototype.setPreview = function ( image
) {
@@ -178,6 +182,7 @@
/**
* Set the status line for this upload with an internationalized
message string.
+ *
* @param {string} msgKey Key for the message
* @param {array} args Array of values, in case any need to be fed to
the image.
*/
@@ -193,6 +198,7 @@
/**
* Set status line directly with a string
+ *
* @param {string}
*/
mw.UploadWizardUploadInterface.prototype.setStatusString = function ( s
) {
@@ -201,6 +207,7 @@
/**
* Set additional status information
+ *
* @param {jQuery} [$status] If not given or null, additional status is
cleared
*/
mw.UploadWizardUploadInterface.prototype.setAdditionalStatus = function
( $status ) {
@@ -223,6 +230,7 @@
/**
* Put the visual state of an individual upload into "progress"
+ *
* @param {number} fraction The fraction of progress. Float between 0
and 1
*/
mw.UploadWizardUploadInterface.prototype.showTransportProgress =
function () {
@@ -249,6 +257,7 @@
/**
* Show that transport has failed
+ *
* @param {string} code Error code from API
* @param {string|Object} info Extra info
* @param {jQuery} [$additionalStatus]
@@ -296,6 +305,7 @@
/**
* Get a list of the files from this file input, defaulting to the
value from the input form
+ *
* @return {Array} of File objects
*/
mw.UploadWizardUploadInterface.prototype.getFiles = function () {
@@ -315,6 +325,7 @@
/**
* Get just the filename.
+ *
* @return {string}
*/
mw.UploadWizardUploadInterface.prototype.getFilename = function () {
@@ -341,6 +352,7 @@
* Run this when the value of the file input has changed and we know
it's acceptable -- this
* will update interface to show as much info as possible, including
preview.
* n.b. in older browsers we only will know the filename
+ *
* @param {Object} imageinfo
* @param {File} file
* @param {boolean} fromURL
@@ -473,6 +485,7 @@
* or otherwise get it to do what you want.
* It is helpful to sometimes move them to cover certain elements on
the page, and
* even to pass events like hover
+ *
* @param {string} selector A jQuery-compatible selector, for a single
element
* @param {string} [positionTracking] Whether to do position-polling
('poll')
* on the selected element or whether to listen to window-resize
events ('resize')
@@ -619,6 +632,7 @@
/**
* Create a checkbox to process the object reference parameter
+ *
* @param {number} index Number of the file for which the field is being
created
* @param {boolean} setDisabled Disable in case there already is an
image in the referring list
* @return {jQuery} A `div` containing a checkbox, label, and optional
notice
diff --git a/resources/transports/mw.FirefoggTransport.js
b/resources/transports/mw.FirefoggTransport.js
index bc7867b..ea5ebd5 100644
--- a/resources/transports/mw.FirefoggTransport.js
+++ b/resources/transports/mw.FirefoggTransport.js
@@ -1,6 +1,7 @@
( function ( mw, $ ) {
/**
* Represents a "transport" for files to upload; in this case using
Firefogg.
+ *
* @class mw.FirefoggTransport
* @constructor
* @param {File} file
@@ -15,6 +16,7 @@
/**
* Do an upload
+ *
* @return {jQuery.Promise}
*/
mw.FirefoggTransport.prototype.upload = function () {
diff --git a/resources/transports/mw.FormDataTransport.js
b/resources/transports/mw.FormDataTransport.js
index e60b94f..85f8598 100644
--- a/resources/transports/mw.FormDataTransport.js
+++ b/resources/transports/mw.FormDataTransport.js
@@ -1,10 +1,10 @@
( function ( mw, $, OO ) {
/**
- * @class mw.FormDataTransport
* Represents a "transport" for files to upload; using HTML5 FormData.
- * @mixins OO.EventEmitter
*
* @constructor
+ * @class mw.FormDataTransport
+ * @mixins OO.EventEmitter
* @param {string} postUrl URL to post to.
* @param {Object} formData Additional form fields required for upload
api call
* @param {Object} [config]
@@ -55,6 +55,7 @@
/**
* Creates an XHR and sets some generic event handlers on it.
+ *
* @param {jQuery.Deferred} deferred Object to send events to.
* @return {XMLHttpRequest}
*/
@@ -75,6 +76,7 @@
/**
* Creates a FormData object suitable for upload.
+ *
* @param {string} filename
* @param {number} [offset] For chunked uploads
* @return {FormData}
@@ -108,6 +110,7 @@
/**
* Sends data in a FormData object through an XHR.
+ *
* @param {XMLHttpRequest} xhr
* @param {FormData} formData
*/
@@ -123,6 +126,7 @@
/**
* Start the upload with the provided file.
+ *
* @return {jQuery.Promise}
*/
mw.FormDataTransport.prototype.upload = function ( file ) {
@@ -164,6 +168,7 @@
/**
* Upload a single chunk.
+ *
* @param {File} file
* @param {number} offset Offset in bytes.
* @return {jQuery.Promise}
@@ -258,6 +263,7 @@
/**
* Handle possible retry event - rejected if maximum retries already
fired.
+ *
* @param {string} contextMsg
* @param {Object} response
* @param {string} retryMethod
@@ -279,6 +285,7 @@
/**
* Have we retried too many times already?
+ *
* @return {boolean}
*/
mw.FormDataTransport.prototype.tooManyRetries = function () {
@@ -287,6 +294,7 @@
/**
* Either retry uploading or checking the status.
+ *
* @param {'uploadChunk'|'checkStatus'} methodName
* @param {File} [file]
* @param {number} [offset]
@@ -311,6 +319,7 @@
/**
* Check the status of the upload.
+ *
* @return {jQuery.Promise}
*/
mw.FormDataTransport.prototype.checkStatus = function () {
@@ -359,6 +368,7 @@
/**
* Parse response from the server.
+ *
* @param {Event} evt
* @return {Object}
*/
diff --git a/resources/transports/mw.IframeTransport.js
b/resources/transports/mw.IframeTransport.js
index fa050c1..9f34c55 100644
--- a/resources/transports/mw.IframeTransport.js
+++ b/resources/transports/mw.IframeTransport.js
@@ -54,6 +54,7 @@
/**
* Accessor function
+ *
* @return {jQuery.Promise}
*/
mw.IframeTransport.prototype.getSetUpStatus = function () {
@@ -108,6 +109,7 @@
/**
* Start the upload.
+ *
* @return {jQuery.Promise}
*/
mw.IframeTransport.prototype.upload = function () {
diff --git a/resources/ui/uw.ui.Deed.js b/resources/ui/uw.ui.Deed.js
index 11ea7f8..e7e2f17 100644
--- a/resources/ui/uw.ui.Deed.js
+++ b/resources/ui/uw.ui.Deed.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard's Deed step.
+ *
* @class uw.ui.Deed
* @extends uw.ui.Step
* @constructor
diff --git a/resources/ui/uw.ui.DeedPreview.js
b/resources/ui/uw.ui.DeedPreview.js
index 1386edb..11a4b13 100644
--- a/resources/ui/uw.ui.DeedPreview.js
+++ b/resources/ui/uw.ui.DeedPreview.js
@@ -18,6 +18,7 @@
( function ( $, uw ) {
/**
* Represents the UI for a thumbnail in the Deed step.
+ *
* @class uw.ui.DeedPreview
* @constructor
* @param {mw.UploadWizardUpload} upload
diff --git a/resources/ui/uw.ui.Details.js b/resources/ui/uw.ui.Details.js
index f141f59..895572f 100644
--- a/resources/ui/uw.ui.Details.js
+++ b/resources/ui/uw.ui.Details.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard's Details step.
+ *
* @class uw.ui.Details
* @extends uw.ui.Step
* @constructor
diff --git a/resources/ui/uw.ui.Step.js b/resources/ui/uw.ui.Step.js
index 771d754..c8b55d9 100644
--- a/resources/ui/uw.ui.Step.js
+++ b/resources/ui/uw.ui.Step.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents a generic UI for a step.
+ *
* @class mw.uw.ui.Step
* @mixins OO.EventEmitter
* @constructor
@@ -35,6 +36,7 @@
/**
* Move to the step.
+ *
* @param {mw.UploadWizardUpload[]} uploads
*/
uw.ui.Step.prototype.moveTo = function ( uploads ) {
diff --git a/resources/ui/uw.ui.Thanks.js b/resources/ui/uw.ui.Thanks.js
index 58e2c21..011ff27 100644
--- a/resources/ui/uw.ui.Thanks.js
+++ b/resources/ui/uw.ui.Thanks.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard's Thanks step.
+ *
* @class uw.ui.Thanks
* @extends mw.uw.ui.Step
* @constructor
@@ -90,6 +91,7 @@
/**
* Adds an upload to the Thanks interface.
+ *
* @param {mw.UploadWizardUpload} upload
*/
uw.ui.Thanks.prototype.addUpload = function ( upload ) {
@@ -154,6 +156,7 @@
/**
* Make a read only text input, which self-selects on gaining focus
+ *
* @param {string} text it will contain
* @return {jQuery}
*/
@@ -177,6 +180,7 @@
/**
* Get button configuration options from a campaign definition
+ *
* @param {string} buttonName name of the button as defined in campaign
configuration
* @param {string} configField name of the button's attributes
* @return {Object|undefined}
@@ -191,6 +195,7 @@
/**
* Drops a parameter from the given url
+ *
* @param {string} url URL from which to drop a parameter
* @param {string} paramName parameter to be dropped
* @return {string}
diff --git a/resources/ui/uw.ui.Tutorial.js b/resources/ui/uw.ui.Tutorial.js
index 5e656d2..72bad60 100644
--- a/resources/ui/uw.ui.Tutorial.js
+++ b/resources/ui/uw.ui.Tutorial.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard's Tutorial step.
+ *
* @class uw.ui.Tutorial
* @extends uw.ui.Step
* @constructor
diff --git a/resources/ui/uw.ui.Upload.js b/resources/ui/uw.ui.Upload.js
index 2b63c6c..8837501 100644
--- a/resources/ui/uw.ui.Upload.js
+++ b/resources/ui/uw.ui.Upload.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard's Upload step.
+ *
* @class uw.ui.Upload
* @extends uw.ui.Step
* @constructor
@@ -140,6 +141,7 @@
/**
* Updates the interface based on the number of uploads.
+ *
* @param {boolean} haveUploads Whether there are any uploads at all.
* @param {boolean} fewerThanMax Whether we can add more uploads.
*/
@@ -281,6 +283,7 @@
/**
* Shows an error dialog informing the user that some uploads have been
omitted
* since they went over the max files limit.
+ *
* @param {number} filesUploaded The number of files that have been
attempted to upload
*/
uw.ui.Upload.prototype.showTooManyFilesWarning = function (
filesUploaded ) {
@@ -298,6 +301,7 @@
/**
* Checks whether flickr import is enabled and the current user has the
rights to use it
+ *
* @return {Boolean}
*/
uw.ui.Upload.prototype.isFlickrImportEnabled = function () {
diff --git a/resources/ui/uw.ui.Wizard.js b/resources/ui/uw.ui.Wizard.js
index 0744bfd..c7586d3 100644
--- a/resources/ui/uw.ui.Wizard.js
+++ b/resources/ui/uw.ui.Wizard.js
@@ -18,6 +18,7 @@
( function ( mw, $, uw, OO ) {
/**
* Represents the UI for the wizard.
+ *
* @class mw.uw.ui.Wizard
* @mixins OO.EventEmitter
* @constructor
@@ -80,6 +81,7 @@
/**
* Initializes a link to the alternate upload form, if any.
+ *
* @param {Object|string} configAltUploadForm A link or map of
languages to links, pointing at an alternate form.
*/
uw.ui.Wizard.prototype.initAltUploadForm = function (
configAltUploadForm ) {
diff --git a/resources/uw.EventFlowLogger.js b/resources/uw.EventFlowLogger.js
index 3982304..fbcddec 100644
--- a/resources/uw.EventFlowLogger.js
+++ b/resources/uw.EventFlowLogger.js
@@ -32,6 +32,7 @@
* Since UploadWizard is currently implemented as a single-page
application, this is just
* a number regenerated on every pageview. It's stored as a string to
avoid overflow problems
* on the backend.
+ *
* @private
* @return {string}
*/
@@ -49,6 +50,7 @@
* Returns a number identifying this event's position in the event flow.
* (I.e. (flowId, flowPosition) will uniquely identify an event, with
the positions for a given
* flowId going 1..N.)
+ *
* @private
* @return {number}
*/
@@ -59,6 +61,7 @@
/**
* Does the work of logging a step.
+ *
* @private
* @param {'tutorial'|'file'|'deeds'|'details'|'thanks'} step
* @param {boolean} [skipped=false]
@@ -78,6 +81,7 @@
/**
* Logs arbitrary data. This is for internal use, you should call one
of the more specific functions.
+ *
* @protected
* @param {string} schema EventLogger schema name
* @param {object} data event data (without flowId)
@@ -93,6 +97,7 @@
/**
* Logs entering into a given step of the upload process.
+ *
* @param {'tutorial'|'file'|'deeds'|'details'|'thanks'} step
* @param {Object} [extraData] Extra data to pass along in the log.
*/
@@ -102,6 +107,7 @@
/**
* Logs skipping a given step of the upload process.
+ *
* @param {'tutorial'|'file'|'deeds'|'details'|'thanks'} step
*/
uw.EventFlowLogger.prototype.logSkippedStep = function ( step ) {
@@ -110,6 +116,7 @@
/**
* Logs an event.
+ *
* @param {string} name Event name. Recognized names:
* - upload-button-clicked
* - flickr-upload-button-clicked
@@ -132,6 +139,7 @@
/**
* Logs an upload event.
+ *
* @param {string} name Event name. Recognized names:
* - upload-started
* - upload-succeeded
diff --git a/resources/uw/model/uw.model.Description.js
b/resources/uw/model/uw.model.Description.js
index 082e626..9dd8823 100644
--- a/resources/uw/model/uw.model.Description.js
+++ b/resources/uw/model/uw.model.Description.js
@@ -51,6 +51,7 @@
/**
* Gets the wikitext value of the description.
+ *
* @return {string}
*/
uw.model.Description.prototype.getValue = function () {
@@ -66,6 +67,7 @@
/**
* Sets the language.
+ *
* @param {string} language
*/
uw.model.Description.prototype.setLanguage = function ( language ) {
@@ -84,6 +86,7 @@
/**
* Sets the text.
+ *
* @param {string} text
*/
uw.model.Description.prototype.setText = function ( text ) {
--
To view, visit https://gerrit.wikimedia.org/r/247738
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ife11abc7e86da00c0e84825b8821f3fa1f5d4eb3
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/UploadWizard
Gerrit-Branch: master
Gerrit-Owner: Jforrester <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
