jenkins-bot has submitted this change and it was merged.
Change subject: Fix up jsduck docs
......................................................................
Fix up jsduck docs
Documentation shouldn't be this hard :P
Change-Id: I758ec6c5b3e0ba389dbb837470fa6ceea07fa67d
---
M resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js
M resources/ext.multimediaViewer/ext.multimediaViewer.ui.description.js
2 files changed, 28 insertions(+), 20 deletions(-)
Approvals:
Gergő Tisza: Looks good to me, approved
jenkins-bot: Verified
diff --git a/resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js
b/resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js
index e2c5e1d..0e32be7 100644
--- a/resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js
+++ b/resources/ext.multimediaViewer/ext.multimediaViewer.dataModel.js
@@ -335,17 +335,11 @@
* @class mw.mmv.model.FileUsage
* Represents information about the wiki pages using a given file
* @constructor
- * @param {mw.Title} file
- * @param {mw.mmv.model.FileUsage.Scope} scope
- * @param {{wiki: String|null, page: mw.Title}[]} pages
- * A list of pages which use this file. Each page is an object with
a 'page' field
- * containing the wiki page (a Title object) and a 'wiki' field
which is a domain name,
- * or null for local files.
- * @param {Number} [totalCount] total number of pages where the file is
used (the list passed
- * in pages parameter might be cut off at some limit)
- * @param {boolean} [totalCountIsLowerBound = false] False means
totalCount is accurate,
- * true means it is a lower bound (the real count can be way
greater).
- *
+ * @param {mw.Title} file see {@link mw.mmv.model.FileUsage#file}
+ * @param {mw.mmv.model.FileUsage.Scope} scope see {@link
mw.mmv.model.FileUsage#scope}
+ * @param {{wiki: (string|null), page: mw.Title}[]} pages see {@link
mw.mmv.model.FileUsage#pages}
+ * @param {number} [totalCount] see {@link
mw.mmv.model.FileUsage#totalCount}
+ * @param {boolean} [totalCountIsLowerBound = false] see {@link
mw.mmv.model.FileUsage#totalCountIsLowerBound} *
*/
function FileUsage(
file,
@@ -354,16 +348,30 @@
totalCount,
totalCountIsLowerBound
) {
- /** @property {mw.Title} mw.mmv.model.FileUsage.file */
+ /**
+ * The file in question.
+ * @property {mw.Title}
+ */
this.file = file;
- /** @property {mw.mmv.model.FileUsage.Scope}
mw.mmv.model.FileUsage.scope */
+ /**
+ * Shows what wikis we are interested in.
+ * @property {mw.mmv.model.FileUsage.Scope}
+ */
this.scope = scope;
- /** @property {{wiki: String|null, page: mw.Title}[]}
mw.mmv.model.FileUsage.pages */
+ /**
+ * A list of pages which use this file. Each page is an object
with a 'page' field
+ * containing the wiki page (a Title object) and a 'wiki' field
which is a domain name,
+ * or null for local files.
+ * @property {{wiki: (string|null), page: mw.Title}[]}
+ */
this.pages = pages;
- /** @property {Number} mw.mmv.model.FileUsage.totalCount
+ /**
+ * Total number of pages where the file is used (the list
passed in pages parameter might
+ * be cut off at some limit).
+ * @property {number} totalCount
*/
this.totalCount = totalCount || pages.length;
@@ -374,15 +382,14 @@
* should be something like "this file is used on more than 100
pages". (This would happen
* when we query the api with a limit of 100; the real usage
count could be in the millions
* for all we know.)
- * @property {boolean}
mw.mmv.model.FileUsage.totalCountIsLowerBound
+ * @property {boolean}
*/
this.totalCountIsLowerBound = !!totalCountIsLowerBound;
}
/**
- * @typedef {mw.mmv.model.FileUsage.Scope}
- * @enum
- * @type {String}
+ * Shows which wikis are included in the file usage list.
+ * @enum {string} mw.mmv.model.FileUsage.Scope
*/
FileUsage.Scope = {
/**
@@ -391,7 +398,7 @@
LOCAL: 'local',
/**
- * All pages, including other wikis
+ * Only pages from other wikis
*/
GLOBAL: 'global'
};
diff --git
a/resources/ext.multimediaViewer/ext.multimediaViewer.ui.description.js
b/resources/ext.multimediaViewer/ext.multimediaViewer.ui.description.js
index 15b5637..c36506b 100644
--- a/resources/ext.multimediaViewer/ext.multimediaViewer.ui.description.js
+++ b/resources/ext.multimediaViewer/ext.multimediaViewer.ui.description.js
@@ -19,6 +19,7 @@
/**
* @class mw.mmv.ui.Description
* @extends mw.mmv.ui.Element
+ * @inheritdoc
* @constructor
* @inheritdoc
*/
--
To view, visit https://gerrit.wikimedia.org/r/109102
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I758ec6c5b3e0ba389dbb837470fa6ceea07fa67d
Gerrit-PatchSet: 5
Gerrit-Project: mediawiki/extensions/MultimediaViewer
Gerrit-Branch: master
Gerrit-Owner: MarkTraceur <mtrac...@member.fsf.org>
Gerrit-Reviewer: Gergő Tisza <gti...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
