Gilles has submitted this change and it was merged. Change subject: Add main class to jsduck ......................................................................
Add main class to jsduck Change-Id: I774303ce4f756637bea3821ae2b2ff724351b3bb --- M docs/external.js M docs/jsduck-config.json M resources/ext.multimediaViewer/ext.multimediaViewer.js M resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js 4 files changed, 42 insertions(+), 8 deletions(-) Approvals: Gilles: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/external.js b/docs/external.js index e670c92..0cd19ce 100644 --- a/docs/external.js +++ b/docs/external.js @@ -5,6 +5,11 @@ */ /** + * @class mw.Api + * <https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Api> + */ + +/** * @class mw.Title * <https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Title> */ @@ -15,5 +20,34 @@ */ /** + * @class mlb.LightboxImage + */ + +/** * @class mlb.LightboxInterface */ + +/** + * @class mlb.MultiLightbox + */ + +/** + * @class HTMLElement + */ + +/** + * @class HTMLImageElement + * @extends HTMLElement + */ + +/** + * @class jQuery + */ + +/** + * @class jQuery.Promise + */ + +/** + * @class jQuery.Event + */ diff --git a/docs/jsduck-config.json b/docs/jsduck-config.json index d30c36f..e9f44ec 100644 --- a/docs/jsduck-config.json +++ b/docs/jsduck-config.json @@ -5,6 +5,7 @@ "--output": "./js", "--": [ "./external.js", + "../resources/ext.multimediaViewer/ext.multimediaViewer.js", "../resources/ext.multimediaViewer/ext.multimediaViewer.lightboxinterface.js", "../resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js", "../resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js" diff --git a/resources/ext.multimediaViewer/ext.multimediaViewer.js b/resources/ext.multimediaViewer/ext.multimediaViewer.js index 740153a..e7cf6ce 100755 --- a/resources/ext.multimediaViewer/ext.multimediaViewer.js +++ b/resources/ext.multimediaViewer/ext.multimediaViewer.js @@ -68,15 +68,15 @@ }; /** - * Class that analyses the page, looks for image content and sets up the hooks + * @class mw.MultimediaViewer + * Analyses the page, looks for image content and sets up the hooks * to manage the viewing experience of such content. - * * @constructor */ function MultimediaViewer() { /** * MultiLightbox object used to display the pictures in the page. - * @property {mw.MultiLightbox} + * @property {mlb.MultiLightbox} * @private */ this.lightbox = null; @@ -316,7 +316,6 @@ * Handles clicks on legit image links. * * @protected - * @VisibleForTesting * * @param {jQuery.Event} e click event * @param {HTMLElement|jQuery} clickedEle clicked element @@ -366,7 +365,7 @@ * * @protected * - * @param {LightboxInterface} ui lightbox that got resized + * @param {mw.LightboxInterface} ui lightbox that got resized * @param {mw.mmv.model.Image} imageData information regarding the new resized image * @param {number} targetWidth * @param {number} requestedWidth @@ -852,7 +851,7 @@ /** * Start profiling an event * @param {string} type Can be image-load, image-resize, metadata-fetch, gender-fetch - * @param {object} [imgSize] Size of image (for image related events) + * @param {Object} [imgSize] Size of image (for image related events) * @param {number} [imgSize.width] In pixels * @param {number} [imgSize.height] In pixels * @param {number} [imgSize.filesize] In bytes diff --git a/resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js b/resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js index 8cff010..428d86a 100644 --- a/resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js +++ b/resources/ext.multimediaViewer/ext.multimediaViewer.lightboximage.js @@ -17,8 +17,8 @@ ( function ( mw, $, oo, MLBImage ) { /** - * @class {mw.LightboxImage} - * @extends {mlb.LightboxImage} + * @class mw.LightboxImage + * @extends mlb.LightboxImage * Represents an image on the page. * @constructor * @param {string} fileLink Link to the file - generally a thumb URL -- To view, visit https://gerrit.wikimedia.org/r/106849 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I774303ce4f756637bea3821ae2b2ff724351b3bb Gerrit-PatchSet: 5 Gerrit-Project: mediawiki/extensions/MultimediaViewer Gerrit-Branch: master Gerrit-Owner: MarkTraceur <[email protected]> Gerrit-Reviewer: Gilles <[email protected]> Gerrit-Reviewer: MarkTraceur <[email protected]> Gerrit-Reviewer: jenkins-bot <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
