jenkins-bot has submitted this change and it was merged.
Change subject: Hygiene: Minor documentation changes - fix jsduck warnings
......................................................................
Hygiene: Minor documentation changes - fix jsduck warnings
* Code examples cannot have new lines
* Case is important in property names for inheritdoc
* Must register OO classes
* Document el parameter to avoid issues like
I3bd261764dc1de99c3e724d44ef55807097596b4
Change-Id: I619a57a0f20a5f1328b9e855b8784e883bcecc18
---
M Gruntfile.js
M javascripts/InfiniteScroll.js
M javascripts/View.js
M javascripts/api.js
4 files changed, 31 insertions(+), 31 deletions(-)
Approvals:
Phuedx: Looks good to me, approved
jenkins-bot: Verified
diff --git a/Gruntfile.js b/Gruntfile.js
index 8077b8e..3db0247 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -119,6 +119,7 @@
'jqXHR',
'File',
'mw.user',
+ 'OO.ui.LookupElement',
'OO.EventEmitter'
],
'ignore-global': true,
diff --git a/javascripts/InfiniteScroll.js b/javascripts/InfiniteScroll.js
index 965b597..08e930d 100644
--- a/javascripts/InfiniteScroll.js
+++ b/javascripts/InfiniteScroll.js
@@ -24,35 +24,33 @@
* Example:
* @example
* <code>
- * var InfiniteScroll = M.require( 'InfiniteScroll' ),
- * PhotoList;
- *
- * PhotoList = View.extend( {
- * //...
- * initialize: function ( options ) {
- * this.api = new PhotoListApi( {
- * username: options.username
- * } );
- * // 1. Set up infinite scroll helper and listen to events
- * this.infiniteScroll = new InfiniteScroll( 1000 );
- * this.infiniteScroll.on( 'load', $.proxy( this, '_loadPhotos'
) );
- *
- * View.prototype.initialize.apply( this, arguments );
- * },
- * preRender: function () {
- * // 2. Disable until we've got the list rendered and set DOM
el
- * this.infiniteScroll.setElement( this.$el );
- * this.infiniteScroll.disable();
- * },
- * _loadPhotos: function () {
- * var self = this;
- * this.api.getPhotos().done( function ( photos ) {
- * // load photos into the DOM ...
- * // 3. and (re-)enable infinite scrolling
- * self.infiniteScroll.enable();
- * } );
- * }
- * } );
+ * var InfiniteScroll = M.require( 'InfiniteScroll' ),
+ * PhotoList;
+ * PhotoList = View.extend( {
+ * //...
+ * initialize: function ( options ) {
+ * this.api = new PhotoListApi( {
+ * username: options.username
+ * } );
+ * // 1. Set up infinite scroll helper and listen to events
+ * this.infiniteScroll = new InfiniteScroll( 1000 );
+ * this.infiniteScroll.on( 'load', $.proxy( this,
'_loadPhotos' ) );
+ * View.prototype.initialize.apply( this, arguments );
+ * },
+ * preRender: function () {
+ * // 2. Disable until we've got the list rendered and set
DOM el
+ * this.infiniteScroll.setElement( this.$el );
+ * this.infiniteScroll.disable();
+ * },
+ * _loadPhotos: function () {
+ * var self = this;
+ * this.api.getPhotos().done( function ( photos ) {
+ * // load photos into the DOM ...
+ * // 3. and (re-)enable infinite scrolling
+ * self.infiniteScroll.enable();
+ * } );
+ * }
+ * } );
* </code>
*/
InfiniteScroll = EventEmitter.extend( {
diff --git a/javascripts/View.js b/javascripts/View.js
index 590b843..9023043 100644
--- a/javascripts/View.js
+++ b/javascripts/View.js
@@ -120,7 +120,8 @@
/**
* A set of default options that are merged with options passed
into the initialize function.
*
- * @cfg {Object}
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {jQuery.Object|String} [defaults.el] jQuery selector to
use for rendering.
*/
defaults: {},
diff --git a/javascripts/api.js b/javascripts/api.js
index 5a64019..2b96b0f 100644
--- a/javascripts/api.js
+++ b/javascripts/api.js
@@ -10,7 +10,7 @@
*/
Api = EventEmitter.extend( mw.Api.prototype ).extend( {
/**
- * @property {String} apiURL
+ * @property {String} apiUrl
* URL to the api endpoint (api.php)
*/
apiUrl: mw.util.wikiScript( 'api' ),
--
To view, visit https://gerrit.wikimedia.org/r/188559
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I619a57a0f20a5f1328b9e855b8784e883bcecc18
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Jdlrobson <[email protected]>
Gerrit-Reviewer: Florianschmidtwelzow <[email protected]>
Gerrit-Reviewer: Phuedx <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
