jenkins-bot has submitted this change and it was merged.
Change subject: Use null for abstract methods and correct documentation
......................................................................
Use null for abstract methods and correct documentation
Most methods documented as @abstract are not.
Bug: T54482
Change-Id: I4e1883064cd573c237a41612c4897e633bd1fda6
---
M src/Dialog.js
M src/Tool.js
M src/Window.js
M src/core.js
4 files changed, 4 insertions(+), 16 deletions(-)
Approvals:
Jforrester: Looks good to me, approved
jenkins-bot: Verified
diff --git a/src/Dialog.js b/src/Dialog.js
index 5294681..e7663fb 100644
--- a/src/Dialog.js
+++ b/src/Dialog.js
@@ -192,7 +192,6 @@
* accept steps to the process the parent method provides using the {@link
OO.ui.Process#first 'first'}
* and {@link OO.ui.Process#next 'next'} methods of OO.ui.Process.
*
- * @abstract
* @param {string} [action] Symbolic name of action
* @return {OO.ui.Process} Action process
*/
diff --git a/src/Tool.js b/src/Tool.js
index b28c80c..c85057e 100644
--- a/src/Tool.js
+++ b/src/Tool.js
@@ -196,28 +196,22 @@
*
* This is an abstract method that must be overridden in a concrete subclass.
*
+ * @method
* @protected
* @abstract
*/
-OO.ui.Tool.prototype.onUpdateState = function () {
- throw new Error(
- 'OO.ui.Tool.onUpdateState not implemented in this subclass:' +
this.constructor
- );
-};
+OO.ui.Tool.prototype.onUpdateState = null;
/**
* Handle the tool being selected.
*
* This is an abstract method that must be overridden in a concrete subclass.
*
+ * @method
* @protected
* @abstract
*/
-OO.ui.Tool.prototype.onSelect = function () {
- throw new Error(
- 'OO.ui.Tool.onSelect not implemented in this subclass:' +
this.constructor
- );
-};
+OO.ui.Tool.prototype.onSelect = null;
/**
* Check if the tool is active.
diff --git a/src/Window.js b/src/Window.js
index 4ac032f..03d8544 100644
--- a/src/Window.js
+++ b/src/Window.js
@@ -312,7 +312,6 @@
* To add window content that persists between openings, you may wish to use
the #initialize method
* instead.
*
- * @abstract
* @param {Object} [data] Window opening data
* @return {OO.ui.Process} Setup process
*/
@@ -331,7 +330,6 @@
* provides using the {@link OO.ui.Process#first first} and {@link
OO.ui.Process#next next}
* methods of OO.ui.Process.
*
- * @abstract
* @param {Object} [data] Window opening data
* @return {OO.ui.Process} Ready process
*/
@@ -350,7 +348,6 @@
* using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next
next} methods
* of OO.ui.Process.
*
- * @abstract
* @param {Object} [data] Window closing data
* @return {OO.ui.Process} Hold process
*/
@@ -369,7 +366,6 @@
* using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next
next} methods
* of OO.ui.Process.
*
- * @abstract
* @param {Object} [data] Window closing data
* @return {OO.ui.Process} Teardown process
*/
diff --git a/src/core.js b/src/core.js
index f7bd19f..8c8dbb5 100644
--- a/src/core.js
+++ b/src/core.js
@@ -336,7 +336,6 @@
* Alternative implementations of OO.ui.msg may use any substitution
system they like, as long as
* they support unnamed, ordered message parameters.
*
- * @abstract
* @param {string} key Message key
* @param {Mixed...} [params] Message parameters
* @return {string} Translated message with parameters substituted
--
To view, visit https://gerrit.wikimedia.org/r/252605
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4e1883064cd573c237a41612c4897e633bd1fda6
Gerrit-PatchSet: 2
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Esanders <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
