mediawiki.Upload, mediawiki.Upload.Dialog: Tweak documentation
authorBartosz Dziewoński <matma.rex@gmail.com>
Tue, 18 Aug 2015 16:11:50 +0000 (18:11 +0200)
committerBartosz Dziewoński <matma.rex@gmail.com>
Tue, 18 Aug 2015 16:11:50 +0000 (18:11 +0200)
Mostly whitespace changes, since my editor insists on highlighting
mixed tabs and spaces as errors.

Change-Id: I17ccff4ea80c15015fb156547abd0db87c1ab8a1

resources/src/mediawiki/mediawiki.Upload.Dialog.js
resources/src/mediawiki/mediawiki.Upload.js

index c47dd55..3c10eeb 100644 (file)
         *
         * ## 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.
         *
@@ -33,7 +32,7 @@
         * ## 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();
@@ -44,7 +43,7 @@
         * 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
         *
index 2d4bef0..551aa9d 100644 (file)
         *
         * 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.