mediawiki-extensions-Cite/jsdoc.json
Adam Wight 73c90a0e7d Clean up and fix some jsdoc annotations
Some of the annotations were used in a way that confused jsdoc.  This
cleans up redundant annotations and uses more canonical tags.

These changes cause all classes to now appear in the generated pages.

Includes linking to external docs.

Bug: T358641
Change-Id: Iaee1dadcc19a70c27839d0d27dfa6a07a70fb46b
2024-02-29 13:05:42 +01:00

57 lines
3.4 KiB
JSON

{
"opts": {
"destination": "docs/js",
"package": "package.json",
"pedantic": true,
"recurse": true,
"template": "node_modules/jsdoc-wmf-theme"
},
"plugins": [
"plugins/markdown"
],
"source": {
"include": [ "modules", "src" ]
},
"templates": {
"cleverLinks": true,
"default": {
"useLongnameInNav": true
},
"wmf": {
"linkMap": {
"jQuery": "https://api.jquery.com/jQuery",
"jQuery.Event": "https://api.jquery.com/category/events/event-object/",
"OO.EventEmitter": "https://doc.wikimedia.org/oojs/master/OO.EventEmitter.html",
"OO.ui.ComboBoxInputWidget": "https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ComboBoxInputWidget.html",
"OO.ui.OptionWidget": "https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OptionWidget.html",
"OO.ui.SearchWidget": "https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchWidget.html",
"OO.ui.Toolbar": "https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.Toolbar.html",
"OO.ui.ToolGroup": "https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToolGroup.html",
"ve.ce.FocusableNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ce.FocusableNode",
"ve.ce.LeafNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ce.LeafNode",
"ve.dm.BranchNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.BranchNode",
"ve.dm.Document": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.Document",
"ve.dm.DocumentNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.DocumentNode",
"ve.dm.FocusableNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.FocusableNode",
"ve.dm.InternalItemNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.InternalItemNode",
"ve.dm.InternalList": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.InternalList",
"ve.dm.LeafNode": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.LeafNode",
"ve.dm.Model": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.Model",
"ve.dm.Node": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.Node",
"ve.dm.Surface": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.Surface",
"ve.dm.SurfaceFragment": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.dm.SurfaceFragment",
"ve.ui.Action": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.Action",
"ve.ui.Command": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.Command",
"ve.ui.FragmentWindowTool": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.FragmentWindowTool",
"ve.ui.LinearContext": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.LinearContext",
"ve.ui.LinearContextItem": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.LinearContextItem",
"ve.ui.MWDefinedTransclusionContextItem": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.MWDefinedTransclusionContextItem",
"ve.ui.MWTemplateDialog": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.MWTemplateDialog",
"ve.ui.NodeDialog": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.NodeDialog",
"ve.ui.Surface": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.Surface",
"ve.ui.WindowTool": "https://doc.wikimedia.org/VisualEditor/master/js/#!/api/ve.ui.WindowTool"
}
}
}
}