jenkins-bot has submitted this change and it was merged.
Change subject: mediawiki.action.edit: Improve #addButton documentation
......................................................................
mediawiki.action.edit: Improve #addButton documentation
Change-Id: I6ba4e711dfb492357e1364681d986b0c5515599e
---
M resources/src/mediawiki.action/mediawiki.action.edit.js
1 file changed, 14 insertions(+), 10 deletions(-)
Approvals:
Krinkle: Looks good to me, approved
jenkins-bot: Verified
diff --git a/resources/src/mediawiki.action/mediawiki.action.edit.js
b/resources/src/mediawiki.action/mediawiki.action.edit.js
index eacb910..e850276 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 ) {
--
To view, visit https://gerrit.wikimedia.org/r/157486
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I6ba4e711dfb492357e1364681d986b0c5515599e
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Bartosz Dziewoński <matma....@gmail.com>
Gerrit-Reviewer: Bartosz Dziewoński <matma....@gmail.com>
Gerrit-Reviewer: Helder.wiki <helder.w...@gmail.com>
Gerrit-Reviewer: Jack Phoenix <j...@countervandalism.net>
Gerrit-Reviewer: Krinkle <krinklem...@gmail.com>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
