Merge "Make show/hide link in RC individually localizable"

[lhc/web/wiklou.git] / resources / mediawiki.page / mediawiki.page.gallery.js

diff --git a/resources/mediawiki.page/mediawiki.page.gallery.js b/resources/mediawiki.page/mediawiki.page.gallery.js
index ddf63a8..64efbb9 100644 (file)
--- a/resources/mediawiki.page/mediawiki.page.gallery.js
+++ b/resources/mediawiki.page/mediawiki.page.gallery.js
@@ -29,7 +29,7 @@
                // Now on to justification.
                // We may still get ragged edges if someone resizes their window. Could bind to
                // that event, otoh do we really want to constantly be resizing galleries?
-               $( galleries ).each( function() {
+               $( galleries ).each( function () {
                        var lastTop,
                                $img,
                                imgWidth,
@@ -37,9 +37,9 @@
                                rows = [],
                                $gallery = $( this );
 
-                       $gallery.children( 'li' ).each( function() {
+                       $gallery.children( 'li' ).each( function () {
                                // Math.floor to be paranoid if things are off by 0.00000000001
-                               var top = Math.floor( $(this ).position().top ),
+                               var top = Math.floor( $( this ).position().top ),
                                        $this = $( this );
 
                                if ( top !== lastTop ) {
@@ -74,9 +74,9 @@
                                        captionWidth: $this.children().children( 'div.gallerytextwrapper' ).width(),
                                        height: imgHeight
                                };
-                       });
+                       } );
 
-                       (function () {
+                       ( function () {
                                var maxWidth,
                                        combinedAspect,
                                        combinedPadding,
@@ -200,7 +200,7 @@
                                                        $outerDiv.width( newWidth + padding );
                                                        $innerDiv.width( newWidth + padding );
                                                        $imageDiv.width( newWidth );
-                                                       $caption.width( curRow[j].captionWidth + (newWidth - curRow[j].imgWidth ) );
+                                                       $caption.width( curRow[j].captionWidth + ( newWidth - curRow[j].imgWidth ) );
                                                }
 
                                                hookInfo = {
@@ -210,14 +210,24 @@
                                                        $innerDiv: $innerDiv,
                                                        $imageDiv: $imageDiv,
                                                        $outerDiv: $outerDiv,
-                                                       resolved: false  /* Did the hook take action */
+                                                       // Whether the hook took action
+                                                       resolved: false
                                                };
-                                               // Allow other media handlers to hook in.
-                                               // If your hook resizes an image, it is expected it will
-                                               // set resolved to true. Additionally you should load
-                                               // your module in position top to ensure it is registered
-                                               // before this runs (FIXME: there must be a better way?)
-                                               // See TimedMediaHandler for an example.
+
+                                               /**
+                                                * Gallery resize.
+                                                *
+                                                * If your handler resizes an image, it should also set the resolved
+                                                * property to true. Additionally, because this module only exposes this
+                                                * logic temporarily, you should load your module in position top to
+                                                * ensure it is registered before this runs (FIXME: Don't use mw.hook)
+                                                *
+                                                * See TimedMediaHandler for an example.
+                                                *
+                                                * @event mediawiki_page_gallery_resize
+                                                * @member mw.hook
+                                                * @param {Object} hookInfo
+                                                */
                                                mw.hook( 'mediawiki.page.gallery.resize' ).fire( hookInfo );
 
                                                if ( !hookInfo.resolved ) {