From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Sat, 30 Aug 2014 23:30:51 +0000 (+0200)
Subject: mediawiki.action.edit: Improve #addButton documentation
X-Git-Tag: 1.31.0-rc.0~14201^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/?a=commitdiff_plain;h=15854ac6374f89ea377e9b6dc98f08b42994d5af;p=lhc%2Fweb%2Fwiklou.git

mediawiki.action.edit: Improve #addButton documentation

Change-Id: I6ba4e711dfb492357e1364681d986b0c5515599e
---

diff --git a/resources/src/mediawiki.action/mediawiki.action.edit.js b/resources/src/mediawiki.action/mediawiki.action.edit.js
index eacb9104df..e850276a03 100644
--- a/resources/src/mediawiki.action/mediawiki.action.edit.js
+++ b/resources/src/mediawiki.action/mediawiki.action.edit.js
@@ -68,17 +68,21 @@
 		 * by placing buttons in a queue if this method is called before
 		 * the toolbar is created.
 		 *
-		 * For compatiblity, passing the properties listed below as separate arguments
-		 * (in the listed order) is also supported.
+		 * For backwards-compatibility, passing `imageFile`, `speedTip`, `tagOpen`, `tagClose`,
+		 * `sampleText` and `imageId` as separate arguments (in this order) is also supported.
 		 *
-		 * @param {Object} button Object with the following properties:
-		 * @param {string} button.imageFile
-		 * @param {string} button.speedTip
-		 * @param {string} button.tagOpen
-		 * @param {string} button.tagClose
-		 * @param {string} button.sampleText
-		 * @param {string} [button.imageId]
-		 * @param {Function} [button.onClick]
+		 * @param {Object} button Object with the following properties.
+		 *  You are required to provide *either* the `onClick` parameter, or the three parameters
+		 *  `tagOpen`, `tagClose` and `sampleText`, but not both (they're mutually exclusive).
+		 * @param {string} button.imageFile Image to use for the button.
+		 * @param {string} button.speedTip Tooltip displayed when user mouses over the button.
+		 * @param {Function} [button.onClick] Function to be executed when the button is clicked.
+		 * @param {string} [button.tagOpen]
+		 * @param {string} [button.tagClose]
+		 * @param {string} [button.sampleText] Alternative to `onClick`. `tagOpen`, `tagClose` and
+		 *  `sampleText` together provide the markup that should be inserted into page text at
+		 *  current cursor position.
+		 * @param {string} [button.imageId] `id` attribute of the button HTML element.
 		 */
 		addButton: function () {
 			if ( isReady ) {