jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/369609 )
Change subject: Fix documentation issues in JSDoc comments
......................................................................
Fix documentation issues in JSDoc comments
Change-Id: Ic501c4ef01d7bb07419e5a046318dea4d9cc0ee1
---
M lib/jquery.ui/jquery.ui.listrotator.js
M lib/jquery/jquery.PurposedCallbacks.js
M lib/util/util.CombiningMessageProvider.js
M lib/util/util.ContentLanguages.js
M lib/util/util.Extendable.js
M lib/util/util.HashMessageProvider.js
M lib/util/util.MessageProvider.js
M lib/util/util.Notifier.js
M lib/util/util.PrefixingMessageProvider.js
M src/jquery.valueview.Expert.js
10 files changed, 25 insertions(+), 4 deletions(-)
Approvals:
Jakob: Looks good to me, approved
jenkins-bot: Verified
diff --git a/lib/jquery.ui/jquery.ui.listrotator.js
b/lib/jquery.ui/jquery.ui.listrotator.js
index d730a22..55f9b4c 100644
--- a/lib/jquery.ui/jquery.ui.listrotator.js
+++ b/lib/jquery.ui/jquery.ui.listrotator.js
@@ -341,9 +341,9 @@
* Sets/Gets the widget's value. Setting the value involves setting the
rotator to the
* specified value without any animation.
*
- * @param [value] The value to assign. (Has to match a value actually
existing in the widget's
+ * @param {*} [value] The value to assign. (Has to match a value
actually existing in the widget's
* options.)
- * @return {string} Current value.
+ * @return {*} Current value.
*/
value: function( value ) {
// Get the current value:
diff --git a/lib/jquery/jquery.PurposedCallbacks.js
b/lib/jquery/jquery.PurposedCallbacks.js
index 027bb65..5f7764a 100644
--- a/lib/jquery/jquery.PurposedCallbacks.js
+++ b/lib/jquery/jquery.PurposedCallbacks.js
@@ -166,7 +166,7 @@
*
* @param {*} context
* @param {string|string[]} purposes
- * @param [args]
+ * @param {array} [args]
* @return {*}
*
* @throws {Error} in case `purposes` were defined in the
constructor and a purpose given
diff --git a/lib/util/util.CombiningMessageProvider.js
b/lib/util/util.CombiningMessageProvider.js
index 9a769d5..b4deaf4 100644
--- a/lib/util/util.CombiningMessageProvider.js
+++ b/lib/util/util.CombiningMessageProvider.js
@@ -21,6 +21,9 @@
this._b = alternativeMessageProvider;
}
+ /**
+ * @class util.CombiningMessageProvider
+ */
CombiningMessageProvider.prototype = {
constructor: CombiningMessageProvider,
diff --git a/lib/util/util.ContentLanguages.js
b/lib/util/util.ContentLanguages.js
index 048d2b8..dc290dd 100644
--- a/lib/util/util.ContentLanguages.js
+++ b/lib/util/util.ContentLanguages.js
@@ -17,6 +17,9 @@
util.ContentLanguages = function() {
};
+ /**
+ * @class util.ContentLanguages
+ */
util.ContentLanguages.prototype = {
/**
* Returns all registered language codes or `null` if no
information about accepted
diff --git a/lib/util/util.Extendable.js b/lib/util/util.Extendable.js
index 9a57ba6..8a2b6cb 100644
--- a/lib/util/util.Extendable.js
+++ b/lib/util/util.Extendable.js
@@ -16,6 +16,9 @@
this._extensions = [];
};
+ /**
+ * @class util.Extendable
+ */
util.Extendable.prototype = {
/**
* The list of registered extensions.
diff --git a/lib/util/util.HashMessageProvider.js
b/lib/util/util.HashMessageProvider.js
index e85e118..16bf3b3 100644
--- a/lib/util/util.HashMessageProvider.js
+++ b/lib/util/util.HashMessageProvider.js
@@ -19,6 +19,9 @@
this._messages = messages;
}
+ /**
+ * @class util.HashMessageProvider
+ */
HashMessageProvider.prototype = {
constructor: HashMessageProvider,
diff --git a/lib/util/util.MessageProvider.js b/lib/util/util.MessageProvider.js
index 0bbb081..ea01ad0 100644
--- a/lib/util/util.MessageProvider.js
+++ b/lib/util/util.MessageProvider.js
@@ -12,6 +12,9 @@
function MessageProvider() {
}
+ /**
+ * @class util.MessageProvider
+ */
MessageProvider.prototype = {
/**
* Tries to get a message
diff --git a/lib/util/util.Notifier.js b/lib/util/util.Notifier.js
index a4d2a85..b3fcf70 100644
--- a/lib/util/util.Notifier.js
+++ b/lib/util/util.Notifier.js
@@ -55,7 +55,7 @@
* function defined for that string.
*
* @param {string} notification
- * @param [args=[]] array Optional arguments that will be
provided to the callback.
+ * @param {array} [args=[]] Optional arguments that will be
provided to the callback.
* @return {boolean} Whether a notification has been sent.
false if the notification has not
* been registered in the constructor.
*/
diff --git a/lib/util/util.PrefixingMessageProvider.js
b/lib/util/util.PrefixingMessageProvider.js
index e51a431..78b93e7 100644
--- a/lib/util/util.PrefixingMessageProvider.js
+++ b/lib/util/util.PrefixingMessageProvider.js
@@ -21,6 +21,9 @@
this._messageProvider = messageProvider;
}
+ /**
+ * @class util.PrefixingMessageProvider
+ */
PrefixingMessageProvider.prototype = {
constructor: PrefixingMessageProvider,
diff --git a/src/jquery.valueview.Expert.js b/src/jquery.valueview.Expert.js
index 5c32b86..3ca4ede 100644
--- a/src/jquery.valueview.Expert.js
+++ b/src/jquery.valueview.Expert.js
@@ -136,6 +136,9 @@
this._extendable = new util.Extendable();
};
+ /**
+ * @class jQuery.valueview.Expert
+ */
vv.Expert.prototype = {
/**
* A unique UI class for this `Expert` definition. Should be
used to prefix classes on DOM
--
To view, visit https://gerrit.wikimedia.org/r/369609
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic501c4ef01d7bb07419e5a046318dea4d9cc0ee1
Gerrit-PatchSet: 1
Gerrit-Project: data-values/value-view
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
Gerrit-Reviewer: Aleksey Bekh-Ivanov (WMDE) <[email protected]>
Gerrit-Reviewer: Jakob <[email protected]>
Gerrit-Reviewer: Jonas Kress (WMDE) <[email protected]>
Gerrit-Reviewer: Ladsgroup <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
