diff --git a/jsdoc.json b/jsdoc.json index ca541eaf6..d933418b5 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -1,16 +1,12 @@ { "opts": { "destination": "docs/js", - "pedantic": true, + "pedantic": false, "recurse": true, "template": "node_modules/jsdoc-wmf-theme" }, "plugins": [ - "node_modules/jsdoc-wmf-theme/plugins/allow-dots-in-modules", - "plugins/markdown", - "node_modules/jsdoc-wmf-theme/plugins/externals", - "node_modules/jsdoc-wmf-theme/plugins/summarize", - "node_modules/jsdoc-wmf-theme/plugins/betterlinks" + "node_modules/jsdoc-wmf-theme/plugins/default" ], "source": { "include": [ "modules", "package.json", "README.md" ] @@ -23,25 +19,20 @@ "wmf": { "repository": "https://gerrit.wikimedia.org/g/mediawiki/extensions/Cite/", "prefixMap": { - "OO.ui.": "https://doc.wikimedia.org/oojs-ui/master/js/{type}.html", - "OO.": "https://doc.wikimedia.org/oojs/master/{type}.html", "ve.": "https://doc.wikimedia.org/visualeditor-standalone/master/{type}.html", - "mw.": "https://doc.wikimedia.org/mediawiki-core/master/js/{type}.html" + "ve.dm.MW": "https://doc.wikimedia.org/VisualEditor/master/js/{type}.html", + "ve.ce.MW": "https://doc.wikimedia.org/VisualEditor/master/js/{type}.html", + "ve.ui.MW": "https://doc.wikimedia.org/VisualEditor/master/js/{type}.html", + "mw.": "https://doc.wikimedia.org/mediawiki-core/master/js/{type}.html", + "ve.dm.MWDocumentReferences": true, + "ve.dm.MWReference": true, + "ve.ce.MWReference": true, + "ve.ui.MWReference": true }, - "prefixMapIgnore": [ - "ve.dm.MWDocumentReferences", - "ve.dm.MWReference", - "ve.ce.MWReference", - "ve.ui.MWReference" - ], "linkMap": { "ext.popups.Preview": "https://doc.wikimedia.org/Popups/master/js/js/Popups/module-preview.html", "ext.popups.PreviewModel": "https://doc.wikimedia.org/Popups/master/js/js/Popups/module-preview_model.html", - "Gateway": "https://doc.wikimedia.org/Popups/master/js/js/Popups/module-gateway.html", - "HTMLAnchorElement": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement", - "HTMLElement": "https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement", - "jQuery": "https://api.jquery.com/Types/#jQuery", - "jQuery.Event": "https://api.jquery.com/category/events/event-object/" + "Gateway": "https://doc.wikimedia.org/Popups/master/js/js/Popups/module-gateway.html" } } } diff --git a/package-lock.json b/package-lock.json index b892487b4..bdb481b52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,8 +15,8 @@ "grunt-banana-checker": "0.13.0", "grunt-eslint": "24.3.0", "grunt-stylelint": "0.20.1", - "jsdoc": "^4.0.3", - "jsdoc-wmf-theme": "1.0.1", + "jsdoc": "4.0.3", + "jsdoc-wmf-theme": "1.1.0", "stylelint-config-wikimedia": "0.17.2" } }, @@ -4134,6 +4134,12 @@ "node": ">=12.0.0" } }, + "node_modules/jsdoc-class-hierarchy": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/jsdoc-class-hierarchy/-/jsdoc-class-hierarchy-1.1.2.tgz", + "integrity": "sha512-oU7UgWr0Qbtxd2J81/ee1lM8xAdyUU7B1ZosVwZxJwjhPWvtkX9ooHjD1Fk97OyOlpTBXxYVTpptvSCKRt8wvQ==", + "dev": true + }, "node_modules/jsdoc-type-pratt-parser": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", @@ -4144,14 +4150,15 @@ } }, "node_modules/jsdoc-wmf-theme": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.0.1.tgz", - "integrity": "sha512-QKCtPM1INxFDOPSIEcPTHP4PhVzyDyQD7ALWLmVD8dP0BFdQuGVFG/q3sbxC4uNCrntOoLOVmzFFK95d0OgeTQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.1.0.tgz", + "integrity": "sha512-0BQMgaSBmdGRVSiyAF7SMm1mTS59Y5vpPHAFFABcZRL15TIc5UyL88DtrrA1nuKL+jgTBsMgaeu8NDfNstC8RA==", "dev": true, "dependencies": { "@jsdoc/salty": "^0.2.8", "@wikimedia/codex-design-tokens": "1.1.1", "domino": "^2.1.6", + "jsdoc-class-hierarchy": "1.1.2", "lunr": "2.3.9", "marked": "^12.0.2", "normalize.css": "8.0.1" @@ -9922,6 +9929,12 @@ } } }, + "jsdoc-class-hierarchy": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/jsdoc-class-hierarchy/-/jsdoc-class-hierarchy-1.1.2.tgz", + "integrity": "sha512-oU7UgWr0Qbtxd2J81/ee1lM8xAdyUU7B1ZosVwZxJwjhPWvtkX9ooHjD1Fk97OyOlpTBXxYVTpptvSCKRt8wvQ==", + "dev": true + }, "jsdoc-type-pratt-parser": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", @@ -9929,14 +9942,15 @@ "dev": true }, "jsdoc-wmf-theme": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.0.1.tgz", - "integrity": "sha512-QKCtPM1INxFDOPSIEcPTHP4PhVzyDyQD7ALWLmVD8dP0BFdQuGVFG/q3sbxC4uNCrntOoLOVmzFFK95d0OgeTQ==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/jsdoc-wmf-theme/-/jsdoc-wmf-theme-1.1.0.tgz", + "integrity": "sha512-0BQMgaSBmdGRVSiyAF7SMm1mTS59Y5vpPHAFFABcZRL15TIc5UyL88DtrrA1nuKL+jgTBsMgaeu8NDfNstC8RA==", "dev": true, "requires": { "@jsdoc/salty": "^0.2.8", "@wikimedia/codex-design-tokens": "1.1.1", "domino": "^2.1.6", + "jsdoc-class-hierarchy": "1.1.2", "lunr": "2.3.9", "marked": "^12.0.2", "normalize.css": "8.0.1" diff --git a/package.json b/package.json index db706aa18..156578341 100644 --- a/package.json +++ b/package.json @@ -18,8 +18,8 @@ "grunt-banana-checker": "0.13.0", "grunt-eslint": "24.3.0", "grunt-stylelint": "0.20.1", - "jsdoc": "^4.0.3", - "jsdoc-wmf-theme": "1.0.1", + "jsdoc": "4.0.3", + "jsdoc-wmf-theme": "1.1.0", "stylelint-config-wikimedia": "0.17.2" } }