Ricordisamoa has uploaded a new change for review.
https://gerrit.wikimedia.org/r/264101
Change subject: build: Enable jscs jsDoc rule 'requireNewlineAfterDescription'
and make pass
......................................................................
build: Enable jscs jsDoc rule 'requireNewlineAfterDescription' and make pass
As in the wikimedia preset
Change-Id: If32daa98c390e8180923c0c01726b4b93fe4be83
---
M .jscsrc
M client/resources/wikibase.client.PageConnector.js
M lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
M lib/resources/jquery.wikibase/jquery.wikibase.wbtooltip.js
M lib/resources/wikibase.Site.js
M lib/tests/qunit/wikibase.tests.js
M repo/resources/experts/Entity.js
M repo/resources/parsers/getApiBasedValueParserConstructor.js
M repo/resources/wikibase.EntityInitializer.js
M view/resources/jquery/jquery.util.EventSingletonManager.js
M view/resources/jquery/jquery.util.getDirectionality.js
M view/resources/jquery/ui/jquery.ui.TemplatedWidget.js
M view/resources/jquery/wikibase/jquery.wikibase.aliasesview.js
M view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
M view/resources/jquery/wikibase/jquery.wikibase.entitytermsview.js
M view/resources/jquery/wikibase/jquery.wikibase.entityview.js
M view/resources/jquery/wikibase/jquery.wikibase.listview.ListItemAdapter.js
M view/resources/jquery/wikibase/jquery.wikibase.listview.js
M view/resources/jquery/wikibase/jquery.wikibase.referenceview.js
M view/resources/jquery/wikibase/jquery.wikibase.sitelinkgrouplistview.js
M view/resources/jquery/wikibase/jquery.wikibase.sitelinklistview.js
M view/resources/jquery/wikibase/jquery.wikibase.sitelinkview.js
M view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
M view/resources/jquery/wikibase/jquery.wikibase.statementgrouplistview.js
M view/resources/jquery/wikibase/jquery.wikibase.statementgroupview.js
M view/resources/jquery/wikibase/jquery.wikibase.statementlistview.js
M view/resources/jquery/wikibase/jquery.wikibase.statementview.RankSelector.js
M view/resources/jquery/wikibase/jquery.wikibase.statementview.js
M view/resources/jquery/wikibase/snakview/snakview.SnakTypeSelector.js
M view/resources/jquery/wikibase/snakview/snakview.ViewState.js
M view/resources/jquery/wikibase/snakview/snakview.js
M view/resources/jquery/wikibase/snakview/snakview.variations.Value.js
M view/resources/jquery/wikibase/snakview/snakview.variations.Variation.js
M
view/resources/jquery/wikibase/toolbar/controller/jquery.wikibase.toolbarcontroller.js
M view/resources/wikibase/templates.js
M view/resources/wikibase/utilities/wikibase.utilities.ClaimGuidGenerator.js
M view/resources/wikibase/utilities/wikibase.utilities.GuidGenerator.js
M view/resources/wikibase/wikibase.RevisionStore.js
M view/resources/wikibase/wikibase.getLanguageNameByCode.js
M
view/tests/qunit/jquery/wikibase/jquery.wikibase.statementgrouplabelscroll.tests.js
M view/tests/qunit/wikibase/templates.tests.js
41 files changed, 108 insertions(+), 2 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/01/264101/1
diff --git a/.jscsrc b/.jscsrc
index 83c7557..d341dd1 100644
--- a/.jscsrc
+++ b/.jscsrc
@@ -20,8 +20,8 @@
"checkRedundantReturns": true,
"requireReturnTypes": true,
"checkTypes": "strictNativeCase",
- "checkRedundantAccess": true
- //"requireNewlineAfterDescription": true
+ "checkRedundantAccess": true,
+ "requireNewlineAfterDescription": true
},
// ----
diff --git a/client/resources/wikibase.client.PageConnector.js
b/client/resources/wikibase.client.PageConnector.js
index 8799da0..b767448 100644
--- a/client/resources/wikibase.client.PageConnector.js
+++ b/client/resources/wikibase.client.PageConnector.js
@@ -7,6 +7,7 @@
/**
* PageConnector connects two articles easily.
+ *
* @constructor
* @since 0.5
*
@@ -60,6 +61,7 @@
/**
* Gets a list of pages that will also be linked with the first page.
This may visualize
* potential side effects of a merge to users.
+ *
* @since 0.5
*
* @return {jQuery.promise}
@@ -146,6 +148,7 @@
/**
* Links the two articles by either creating a new item, updating an
existing one or merging two
* existing ones.
+ *
* @since 0.5
*
* @return {jQuery.Promise}
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
index 2d53c2e..ccabb0f 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.siteselector.js
@@ -296,6 +296,7 @@
/**
* Default siteselector suggestion menu item.
+ *
* @constructor
* @extends jQuery.ui.ooMenu.Item
*
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.wbtooltip.js
b/lib/resources/jquery.wikibase/jquery.wikibase.wbtooltip.js
index ff70303..6622f46 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.wbtooltip.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.wbtooltip.js
@@ -143,6 +143,7 @@
/**
* Hides the tooltip balloon and destroys the tooltip object afterwards.
+ *
* @since 0.4
*
* @param {boolean} [remove] Whether to remove the tooltip's node from
the DOM.
@@ -163,6 +164,7 @@
/**
* Evaluates a given gravity string according to the language direction
flipping the horizontal
* gravity in RTL context.
+ *
* @since 0.4
*
* @param {string} gravity
@@ -180,6 +182,7 @@
/**
* Shows the tooltip balloon.
+ *
* @since 0.4
*/
show: function() {
@@ -258,6 +261,7 @@
/**
* Hides the tooltip balloon.
+ *
* @since 0.4
*
* @triggers afterhide
@@ -277,6 +281,7 @@
/**
* Constructs the DOM structure displayed within an error tooltip.
+ *
* @since 0.4
*
* @return {jQuery}
diff --git a/lib/resources/wikibase.Site.js b/lib/resources/wikibase.Site.js
index 31a0b10..6bf3c41 100644
--- a/lib/resources/wikibase.Site.js
+++ b/lib/resources/wikibase.Site.js
@@ -1,5 +1,6 @@
/**
* JavaScript giving information about a site of the 'Wikibase' extension.
+ *
* @see https://www.mediawiki.org/wiki/Extension:Wikibase
*
* @licence GNU GPL v2+
@@ -10,6 +11,7 @@
/**
* Offers information about a site known to the local Wikibase installation.
+ *
* @constructor
* @since 0.1
*/
diff --git a/lib/tests/qunit/wikibase.tests.js
b/lib/tests/qunit/wikibase.tests.js
index eed754e..19af2c4 100644
--- a/lib/tests/qunit/wikibase.tests.js
+++ b/lib/tests/qunit/wikibase.tests.js
@@ -1,5 +1,6 @@
/**
* QUnit tests for general wikibase JavaScript code
+ *
* @see https://www.mediawiki.org/wiki/Extension:Wikibase
*
* @since 0.1
diff --git a/repo/resources/experts/Entity.js b/repo/resources/experts/Entity.js
index 13d9fc7..1e0677b 100644
--- a/repo/resources/experts/Entity.js
+++ b/repo/resources/experts/Entity.js
@@ -62,6 +62,7 @@
/**
* Initializes a `jQuery.wikibase.entityselector` instance on
the `Expert`'s input element.
+ *
* @abstract
* @protected
*
diff --git a/repo/resources/parsers/getApiBasedValueParserConstructor.js
b/repo/resources/parsers/getApiBasedValueParserConstructor.js
index 25588c8..3704872 100644
--- a/repo/resources/parsers/getApiBasedValueParserConstructor.js
+++ b/repo/resources/parsers/getApiBasedValueParserConstructor.js
@@ -11,6 +11,7 @@
/**
* Returns a constructor for a ValueParser which parses using the given
wb.api.ParseValueCaller.
+ *
* @since 0.5
*
* This is necessary since valueParser.ValueParserStore returns a constructor,
not an instance, and
diff --git a/repo/resources/wikibase.EntityInitializer.js
b/repo/resources/wikibase.EntityInitializer.js
index def4c34..3fd3de9 100644
--- a/repo/resources/wikibase.EntityInitializer.js
+++ b/repo/resources/wikibase.EntityInitializer.js
@@ -10,6 +10,7 @@
/**
* Entity initializer.
* Deserializes the entity passed to JavaScript via mw.config variable.
+ *
* @constructor
* @since 0.5
*
diff --git a/view/resources/jquery/jquery.util.EventSingletonManager.js
b/view/resources/jquery/jquery.util.EventSingletonManager.js
index 30a3203..331b6d8 100644
--- a/view/resources/jquery/jquery.util.EventSingletonManager.js
+++ b/view/resources/jquery/jquery.util.EventSingletonManager.js
@@ -11,6 +11,7 @@
* Manages attaching an event handler to a target only once for a set of
source objects.
* Since an event is attached only once, the initial event handler (for the
combination of target/
* event name/event namespace) may not be overwritten later on.
+ *
* @constructor
*/
var SELF = $.util.EventSingletonManager = function UtilEventSingletonManager()
{
diff --git a/view/resources/jquery/jquery.util.getDirectionality.js
b/view/resources/jquery/jquery.util.getDirectionality.js
index b5ecbb9..1a80f6d 100644
--- a/view/resources/jquery/jquery.util.getDirectionality.js
+++ b/view/resources/jquery/jquery.util.getDirectionality.js
@@ -7,6 +7,7 @@
* Returns the directionality of a language by querying the Universal Language
Selector. If ULS is
* not available the HTML element's `dir` attribute is evaluated. If that is
unset, `auto` is
* returned.
+ *
* @method jQuery.util.getDirectionality
* @member jQuery.util
* @licence GNU GPL v2+
diff --git a/view/resources/jquery/ui/jquery.ui.TemplatedWidget.js
b/view/resources/jquery/ui/jquery.ui.TemplatedWidget.js
index 912118c..77f7201 100644
--- a/view/resources/jquery/ui/jquery.ui.TemplatedWidget.js
+++ b/view/resources/jquery/ui/jquery.ui.TemplatedWidget.js
@@ -68,6 +68,7 @@
* basic template DOM is created and template short-cuts can be
used. The function should
* be overridden only to perform DOM manipulation/creation
while initializing should be
* performed in `_init`.
+ *
* @see jQuery.Widget._create
* @protected
*
@@ -94,6 +95,7 @@
* `_init`. With the `TemplatedWidget`'s base `_init`
implementation triggering the "init"
* event, inheriting widgets should call parent's `_init` as
last action for other
* components listening to the "init" event can be sure the
widget in fully initialized.
+ *
* @see jQuery.Widget._init
* @protected
*/
@@ -127,6 +129,7 @@
/**
* Creates the short-cuts to DOM nodes within the template's
DOM structure as specified in
* the `templateShortCuts` option.
+ *
* @private
*
* @throws {Error} if no DOM node is found using a specified
selector.
@@ -200,6 +203,7 @@
* Clone of jQuery.Widget._trigger with the difference that
`$.triggerHandler()` instead of
* `$.trigger()` is used to trigger the event on `this.element`
if `encapsulate` option is
* `true`.
+ *
* @see jQuery.Widget._trigger
* @protected
*
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.aliasesview.js
b/view/resources/jquery/wikibase/jquery.wikibase.aliasesview.js
index e16a69e..bf97850 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.aliasesview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.aliasesview.js
@@ -109,6 +109,7 @@
/**
* Creates and initializes the `jQuery.ui.tagadata` widget.
+ *
* @private
*/
_initTagadata: function() {
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
b/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
index a1003ac..20a58ef 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.entityselector.js
@@ -23,6 +23,7 @@
/**
* Returns a message from the MediaWiki context if the `entityselector` module
has been loaded.
* If it has not been loaded, the corresponding string defined in the options
will be returned.
+ *
* @ignore
*
* @param {string} msgKey
@@ -191,6 +192,7 @@
/**
* Determines whether a term matches a label considering the
`caseSensitive` option.
+ *
* @protected
*
* @param {string} term
@@ -206,6 +208,7 @@
/**
* Create and return the data object for the api call.
+ *
* @protected
*
* @param {string} term
@@ -227,6 +230,7 @@
/**
* Initializes the default source pointing the the `wbsearchentities`
API module via the URL
* provided in the options.
+ *
* @protected
*
* @return {Function}
@@ -279,6 +283,7 @@
/**
* Generates the label for a suggester entity.
+ *
* @protected
*
* @param {Object} entityStub
@@ -429,6 +434,7 @@
/**
* Selects an entity.
+ *
* @protected
*
* @param {Object} entityStub
@@ -453,6 +459,7 @@
/**
* Default `entityselector` suggestion menu item.
+ *
* @class jQuery.wikibase.entityselector.Item
* @extends jQuery.ui.ooMenu.Item
*
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.entitytermsview.js
b/view/resources/jquery/wikibase/jquery.wikibase.entitytermsview.js
index fa0fb92..22ff016 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.entitytermsview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.entitytermsview.js
@@ -219,6 +219,7 @@
* supposed to be removed as soon as drop-down edit buttons are
implemented with the mechanism
* toggling the list's visibility while not starting edit mode will be
part of the drop-down
* menu.
+ *
* @private
*/
_createEntitytermsforlanguagelistviewToggler: function() {
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.entityview.js
b/view/resources/jquery/wikibase/jquery.wikibase.entityview.js
index 9126b4e..7f527d8 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.entityview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.entityview.js
@@ -70,6 +70,7 @@
/**
* Main initialization actually calling parent's _create().
+ *
* @see jQuery.ui.TemplatedWidget._create
* @protected
*/
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.listview.ListItemAdapter.js
b/view/resources/jquery/wikibase/jquery.wikibase.listview.ListItemAdapter.js
index f4c7bb7..4d2521a 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.listview.ListItemAdapter.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.listview.ListItemAdapter.js
@@ -13,6 +13,7 @@
* of values but sticking with this pattern might be possible by
providing a function the
* `listview` determining the kind of a value and choosing the right
strategy to deal with the
* value accordingly.
+ *
* @see jQuery.wikibase.listview
* @class jQuery.wikibase.listview.ListItemAdapter
* @since 0.4
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.listview.js
b/view/resources/jquery/wikibase/jquery.wikibase.listview.js
index f1dd8c3..fe1e4c6 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.listview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.listview.js
@@ -159,6 +159,7 @@
/**
* Fills the list element with DOM structure for each list item.
+ *
* @private
*/
_createList: function() {
@@ -314,6 +315,7 @@
/**
* Adds one list item into the list and renders it in the view.
+ *
* @private
*
* @param {*} liValue One list item widget's value.
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.referenceview.js
b/view/resources/jquery/wikibase/jquery.wikibase.referenceview.js
index 3c1d560..b05f433 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.referenceview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.referenceview.js
@@ -104,6 +104,7 @@
/**
* Attaches event listeners needed during edit mode.
+ *
* @private
*/
_attachEditModeEventHandlers: function() {
@@ -145,6 +146,7 @@
/**
* Detaches the event handlers needed during edit mode.
+ *
* @private
*/
_detachEditModeEventHandlers: function() {
@@ -164,6 +166,7 @@
* Will update the `wb-reference-<hash>` CSS class on the widget's root
element to a given
* `Reference`'s hash. If `null` is given or if the `Reference` has no
hash, `wb-reference-new`
* will be added as class.
+ *
* @private
*
* @param {wikibase.datamodel.Reference|null} reference
@@ -212,6 +215,7 @@
/**
* Starts the widget's edit mode.
+ *
* @since 0.5
*/
startEditing: function() {
@@ -234,6 +238,7 @@
/**
* Stops the widget's edit mode.
+ *
* @since 0.5
*/
stopEditing: function() {
@@ -271,6 +276,7 @@
/**
* Returns whether the widget is currently in edit mode.
+ *
* @since 0.5
*
* @return {boolean}
@@ -281,6 +287,7 @@
/**
* Returns whether the widget (all its `snaklistview`s) is currently
valid.
+ *
* @since 0.5
*
* @return {boolean}
@@ -299,6 +306,7 @@
/**
* Returns whether the widget's current value matches the value it has
been initialized with by
* checking the `Reference`'s `Snak`s.
+ *
* @since 0.5
*
* @return {boolean}
@@ -315,6 +323,7 @@
/**
* Adds a pending `snaklistview` to the widget.
+ *
* @see jQuery.wikibase.listview.enterNewItem
* @since 0.5
*
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.sitelinkgrouplistview.js
b/view/resources/jquery/wikibase/jquery.wikibase.sitelinkgrouplistview.js
index 6d59687..beff9ad 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.sitelinkgrouplistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.sitelinkgrouplistview.js
@@ -9,6 +9,7 @@
* Scrapes site links from static HTML in order to be sure the order in the
static HTML matches the
* order set on the widget initialized on the HTML structure since that widget
is not supposed to
* re-render the HTML for performance reasons.
+ *
* @ignore
*
* @param {jQuery} $siteLinks
@@ -50,6 +51,7 @@
/**
* Maps site links of a `wikibase.datamodel.SiteLinkSet` to their Wikibase
site groups.
+ *
* @ignore
*
* @param {wikibase.datamodel.SiteLinkSet} siteLinkSet
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.sitelinklistview.js
b/view/resources/jquery/wikibase/jquery.wikibase.sitelinklistview.js
index d0772b9..024a2e9 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.sitelinklistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.sitelinklistview.js
@@ -772,6 +772,7 @@
/**
* Adds a pending `sitelinkview` to the `sitelinklistview`.
+ *
* @see jQuery.wikibase.listview.enterNewItem
*
* @return {Object} jQuery.Promise
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.sitelinkview.js
b/view/resources/jquery/wikibase/jquery.wikibase.sitelinkview.js
index 3e478c3..2531150 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.sitelinkview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.sitelinkview.js
@@ -200,6 +200,7 @@
/**
* Shortens the page name using the ellipsis character in order to
prevent the page name from
* wrapping.
+ *
* @private
*/
_shortenPageName: function() {
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
b/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
index 762487b..791302d 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.snaklistview.js
@@ -116,6 +116,7 @@
/**
* (Re-)creates the `listview` widget managing the `snakview` widgets.
+ *
* @private
*/
_createListView: function() {
@@ -161,6 +162,7 @@
/**
* Updates the visibility of the `snakview`s' `Property` labels.
(Effective only if the
* `singleProperty` option is set.)
+ *
* @private
* @since 0.5
*/
@@ -251,6 +253,7 @@
/**
* Attaches event listeners that shall trigger stopping the
`snaklistview`'s edit mode.
+ *
* @private
*/
_attachEditModeEventHandlers: function() {
@@ -269,6 +272,7 @@
/**
* Detaches event listeners that shall trigger stopping the
`snaklistview`'s edit mode.
+ *
* @private
*/
_detachEditModeEventHandlers: function() {
@@ -332,6 +336,7 @@
/**
* Adds a new empty `snakview` to the `listview` with edit mode started
instantly.
+ *
* @see jQuery.wikibase.listview.enterNewItem
*
* @return {Object} jQuery.Promise
@@ -457,6 +462,7 @@
/**
* Finds a `Snak`'s `snakview` node within the `snaklistview`'s
`listview` widget.
+ *
* @private
*
* @param {wikibase.datamodel.Snak} snak
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.statementgrouplistview.js
b/view/resources/jquery/wikibase/jquery.wikibase.statementgrouplistview.js
index fa0b26d..1c8aa2b 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.statementgrouplistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.statementgrouplistview.js
@@ -119,6 +119,7 @@
* Triggers adding a new `statementgroupview` to the
`statementgrouplistview`. This involves
* triggering the corresponding process for the new pending
`statementgroupview` by instantly
* triggering the `enterNewItem()` function of the `statementgroupview`.
+ *
* @see jQuery.wikibase.statementgroupview.enterNewItem
* @see jQuery.wikibase.listview.enterNewItem
*
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.statementgroupview.js
b/view/resources/jquery/wikibase/jquery.wikibase.statementgroupview.js
index b2493ef..e83c9b2 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.statementgroupview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.statementgroupview.js
@@ -195,6 +195,7 @@
/**
* Adds a new, pending `statementview` to the encapsulated
`statementlistview`.
+ *
* @see jQuery.wikibase.statementlistview.enterNewItem
*
* @return {Object} jQuery.Promise
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.statementlistview.js
b/view/resources/jquery/wikibase/jquery.wikibase.statementlistview.js
index c5fd100..d124f51 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.statementlistview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.statementlistview.js
@@ -132,6 +132,7 @@
/**
* Creates the `listview` widget managing the `statementview` widgets.
+ *
* @since 0.5
* @private
*/
@@ -181,6 +182,7 @@
/**
* Adds a new, pending `statementview` to the `statementlistview`.
+ *
* @see jQuery.wikibase.listview.enterNewItem
*
* @return {Object} jQuery.Promise
diff --git
a/view/resources/jquery/wikibase/jquery.wikibase.statementview.RankSelector.js
b/view/resources/jquery/wikibase/jquery.wikibase.statementview.RankSelector.js
index 294406f..a258ea8 100644
---
a/view/resources/jquery/wikibase/jquery.wikibase.statementview.RankSelector.js
+++
b/view/resources/jquery/wikibase/jquery.wikibase.statementview.RankSelector.js
@@ -12,6 +12,7 @@
/**
* Returns a `RANK`'s serialized string.
+ *
* @see wikibase.datamodel.Statement.RANK
* @ignore
*
@@ -182,6 +183,7 @@
/**
* Removes all global event listeners generated by the
`RankSelector`.
+ *
* @private
*/
_unbindGlobalEventListeners: function() {
@@ -190,6 +192,7 @@
/**
* Generates the menu the `RANK` may be chosen from.
+ *
* @private
*
* @return {jQuery}
@@ -237,6 +240,7 @@
/**
* Sets the `RANK` activating the menu item representing the
specified `RANK`.
+ *
* @private
*
* @param {number} rank
@@ -253,6 +257,7 @@
/**
* Updates the menu's CSS classes.
+ *
* @private
*/
_updateMenuCss: function() {
@@ -264,6 +269,7 @@
/**
* Updates the rank icon to reflect the rank currently set.
+ *
* @private
*/
_updateIcon: function() {
diff --git a/view/resources/jquery/wikibase/jquery.wikibase.statementview.js
b/view/resources/jquery/wikibase/jquery.wikibase.statementview.js
index 1136f87..a3e1b16 100644
--- a/view/resources/jquery/wikibase/jquery.wikibase.statementview.js
+++ b/view/resources/jquery/wikibase/jquery.wikibase.statementview.js
@@ -506,6 +506,7 @@
/**
* Instantiates a `Statement` with the `statementview`'s current value.
+ *
* @private
*
* @param {string} guid
@@ -535,6 +536,7 @@
/**
* Adds a `Reference` and renders it in the view.
+ *
* @private
*
* @param {wikibase.datamodel.Reference} reference
@@ -545,6 +547,7 @@
/**
* Returns all `Reference`s currently specified in the view (including
all pending changes).
+ *
* @private
*
* @return {wikibase.datamodel.Reference[]}
@@ -584,6 +587,7 @@
/**
* Updates the visual `Reference`s counter.
+ *
* @private
*/
_drawReferencesCounter: function() {
diff --git
a/view/resources/jquery/wikibase/snakview/snakview.SnakTypeSelector.js
b/view/resources/jquery/wikibase/snakview/snakview.SnakTypeSelector.js
index aebb9dc..caa2caf 100644
--- a/view/resources/jquery/wikibase/snakview/snakview.SnakTypeSelector.js
+++ b/view/resources/jquery/wikibase/snakview/snakview.SnakTypeSelector.js
@@ -150,6 +150,7 @@
/**
* Returns a DOM structure for the selector's menu the `Snak`
type can be chosen from.
+ *
* @private
*
* @return {jQuery}
@@ -195,6 +196,7 @@
/**
* Activates a `Snak` type in the menu.
+ *
* @private
*
* @param {string|null} snakType
diff --git a/view/resources/jquery/wikibase/snakview/snakview.ViewState.js
b/view/resources/jquery/wikibase/snakview/snakview.ViewState.js
index ffeb319..38f3386 100644
--- a/view/resources/jquery/wikibase/snakview/snakview.ViewState.js
+++ b/view/resources/jquery/wikibase/snakview/snakview.ViewState.js
@@ -8,6 +8,7 @@
* Interface to a `jQuery.wikibase.snakview` instance that allows
querying the `snakview` for
* information as well as updating the `snakview`. Does not provide
functions to actively change
* the view but acts as a state object.
+ *
* @see jQuery.wikibase.snakview
* @class jQuery.wikibase.snakview.ViewState
* @since 0.4
@@ -35,6 +36,7 @@
/**
* Notifies the `snakview` of a status update.
+ *
* @see jQuery.wikibase.snakview.updateStatus
*
* @param {string} status
diff --git a/view/resources/jquery/wikibase/snakview/snakview.js
b/view/resources/jquery/wikibase/snakview/snakview.js
index 4dc08b0..26602b7 100644
--- a/view/resources/jquery/wikibase/snakview/snakview.js
+++ b/view/resources/jquery/wikibase/snakview/snakview.js
@@ -239,6 +239,7 @@
/**
* Returns an input element with initialized `entityselector` for
selecting entities.
+ *
* @private
*
* @return {jQuery}
@@ -394,6 +395,7 @@
/**
* Updates this `snakview`'s status.
+ *
* @since 0.4
*
* @param {string} status May either be 'valid' or 'invalid'
@@ -411,6 +413,7 @@
/**
* Returns whether the `snakview`'s `Snak` is valid in its current
state.
+ *
* @since 0.4
*
* @return {boolean}
@@ -422,6 +425,7 @@
/**
* Returns whether the current value matches the one the `snakview` was
initialized with by
* comparing the (deserialized) `Snak` objects of that stages.
+ *
* @since 0.5
*
* @return {boolean}
@@ -457,6 +461,7 @@
/**
* Returns the `entityselector` for choosing the `Snak`'s `Property`.
Returns `null` if the
* `Snak` is created and has a `Property` already. (Once created, the
`Property` is immutable.)
+ *
* @private
*
* @return {jQuery.wikibase.entityselector|null}
@@ -471,6 +476,7 @@
/**
* Returns the `snaktypeselector` for choosing the `Snak`'s type.
Returns `null` if the `Snak`
* is created and has a `Property` already. (Once created, the
`Property` is immutable.)
+ *
* @private
*
* @return {jQuery.wikibase.snakview.SnakTypeSelector|null}
@@ -536,6 +542,7 @@
* If a `wikibase.datamodel.Snak` instance is passed, the `snakview` is
updated to represent the
* `Snak`. If no parameter is supplied, the current `Snak` represented
by the `snakview` is
* returned.
+ *
* @since 0.4
*
* @param {wikibase.datamodel.Snak|null} [snak]
@@ -566,6 +573,7 @@
/**
* Sets/Gets the ID of the `Property` for the `Snak` represented by the
`snakview`. If no
* `Property` is set, `null` is returned.
+ *
* @since 0.3 (setter since 0.4)
*
* @param {string|null} [propertyId]
@@ -591,6 +599,7 @@
/**
* Sets/Gets the ID of the `Snak` type for the `Snak` represented by
the `snakview`. If no
* `Snak` type is set, `null` is returned.
+ *
* @see wikibase.datamodel.Snak.TYPE
* @since 0.4
*
@@ -619,6 +628,7 @@
/**
* Returns the `snakview`'s `Variation` object required for presenting
the current `Snak` type.
* If a `Snak` type has not been defined yet, `null` is returned.
+ *
* @since 0.4
*
* @return {jQuery.wikibase.snakview.variations.Variation|null}
@@ -629,6 +639,7 @@
/**
* Updates the `Variation` according to the widget's current value.
+ *
* @since 0.5
*/
updateVariation: function() {
@@ -687,6 +698,7 @@
/**
* (Re-)renders the widget.
+ *
* @since 0.4
*/
draw: function() {
@@ -699,6 +711,7 @@
* (Re-)renders the Property DOM structure according to the current
value. The `Property` DOM
* is not (re-)rendered if changing the `Property` is locked via the
`locked` option and
* previously generated HTML is detected.
+ *
* @since 0.5
*
* @return {Object} jQuery.Promise
@@ -732,6 +745,7 @@
/**
* Retrieves the DOM structure representing the `Property` of the
`Snak` represented by the
* `snakview`.
+ *
* @private
*
* @param {string} [propertyId]
@@ -767,6 +781,7 @@
/**
* Creates the DOM structure specific for a `Property`, a generic DOM
* structure or an input element.
+ *
* @private
*
* @param {string} propertyLabel Rendered label for the `Property`
@@ -799,6 +814,7 @@
* Updates the `SnakTypeSelector` for choosing the `Snak` type. The
`SnakTypeSelector` DOM
* is not (re-)rendered if changing the `Snak` type is locked via the
`locked` option and
* previously generated HTML is detected.
+ *
* @since 0.4
*/
drawSnakTypeSelector: function() {
@@ -842,6 +858,7 @@
/**
* Renders the `Variation` or placeholder text if no proper `Variation`
is available.
+ *
* @since 0.4
*/
drawVariation: function() {
diff --git
a/view/resources/jquery/wikibase/snakview/snakview.variations.Value.js
b/view/resources/jquery/wikibase/snakview/snakview.variations.Value.js
index a055296..9980291 100644
--- a/view/resources/jquery/wikibase/snakview/snakview.variations.Value.js
+++ b/view/resources/jquery/wikibase/snakview/snakview.variations.Value.js
@@ -257,6 +257,7 @@
/**
* Attaches event handlers to the `valueview` widget's element.
+ *
* @private
*/
_attachEventHandlers: function() {
@@ -317,6 +318,7 @@
/**
* Removes event handlers from the `valueview` widget's element.
+ *
* @private
*/
_removeEventHandlers: function() {
diff --git
a/view/resources/jquery/wikibase/snakview/snakview.variations.Variation.js
b/view/resources/jquery/wikibase/snakview/snakview.variations.Variation.js
index 5433f19..0f521af 100644
--- a/view/resources/jquery/wikibase/snakview/snakview.variations.Variation.js
+++ b/view/resources/jquery/wikibase/snakview/snakview.variations.Variation.js
@@ -12,6 +12,7 @@
/**
* Abstract base for all kinds of `Variation`s to be used by
`jQuery.wikibase.snakview` to
* represent the different types of `wikibase.datamodel.Snak` objects.
+ *
* @see wikibase.datamodel.Snak
* @class jQuery.wikibase.snakview.variations.Variation
* @abstract
@@ -129,6 +130,7 @@
/**
* Returns an object that offers information about the related
`snakview`'s current state as
* well as allows updating the `snakview` instance.
+ *
* @see jQuery.wikibase.snakview
*
* @return {jQuery.wikibase.snakview.ViewState}
@@ -143,6 +145,7 @@
* bound to the `Variation`. Equivalent to what
* `wikibase.serialization.SnakSerializer.serialize()` returns,
just without the fields
* `snaktype` and `property`.
+ *
* @see wikibase.serialization.SnakSerializer
*
* @param {Object} [value]
@@ -166,6 +169,7 @@
* `viewState().property()` and `viewState().snakType()`, if
necessary. A missing field
* implies that the aspect of the `Snak` was not defined yet.
Then, the view should display
* a useful message or, in edit-mode, show empty input forms
for user interaction.
+ *
* @protected
*
* @param {Object} value Incomplete `Snak` serialization.
diff --git
a/view/resources/jquery/wikibase/toolbar/controller/jquery.wikibase.toolbarcontroller.js
b/view/resources/jquery/wikibase/toolbar/controller/jquery.wikibase.toolbarcontroller.js
index 7a61ffe..8d4bb1a 100644
---
a/view/resources/jquery/wikibase/toolbar/controller/jquery.wikibase.toolbarcontroller.js
+++
b/view/resources/jquery/wikibase/toolbar/controller/jquery.wikibase.toolbarcontroller.js
@@ -63,6 +63,7 @@
/**
* Registers an event handler.
+ *
* @since 0.5
*
* @param {string} toolbarType
@@ -97,6 +98,7 @@
/**
* Destroys a toolbar.
+ *
* @since 0.5
*
* @param {jQuery.wikibase.toolbar} toolbar
diff --git a/view/resources/wikibase/templates.js
b/view/resources/wikibase/templates.js
index 7cc1541..91b138b 100644
--- a/view/resources/wikibase/templates.js
+++ b/view/resources/wikibase/templates.js
@@ -194,6 +194,7 @@
/**
* Returns the parsed plain template. (Overridden due to IE8 returning
objects instead of
* strings from mw.Message's native plain() method.)
+ *
* @see mw.Message.plain
*
* @return {string}
@@ -217,6 +218,7 @@
/**
* Returns a template filled with the specified parameters, similar to
wfTemplate().
+ *
* @see mw.message
*
* @since 0.2
@@ -293,6 +295,7 @@
* Fetches a template and fills it with specified parameters. The
template has to have a single
* root DOM element. All of its child nodes will then be appended to
the jQuery object's DOM
* nodes.
+ *
* @see mw.template
*
* @since 0.3
diff --git
a/view/resources/wikibase/utilities/wikibase.utilities.ClaimGuidGenerator.js
b/view/resources/wikibase/utilities/wikibase.utilities.ClaimGuidGenerator.js
index a1bf822..d42b1ad 100644
--- a/view/resources/wikibase/utilities/wikibase.utilities.ClaimGuidGenerator.js
+++ b/view/resources/wikibase/utilities/wikibase.utilities.ClaimGuidGenerator.js
@@ -9,6 +9,7 @@
/**
* Claim GUID generator.
+ *
* @since 0.4
* @param {string} entityId Prefixed entity id
*/
diff --git
a/view/resources/wikibase/utilities/wikibase.utilities.GuidGenerator.js
b/view/resources/wikibase/utilities/wikibase.utilities.GuidGenerator.js
index ad02b2b..1a57f5e 100644
--- a/view/resources/wikibase/utilities/wikibase.utilities.GuidGenerator.js
+++ b/view/resources/wikibase/utilities/wikibase.utilities.GuidGenerator.js
@@ -7,6 +7,7 @@
/**
* Generator for a Globally Unique IDentifier.
+ *
* @abstract
* @constructor
* @since 0.4
diff --git a/view/resources/wikibase/wikibase.RevisionStore.js
b/view/resources/wikibase/wikibase.RevisionStore.js
index 5f2bc7e..faf01c4 100644
--- a/view/resources/wikibase/wikibase.RevisionStore.js
+++ b/view/resources/wikibase/wikibase.RevisionStore.js
@@ -1,5 +1,6 @@
/**
* JavaScript storing revision ids about different sections.
+ *
* @see https://www.mediawiki.org/wiki/Extension:Wikibase
*
* @licence GNU GPL v2+
@@ -10,6 +11,7 @@
/**
* Offers access to stored revision ids
+ *
* @constructor
* @since 0.1
*/
diff --git a/view/resources/wikibase/wikibase.getLanguageNameByCode.js
b/view/resources/wikibase/wikibase.getLanguageNameByCode.js
index cb7991b..3d23bd6 100644
--- a/view/resources/wikibase/wikibase.getLanguageNameByCode.js
+++ b/view/resources/wikibase/wikibase.getLanguageNameByCode.js
@@ -1,5 +1,6 @@
/**
* JavaScript for 'wikibase' extension
+ *
* @see https://www.mediawiki.org/wiki/Extension:Wikibase
*
* @licence GNU GPL v2+
diff --git
a/view/tests/qunit/jquery/wikibase/jquery.wikibase.statementgrouplabelscroll.tests.js
b/view/tests/qunit/jquery/wikibase/jquery.wikibase.statementgrouplabelscroll.tests.js
index 14a3296..5ff9fd1 100644
---
a/view/tests/qunit/jquery/wikibase/jquery.wikibase.statementgrouplabelscroll.tests.js
+++
b/view/tests/qunit/jquery/wikibase/jquery.wikibase.statementgrouplabelscroll.tests.js
@@ -9,6 +9,7 @@
/**
* Returns a DOM object within a HTML page suitable for testing the
widget on.
+ *
* @return {jQuery}
* @throws {Error} If the test runs in a non-browser environment or on
a unsuitable HTML page.
*/
diff --git a/view/tests/qunit/wikibase/templates.tests.js
b/view/tests/qunit/wikibase/templates.tests.js
index 23c9d76..ce664b2 100644
--- a/view/tests/qunit/wikibase/templates.tests.js
+++ b/view/tests/qunit/wikibase/templates.tests.js
@@ -1,5 +1,6 @@
/**
* QUnit tests for the template engine.
+ *
* @see https://www.mediawiki.org/wiki/Extension:Wikibase
*
* @since 0.1
--
To view, visit https://gerrit.wikimedia.org/r/264101
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: If32daa98c390e8180923c0c01726b4b93fe4be83
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Ricordisamoa <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
