jenkins-bot has submitted this change and it was merged.
Change subject: Hygiene: Complete JS documentation
......................................................................
Hygiene: Complete JS documentation
Suppress the warnings
Change-Id: Ie264b1f6b127434479cbfff408f448f243467cd2
---
M javascripts/modules/watchlist/WatchList.js
M javascripts/modules/wikigrok/WikiGrokDialog.js
M javascripts/modules/wikigrok/WikiGrokDialogB.js
3 files changed, 18 insertions(+), 3 deletions(-)
Approvals:
Jhernandez: Looks good to me, approved
jenkins-bot: Verified
diff --git a/javascripts/modules/watchlist/WatchList.js
b/javascripts/modules/watchlist/WatchList.js
index 57b6df9..34abed6 100644
--- a/javascripts/modules/watchlist/WatchList.js
+++ b/javascripts/modules/watchlist/WatchList.js
@@ -3,6 +3,7 @@
PageList = M.require( 'modules/PageList' );
/**
+ * An extension of the PageList which preloads pages as all being
watched.
* @extends PageList
* @class WatchList
*/
diff --git a/javascripts/modules/wikigrok/WikiGrokDialog.js
b/javascripts/modules/wikigrok/WikiGrokDialog.js
index dad0f6b..dadc02f 100644
--- a/javascripts/modules/wikigrok/WikiGrokDialog.js
+++ b/javascripts/modules/wikigrok/WikiGrokDialog.js
@@ -72,7 +72,10 @@
/**
* Log data to the schema
* @method
- * @param {string} action
+ * @param {string} action to log as described in schema
+ * See [Schema][1] for details on valid values.
+ *
+ * [1]:
https://meta.wikimedia.org/wiki/Schema:MobileWebWikiGrok}
*/
log: function ( action ) {
var data = {
@@ -94,7 +97,10 @@
/**
* Log data to the error schema
* @method
- * @param {string} error
+ * @param {string} error to log as described in schema
+ * See [Schema][1] for details on valid values.
+ *
+ * [1]:
https://meta.wikimedia.org/wiki/Schema:MobileWebWikiGrok}
*/
logError: function ( error ) {
var data = {
@@ -139,6 +145,13 @@
return result;
},
+ /**
+ * Creates a question with a yes, no and not sure answer
+ * Makes API request to Wikidata to retrieve labels.
+ * FIXME: No i18n
+ * @method
+ * @param {Object} options needed to render.
+ */
askWikidataQuestion: function ( options ) {
var self = this,
vowels = [ 'a', 'e', 'i', 'o', 'u' ],
diff --git a/javascripts/modules/wikigrok/WikiGrokDialogB.js
b/javascripts/modules/wikigrok/WikiGrokDialogB.js
index 40a0634..cabae47 100644
--- a/javascripts/modules/wikigrok/WikiGrokDialogB.js
+++ b/javascripts/modules/wikigrok/WikiGrokDialogB.js
@@ -107,8 +107,9 @@
/**
* Fetch suggestions from the server and show them to the user.
* Also record claims when the user hits the save button.
+ * FIXME: Please refactor
* @method
- * @param {Object} options
+ * @param {Object} options needed to render
*/
askWikidataQuestion: function ( options ) {
var self = this;
--
To view, visit https://gerrit.wikimedia.org/r/171996
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ie264b1f6b127434479cbfff408f448f243467cd2
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Jdlrobson <[email protected]>
Gerrit-Reviewer: Awjrichards <[email protected]>
Gerrit-Reviewer: Jhernandez <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
