mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/MultimediaViewer
synced 2024-11-24 08:13:38 +00:00
Fix for jsduck 5.x, rearrange categories
Should make for a nicer documentation experience. Change-Id: I935cbab2b06c8cf482d3987905d2257d09bea3a3
This commit is contained in:
parent
a0d9e46ef6
commit
d137689b34
97
docs/categories.json
Normal file
97
docs/categories.json
Normal file
|
@ -0,0 +1,97 @@
|
|||
[
|
||||
{
|
||||
"name": "Media Viewer classes",
|
||||
"groups": [
|
||||
{
|
||||
"name": "Base",
|
||||
"classes": [
|
||||
"mw.mmv.Api",
|
||||
"mw.mmv.EmbedFileFormatter",
|
||||
"mw.mmv.HtmlUtils",
|
||||
"mw.mmv.LightboxImage",
|
||||
"mw.mmv.LightboxInterface",
|
||||
"mw.mmv.Logger",
|
||||
"mw.mmv.MultimediaViewer",
|
||||
"mw.mmv.MultimediaViewerBootstrap",
|
||||
"mw.mmv.Performance",
|
||||
"mw.mmv.ThumbnailWidthCalculator"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Models",
|
||||
"classes": [
|
||||
"mw.mmv.model.*"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Providers",
|
||||
"classes": [
|
||||
"mw.mmv.provider.*"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Routers",
|
||||
"classes": [
|
||||
"mw.mmv.routing.*"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Interface",
|
||||
"classes": [
|
||||
"mw.mmv.ui.*"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
{
|
||||
"name": "External",
|
||||
"groups": [
|
||||
{
|
||||
"name": "jQuery",
|
||||
"classes": [
|
||||
"jQuery",
|
||||
"jQuery.Promise",
|
||||
"jQuery.Deferred",
|
||||
"jQuery.Event",
|
||||
"jqXHR"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "JavaScript natives",
|
||||
"classes": [
|
||||
"Array",
|
||||
"Boolean",
|
||||
"Date",
|
||||
"Function",
|
||||
"Number",
|
||||
"Object",
|
||||
"RegExp",
|
||||
"String"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "OOUI",
|
||||
"classes": [
|
||||
"OO.ui.*"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "MediaWiki",
|
||||
"classes": [
|
||||
"mw",
|
||||
"mw.Api",
|
||||
"mw.Title"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Browser native classes",
|
||||
"classes": [
|
||||
"HTMLElement",
|
||||
"HTMLImageElement",
|
||||
"XMLHttpRequest"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"--title": "MultimediaViewer extension documentation",
|
||||
"--categories": "./categories.json",
|
||||
"--footer": "Documentation for MultimediaViewer, an extension to MediaWiki. Generated on {DATE} by {JSDUCK} {VERSION}.",
|
||||
"--builtin-classes": true,
|
||||
"--output": "./js",
|
||||
|
|
|
@ -22,10 +22,10 @@
|
|||
* Class for storing license information about an image. For available fields, see
|
||||
* TemplateParser::$licenseFieldClasses in the CommonsMetadata extension.
|
||||
* @class mw.mmv.model.License
|
||||
* @param {string} shortName see {@link License#shortName}
|
||||
* @param {string} [internalName] see {@link License#internalName}
|
||||
* @param {string} [longName] see {@link License#longName}
|
||||
* @param {string} [deedUrl] see {@link License#deedUrl}
|
||||
* @param {string} shortName see {@link #shortName}
|
||||
* @param {string} [internalName] see {@link #internalName}
|
||||
* @param {string} [longName] see {@link #longName}
|
||||
* @param {string} [deedUrl] see {@link #deedUrl}
|
||||
* @constructor
|
||||
*/
|
||||
function License(
|
||||
|
|
|
@ -17,7 +17,7 @@
|
|||
|
||||
( function( mw, $ ) {
|
||||
/**
|
||||
* @class mw.mmv.proivder.GuessedThumbnailInfo
|
||||
* @class mw.mmv.provider.GuessedThumbnailInfo
|
||||
* This provider is similar to mw.mmv.provider.ThumbnailInfo, but instead of making an API call
|
||||
* to get the thumbnail URL, it tries to guess it. There are two failure modes:
|
||||
* - known failure: in the given situation it does not seem possible or safe to guess the URL.
|
||||
|
|
|
@ -74,14 +74,14 @@
|
|||
|
||||
/**
|
||||
* Maximum blownup factor tolerated
|
||||
* @property mw.mmv.ui.Canvas.MAX_BLOWUP_FACTOR
|
||||
* @property MAX_BLOWUP_FACTOR
|
||||
* @static
|
||||
*/
|
||||
Canvas.MAX_BLOWUP_FACTOR = 11;
|
||||
|
||||
/**
|
||||
* Blowup factor threshold at which blurring kicks in
|
||||
* @property mw.mmv.ui.Canvas.BLUR_BLOWUP_FACTOR_THRESHOLD
|
||||
* @property BLUR_BLOWUP_FACTOR_THRESHOLD
|
||||
* @static
|
||||
*/
|
||||
Canvas.BLUR_BLOWUP_FACTOR_THRESHOLD = 2;
|
||||
|
|
Loading…
Reference in a new issue