Thiemo Mättig (WMDE) has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/315692

Change subject: Fix incomplete JSDoc blocks
......................................................................

Fix incomplete JSDoc blocks

Change-Id: I543969108d68417967faa96f90231a6d6d19821a
---
M lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
M lib/resources/wikibase.Site.js
M view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js
M 
view/resources/jquery/wikibase/jquery.wikibase.entitytermsforlanguagelistview.js
M view/resources/jquery/wikibase/jquery.wikibase.pagesuggester.js
M view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
M view/resources/wikibase/wikibase.RevisionStore.js
M view/tests/qunit/jquery/wikibase/jquery.wikibase.pagesuggester.tests.js
8 files changed, 44 insertions(+), 2 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase 
refs/changes/92/315692/1

diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js 
b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
index aa096f4..baabe35 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
@@ -268,6 +268,10 @@
 
                /**
                 * @see jQuery.ui.suggester._createMenuItemFromSuggestion
+                *
+                * @param {string} suggestion
+                * @param {string} requestTerm
+                * @return {jQuery.wikibase.siteselector.Item}
                 */
                _createMenuItemFromSuggestion: function( suggestion, 
requestTerm ) {
                        return new $.wikibase.siteselector.Item(
diff --git a/lib/resources/wikibase.Site.js b/lib/resources/wikibase.Site.js
index b555aff..7bb75f3 100644
--- a/lib/resources/wikibase.Site.js
+++ b/lib/resources/wikibase.Site.js
@@ -24,7 +24,9 @@
        /**
         * Returns the sites id.
         *
-        * @since 0.4 (
+        * @since 0.4
+        *
+        * @return {string}
         */
        getId: function() {
                return this._siteDetails.id;
diff --git a/view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js 
b/view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js
index 1b7ca24..14860d5 100644
--- a/view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js
+++ b/view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js
@@ -121,6 +121,8 @@
 
        /**
         * Returns whether the widget is in edit mode.
+        *
+        * @return {boolean}
         */
        isInEditMode: function() {
                return this.element.hasClass( 'wb-edit' );
diff --git 
a/view/resources/jquery/wikibase/jquery.wikibase.entitytermsforlanguagelistview.js
 
b/view/resources/jquery/wikibase/jquery.wikibase.entitytermsforlanguagelistview.js
index fa3fd5d..b09693b 100644
--- 
a/view/resources/jquery/wikibase/jquery.wikibase.entitytermsforlanguagelistview.js
+++ 
b/view/resources/jquery/wikibase/jquery.wikibase.entitytermsforlanguagelistview.js
@@ -331,7 +331,7 @@
 
        /**
         * @param {jQuery} $this
-        * @param {int} previousTop
+        * @param {number} previousTop
         * @private
         */
        _scrollUp: function( $this, previousTop ) {
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.pagesuggester.js 
b/view/resources/jquery/wikibase/jquery.wikibase.pagesuggester.js
index 7b5189f..a8b1df0 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.pagesuggester.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.pagesuggester.js
@@ -114,6 +114,10 @@
 
        /**
         * @see jQuery.ui.suggester._createMenuItemFromSuggestion
+        *
+        * @param {string} suggestion
+        * @param {string} requestTerm
+        * @return {jQuery.ui.ooMenu.Item}
         */
        _createMenuItemFromSuggestion: function( suggestion, requestTerm ) {
                return new $.ui.ooMenu.Item(
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js 
b/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
index 01eebf0..4110dfc 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
@@ -167,6 +167,11 @@
 
        /**
         * Starts the widget's edit mode.
+        *
+        * @return {Object} jQuery.Promise
+        *         No resolved parameters.
+        *         Rejected parameters:
+        *         - {Error}
         */
        _startEditing: function() {
                return this._listview.startEditing();
diff --git a/view/resources/wikibase/wikibase.RevisionStore.js 
b/view/resources/wikibase/wikibase.RevisionStore.js
index d8ece36..9bcbe59 100644
--- a/view/resources/wikibase/wikibase.RevisionStore.js
+++ b/view/resources/wikibase/wikibase.RevisionStore.js
@@ -29,6 +29,8 @@
 $.extend( SELF.prototype, {
        /**
         * Returns the base revision id.
+        *
+        * @return {number}
         */
        getBaseRevision: function() {
                return this._revisions.baseRevision;
@@ -36,6 +38,8 @@
 
        /**
         * Returns the label revision id.
+        *
+        * @return {number}
         */
        getLabelRevision: function() {
                return this._revisions.labelRevision;
@@ -43,6 +47,8 @@
 
        /**
         * Returns the description revision id.
+        *
+        * @return {number}
         */
        getDescriptionRevision: function() {
                return this._revisions.descriptionRevision;
@@ -50,6 +56,8 @@
 
        /**
         * Returns the aliases revision id.
+        *
+        * @return {number}
         */
        getAliasesRevision: function() {
                return this._revisions.aliasesRevision;
@@ -57,6 +65,8 @@
 
        /**
         * Returns the sitelinks revision id.
+        *
+        * @return {number}
         */
        getSitelinksRevision: function( lang ) {
                if ( Object.prototype.hasOwnProperty.call( 
this._revisions.sitelinksRevision, lang ) ) {
@@ -67,6 +77,8 @@
 
        /**
         * Returns the claim revision id.
+        *
+        * @return {number}
         */
        getClaimRevision: function( claimGuid ) {
                if ( Object.prototype.hasOwnProperty.call( 
this._revisions.claimRevisions, claimGuid ) ) {
@@ -77,6 +89,8 @@
 
        /**
         * Saves the label revision id.
+        *
+        * @param {number} rev
         */
        setLabelRevision: function( rev ) {
                this._revisions.labelRevision = rev;
@@ -84,6 +98,8 @@
 
        /**
         * Saves the description revision id.
+        *
+        * @param {number} rev
         */
        setDescriptionRevision: function( rev ) {
                this._revisions.descriptionRevision = rev;
@@ -91,6 +107,8 @@
 
        /**
         * Saves the aliases revision id.
+        *
+        * @param {number} rev
         */
        setAliasesRevision: function( rev ) {
                this._revisions.aliasesRevision = rev;
@@ -98,6 +116,9 @@
 
        /**
         * Saves the sitelinks revision id.
+        *
+        * @param {number} rev
+        * @param {string} lang
         */
        setSitelinksRevision: function( rev, lang ) {
                this._revisions.sitelinksRevision[lang] = rev;
@@ -105,6 +126,9 @@
 
        /**
         * Saves the claim revision id.
+        *
+        * @param {number} rev
+        * @param {string} claimGuid
         */
        setClaimRevision: function( rev, claimGuid ) {
                this._revisions.claimRevisions[claimGuid] = rev;
diff --git 
a/view/tests/qunit/jquery/wikibase/jquery.wikibase.pagesuggester.tests.js 
b/view/tests/qunit/jquery/wikibase/jquery.wikibase.pagesuggester.tests.js
index a6bb618..d29e305 100644
--- a/view/tests/qunit/jquery/wikibase/jquery.wikibase.pagesuggester.tests.js
+++ b/view/tests/qunit/jquery/wikibase/jquery.wikibase.pagesuggester.tests.js
@@ -9,6 +9,7 @@
         * Factory creating a jQuery.wikibase.pagesuggester widget suitable for 
testing.
         *
         * @param {Object} [options]
+        * @return {jQuery}
         */
        var newTestPageSuggester = function( options ) {
                return $( '<input />' )

-- 
To view, visit https://gerrit.wikimedia.org/r/315692
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I543969108d68417967faa96f90231a6d6d19821a
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to