jenkins-bot has submitted this change and it was merged.
Change subject: labelview: Updated documentation
......................................................................
labelview: Updated documentation
Change-Id: Ia334e5fe3368fd1cb2f823d21148cd73fa72518a
---
M lib/resources/jquery.wikibase/jquery.wikibase.labelview.js
1 file changed, 25 insertions(+), 23 deletions(-)
Approvals:
Adrian Lang: Looks good to me, approved
Thiemo Mättig (WMDE): Looks good to me, approved
jenkins-bot: Verified
diff --git a/lib/resources/jquery.wikibase/jquery.wikibase.labelview.js
b/lib/resources/jquery.wikibase/jquery.wikibase.labelview.js
index bc8d473..6d8721f 100644
--- a/lib/resources/jquery.wikibase/jquery.wikibase.labelview.js
+++ b/lib/resources/jquery.wikibase/jquery.wikibase.labelview.js
@@ -1,32 +1,29 @@
-/**
- * @licence GNU GPL v2+
- * @author H. Snater < mediaw...@snater.com >
- */
( function( $, mw, wb ) {
'use strict';
var PARENT = $.ui.EditableTemplatedWidget;
/**
- * Manages a label.
+ * Displays and allows editing of a `wikibase.datamodel.Term` acting as an
`Entity`'s label.
* @since 0.5
+ * @class jQuery.wikibase.labelview
* @extends jQuery.ui.EditableTemplatedWidget
+ * @licence GNU GPL v2+
+ * @author H. Snater < mediaw...@snater.com >
*
- * @option {wikibase.datamodel.Term} value
+ * @constructor
*
- * @option {string} [helpMessage]
- * Default: mw.msg( 'wikibase-label-input-help-message' )
- *
- * @option {wikibase.entityChangers.LabelsChanger} labelsChanger
- *
- * @option {string} entityId
- *
- * @option {boolean} [showEntityId]
- * Default: false
+ * @param {Object} options
+ * @param {wikibase.datamodel.Term} options.value
+ * @param {string} [options.helpMessage=mw.msg(
'wikibase-label-input-help-message' )]
+ * @param {wikibase.entityChangers.LabelsChanger} options.labelsChanger
+ * @param {string} options.entityId
+ * @param {boolean} [options.showEntityId=false]
*/
$.widget( 'wikibase.labelview', PARENT, {
/**
- * @see jQuery.ui.TemplatedWidget.options
+ * @inheritdoc
+ * @protected
*/
options: {
template: 'wikibase-labelview',
@@ -47,7 +44,8 @@
},
/**
- * @see jQuery.ui.TemplatedWidget._create
+ * @inheritdoc
+ * @protected
*
* @throws {Error} if a required option is not specified properly.
*/
@@ -87,7 +85,7 @@
},
/**
- * @see jQuery.ui.TemplatedWidget.destroy
+ * @inheritdoc
*/
destroy: function() {
if( this.isInEditMode() ) {
@@ -185,21 +183,25 @@
},
/**
- * @return {boolean}
+ * @inheritdoc
*/
isValid: function() {
return true;
},
/**
- * @return {boolean}
+ * @inheritdoc
*/
isInitialValue: function() {
return this.value().equals( this.options.value );
},
/**
- * @see jQuery.ui.TemplatedWidget._setOption
+ * @inheritdoc
+ * @protected
+ *
+ * @throws {Error} when trying to set the widget's value to something
other than a
+ * `wikibase.datamodel.Term` instance.
*/
_setOption: function( key, value ) {
if( key === 'value' && !( value instanceof wb.datamodel.Term )
) {
@@ -216,7 +218,7 @@
},
/**
- * Gets/Sets the widget's value.
+ * @inheritdoc
*
* @param {wikibase.datamodel.Term} [value]
* @return {wikibase.datamodel.Term|undefined}
@@ -238,7 +240,7 @@
},
/**
- * @see jQuery.ui.TemplatedWidget.focus
+ * @inheritdoc
*/
focus: function() {
if( this.isInEditMode() ) {
--
To view, visit https://gerrit.wikimedia.org/r/189727
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ia334e5fe3368fd1cb2f823d21148cd73fa72518a
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Henning Snater <henning.sna...@wikimedia.de>
Gerrit-Reviewer: Adrian Lang <adrian.he...@wikimedia.de>
Gerrit-Reviewer: Henning Snater <henning.sna...@wikimedia.de>
Gerrit-Reviewer: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
