*
* ## Structure
*
- * The {@link OO.ui.ProcessDialog dialog} has three steps-
+ * The {@link OO.ui.ProcessDialog dialog} has three steps:
*
- * - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the
- * file object.
+ * - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the file object.
*
- * - **Information**: Has a {@link OO.ui.FormLayout form} to
- * collect metadata. This can be extended.
+ * - **Information**: Has a {@link OO.ui.FormLayout form} to collect metadata. This can be
+ * extended.
*
* - **Insert**: Has details on how to use the file that was uploaded.
*
* ## Usage
*
* To use, setup a {@link OO.ui.WindowManager window manager} like for normal
- * dialogs-
+ * dialogs:
*
* var uploadDialog = new mw.Upload.Dialog( { size: 'small' } );
* var windowManager = new OO.ui.WindowManager();
* The dialog's closing promise,
* {@link mw.Upload.Dialog#event-fileUploaded fileUploaded},
* and {@link mw.Upload.Dialog#event-fileSaved fileSaved} events can
- * be used to get details of the upload
+ * be used to get details of the upload.
*
* ## Extending
*
*
* A simple example:
*
- * var file = new OO.ui.SelectFileWidget(),
- * button = new OO.ui.ButtonWidget( { label: 'Save' } ),
- * upload = new mw.Upload;
+ * var file = new OO.ui.SelectFileWidget(),
+ * button = new OO.ui.ButtonWidget( { label: 'Save' } ),
+ * upload = new mw.Upload;
*
- * button.on( 'click', function () {
- * upload.setFile( file.getValue() );
- * upload.setFilename( file.getValue().name );
- * upload.upload();
- * } );
+ * button.on( 'click', function () {
+ * upload.setFile( file.getValue() );
+ * upload.setFilename( file.getValue().name );
+ * upload.upload();
+ * } );
*
- * $( 'body' ).append( file.$element, button.$element );
+ * $( 'body' ).append( file.$element, button.$element );
*
* You can also choose to {@link #uploadToStash stash the upload} and
* {@link #finishStashUpload finalize} it later:
*
- * var file, // Some file object
- * upload = new mw.Upload,
- * stashPromise = $.Deferred();
+ * var file, // Some file object
+ * upload = new mw.Upload,
+ * stashPromise = $.Deferred();
*
- * upload.setFile( file );
- * upload.uploadToStash().then( function () {
- * stashPromise.resolve();
- * } );
+ * upload.setFile( file );
+ * upload.uploadToStash().then( function () {
+ * stashPromise.resolve();
+ * } );
*
- * stashPromise.then( function () {
- * upload.setFilename( 'foo' );
- * upload.setText( 'bar' );
- * upload.finishStashUpload().then( function () {
- * console.log( 'Done!' );
- * } );
- * } );
+ * stashPromise.then( function () {
+ * upload.setFilename( 'foo' );
+ * upload.setText( 'bar' );
+ * upload.finishStashUpload().then( function () {
+ * console.log( 'Done!' );
+ * } );
+ * } );
*
* @constructor
* @param {Object} apiconfig Passed to the constructor of mw.Api.