From: Timo Tijhof <krinklemail@gmail.com>
Date: Sun, 6 Oct 2013 22:15:36 +0000 (+0200)
Subject: mediawiki.page.gallery: Clean up documentation for hook
X-Git-Tag: 1.31.0-rc.0~18544
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/comptes/?a=commitdiff_plain;h=3c0e9b2ff082cf8cab45beff10c6f21b9d1cd8ca;p=lhc%2Fweb%2Fwiklou.git

mediawiki.page.gallery: Clean up documentation for hook

Follows-up 14b3f87.

Change-Id: Ia917516d985a6e6f6e4bbca9ea8b5437175a6aa8
---

diff --git a/resources/mediawiki.page/mediawiki.page.gallery.js b/resources/mediawiki.page/mediawiki.page.gallery.js
index ddf63a853a..147a869d87 100644
--- a/resources/mediawiki.page/mediawiki.page.gallery.js
+++ b/resources/mediawiki.page/mediawiki.page.gallery.js
@@ -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 ) {