wikimedia/mediawiki-skins-MinervaNeue
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue synced 2024-11-30 17:04:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-skins-MinervaNeue/jsdoc.json

40 lines
1.2 KiB
JSON
Raw Permalink Normal View History

Use jsdoc for generating Minerva documentation Given the level of documentation in this repo is extremely low now seems a good as time as any. The resulting documentation is a vast improvement on before grouping functions to an owner and introducing module names. We can iterate on the documentation over time. Bug: T138401 Change-Id: I9e787d40931d3d72a7037ce07d3ab0db8e72d825
2018-03-15 20:27:39 +00:00
{
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-19 13:59:29 +00:00
"opts": {
"destination": "docs/js",
"package": "package.json",
Remove all use of IIFEs across Minerva codebase These will make JSDoc easier to configure later and is better suited to ES6 module format. The dependency injection pattern can be retained by moving the import to the top of the file. Change-Id: I0fe692eb7066e52815ef3d21724c7439d82b2c5f
2024-06-26 13:17:23 +00:00
"pedantic": false,
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-19 13:59:29 +00:00
"readme": "README.md",
Udate jsdoc and use jsdoc-wmf-theme Depends-On: Ic3861870c10f64d7f5414669a9d25b8ffb4c79a4 Change-Id: I6750e9bb6d5409e497b5605e3a4660734f5677ab
2023-10-19 14:07:38 +00:00
"recurse": true,
"template": "node_modules/jsdoc-wmf-theme"
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-19 13:59:29 +00:00
},
Hygiene: enable syntax highlighting in JSDoc comments Add the JSDoc Markdown plugin so that inline code snippets look their very best. This plugin is currently used by the Popups repo and adding it here also improves JSDoc config consistency. Change-Id: Ib0094bed44268a1002d19ccb1a2495560331e09d
2018-07-27 15:35:16 +00:00
"plugins": [
build: Update jsdoc-wmf-theme to 1.1.0 Additional changes: * Update Minerva so that it doesn't output any APIs to the documentation - this is intentional as Minerva does not have any public facing APIs. Bug: T368081 Change-Id: Ie1a3ea30cbf35663c7fdd2494c1698044882969e
2024-06-26 13:23:40 +00:00
"node_modules/jsdoc-wmf-theme/plugins/default"
Hygiene: enable syntax highlighting in JSDoc comments Add the JSDoc Markdown plugin so that inline code snippets look their very best. This plugin is currently used by the Popups repo and adding it here also improves JSDoc config consistency. Change-Id: Ib0094bed44268a1002d19ccb1a2495560331e09d
2018-07-27 15:35:16 +00:00
],
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-19 13:59:29 +00:00
"source": {
"include": [ "resources" ]
},
"templates": {
"cleverLinks": true,
"default": {
"useLongnameInNav": true
Udate jsdoc and use jsdoc-wmf-theme Depends-On: Ic3861870c10f64d7f5414669a9d25b8ffb4c79a4 Change-Id: I6750e9bb6d5409e497b5605e3a4660734f5677ab
2023-10-19 14:07:38 +00:00
},
"wmf": {
build: Update jsdoc-wmf-theme to 1.1.0 Additional changes: * Update Minerva so that it doesn't output any APIs to the documentation - this is intentional as Minerva does not have any public facing APIs. Bug: T368081 Change-Id: Ie1a3ea30cbf35663c7fdd2494c1698044882969e
2024-06-26 13:23:40 +00:00
"repository": "https://gerrit.wikimedia.org/g/mediawiki/skins/MinervaNeue/",
"prefixMap": {
"mw.": "https://doc.wikimedia.org/mediawiki-core/master/js/{type}.html"
},
Udate jsdoc and use jsdoc-wmf-theme Depends-On: Ic3861870c10f64d7f5414669a9d25b8ffb4c79a4 Change-Id: I6750e9bb6d5409e497b5605e3a4660734f5677ab
2023-10-19 14:07:38 +00:00
"linkMap": {
build: Update jsdoc-wmf-theme to 1.1.0 Additional changes: * Update Minerva so that it doesn't output any APIs to the documentation - this is intentional as Minerva does not have any public facing APIs. Bug: T368081 Change-Id: Ie1a3ea30cbf35663c7fdd2494c1698044882969e
2024-06-26 13:23:40 +00:00
"jQuery": "https://api.jquery.com/jQuery/",
"Node": "https://developer.mozilla.org/docs/Web/API/Node",
"Element": "https://developer.mozilla.org/docs/Web/API/Element",
"HTMLElement": "https://developer.mozilla.org/docs/Web/API/HTMLElement",
Udate jsdoc and use jsdoc-wmf-theme Depends-On: Ic3861870c10f64d7f5414669a9d25b8ffb4c79a4 Change-Id: I6750e9bb6d5409e497b5605e3a4660734f5677ab
2023-10-19 14:07:38 +00:00
"Drawer": "https://doc.wikimedia.org/MobileFrontend/master/js/js/Drawer.html",
"Icon": "https://doc.wikimedia.org/MobileFrontend/master/js/js/Icon.html",
build: Update jsdoc-wmf-theme to 1.1.0 Additional changes: * Update Minerva so that it doesn't output any APIs to the documentation - this is intentional as Minerva does not have any public facing APIs. Bug: T368081 Change-Id: Ie1a3ea30cbf35663c7fdd2494c1698044882969e
2024-06-26 13:23:40 +00:00
"Overlay": "https://doc.wikimedia.org/MobileFrontend/master/js/js/Overlay.html",
"Page": "https://doc.wikimedia.org/MobileFrontend/master/js/js/Page.html",
Udate jsdoc and use jsdoc-wmf-theme Depends-On: Ic3861870c10f64d7f5414669a9d25b8ffb4c79a4 Change-Id: I6750e9bb6d5409e497b5605e3a4660734f5677ab
2023-10-19 14:07:38 +00:00
"View": "https://doc.wikimedia.org/MobileFrontend/master/js/js/View.html"
}
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For MinervaNeue: - Replace "packageX" option which was unfound in the JSDoc repo with "package". - Remove redundant default configurations. - Replace tabs with spaces since that's the standard in this repo. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-19 13:59:29 +00:00
}
}
Use jsdoc for generating Minerva documentation Given the level of documentation in this repo is extremely low now seems a good as time as any. The resulting documentation is a vast improvement on before grouping functions to an owner and introducing module names. We can iterate on the documentation over time. Bug: T138401 Change-Id: I9e787d40931d3d72a7037ce07d3ab0db8e72d825
2018-03-15 20:27:39 +00:00
}
Reference in a new issue Copy permalink