[MediaWiki-commits] [Gerrit] mediawiki...Wikibase[master]: Fix incomplete JSDoc blocks

2016-10-18 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged.

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 repo/resources/jquery.wikibase/jquery.wikibase.entitysearch.js
M view/resources/jquery/ui/jquery.ui.EditableTemplatedWidget.js
M view/resources/jquery/wikibase/jquery.wikibase.entityselector.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
10 files changed, 67 insertions(+), 16 deletions(-)

Approvals:
  Hoo man: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js 
b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
index aa096f4..97d8fcb 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
@@ -268,12 +268,17 @@
 
/**
 * @see jQuery.ui.suggester._createMenuItemFromSuggestion
+* @protected
+*
+* @param {wikibase.Site} site
+* @param {string} requestTerm
+* @return {jQuery.wikibase.siteselector.Item}
 */
-   _createMenuItemFromSuggestion: function( suggestion, 
requestTerm ) {
+   _createMenuItemFromSuggestion: function( site, requestTerm ) {
return new $.wikibase.siteselector.Item(
-   this._createItemLabel( suggestion, requestTerm 
),
-   this._createItemValue( suggestion ),
-   suggestion
+   this._createItemLabel( site, requestTerm ),
+   this._createItemValue( site ),
+   site
);
},
 
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/repo/resources/jquery.wikibase/jquery.wikibase.entitysearch.js 
b/repo/resources/jquery.wikibase/jquery.wikibase.entitysearch.js
index 9a2c2f9..3355938 100644
--- a/repo/resources/jquery.wikibase/jquery.wikibase.entitysearch.js
+++ b/repo/resources/jquery.wikibase/jquery.wikibase.entitysearch.js
@@ -46,13 +46,17 @@
},
 
/**
-*@see jQuery.wikibase.entityselector._createMenuItemFromSuggestion
+* @see jQuery.wikibase.entityselector._createMenuItemFromSuggestion
+* @protected
+*
+* @param {Object} entityStub
+* @return {jQuery.wikibase.entityselector.Item}
 */
-   _createMenuItemFromSuggestion: function( suggestion ) {
-   var $label = this._createLabelFromSuggestion( suggestion ),
-   value = suggestion.label || suggestion.id;
+   _createMenuItemFromSuggestion: function( entityStub ) {
+   var $label = this._createLabelFromSuggestion( entityStub ),
+   value = entityStub.label || entityStub.id;
 
-   return new PARENT.Item( $label, value, suggestion );
+   return new PARENT.Item( $label, value, entityStub );
},
 
/**
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.entityselector.js 
b/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
index b4f0a80..4f66d9e 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
@@ -323,14 +323,17 @@
},
 
/**
-* @inheritdoc
+* @see jQuery.ui.suggester._createMenuItemFromSuggestion
 * @protected
+

[MediaWiki-commits] [Gerrit] mediawiki...Wikibase[master]: Fix incomplete JSDoc blocks

2016-10-13 Thread WMDE 
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.