mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-11-23 23:24:39 +00:00
Hygiene: make JSDoc configs consistent
Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For Popups, specify package.json, readme, and default template options and moved doc/ to docs/ and autogenerated JavaScript documentation from doc/autogenerated to docs/js. 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: I81e64f06265f1ecc4e2ee159deef9b204ea7e957
This commit is contained in:
parent
9b15c940c0
commit
8ba5c0f773
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,4 +1,4 @@
|
||||||
/doc/autogenerated/
|
/docs/js/
|
||||||
/.nyc_output/
|
/.nyc_output/
|
||||||
/node_modules/
|
/node_modules/
|
||||||
/vendor/
|
/vendor/
|
||||||
|
|
Before Width: | Height: | Size: 148 KiB After Width: | Height: | Size: 148 KiB |
19
jsdoc.json
19
jsdoc.json
|
@ -1,18 +1,21 @@
|
||||||
{
|
{
|
||||||
"source": {
|
|
||||||
"include": [
|
|
||||||
"src/"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"opts": {
|
"opts": {
|
||||||
"destination": "doc/autogenerated/",
|
"destination": "docs/js",
|
||||||
|
"package": "package.json",
|
||||||
"pedantic": true,
|
"pedantic": true,
|
||||||
|
"readme": "README.md",
|
||||||
"recurse": true
|
"recurse": true
|
||||||
},
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"plugins/markdown"
|
"plugins/markdown"
|
||||||
],
|
],
|
||||||
"tags": {
|
"source": {
|
||||||
"allowUnknownTags": true
|
"include": [ "src" ]
|
||||||
|
},
|
||||||
|
"templates": {
|
||||||
|
"cleverLinks": true,
|
||||||
|
"default": {
|
||||||
|
"useLongnameInNav": true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
BIN
resources/dist/index.js.json
vendored
BIN
resources/dist/index.js.json
vendored
Binary file not shown.
|
@ -403,7 +403,7 @@ export function hideSettings() {
|
||||||
* place (the preview reducer), we query it and dispatch it as `wasEnabled`
|
* place (the preview reducer), we query it and dispatch it as `wasEnabled`
|
||||||
* so that other reducers (like settings) can act on it without having to
|
* so that other reducers (like settings) can act on it without having to
|
||||||
* duplicate the `enabled` state locally.
|
* duplicate the `enabled` state locally.
|
||||||
* See doc/adr/0003-keep-enabled-state-only-in-preview-reducer.md for more
|
* See docs/adr/0003-keep-enabled-state-only-in-preview-reducer.md for more
|
||||||
* details.
|
* details.
|
||||||
*
|
*
|
||||||
* @param {boolean} enabled if previews are enabled or not
|
* @param {boolean} enabled if previews are enabled or not
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
* the state we need to manually iterate over updates and check with
|
* the state we need to manually iterate over updates and check with
|
||||||
* hasOwnProperty to copy over to the new state.
|
* hasOwnProperty to copy over to the new state.
|
||||||
*
|
*
|
||||||
* In [change listeners](/doc/change_listeners.md), for example, we talk about
|
* In [change listeners](/docs/change_listener.md), for example, we talk about
|
||||||
* the previous state and the current state (the `prevState` and `state`
|
* the previous state and the current state (the `prevState` and `state`
|
||||||
* parameters, respectively). Since
|
* parameters, respectively). Since
|
||||||
* [reducers](http://redux.js.org/docs/basics/Reducers.html) take the current
|
* [reducers](http://redux.js.org/docs/basics/Reducers.html) take the current
|
||||||
|
|
Loading…
Reference in a new issue