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:
Stephen Niedzielski 2018-07-19 09:12:32 -05:00
parent 9b15c940c0
commit 8ba5c0f773
18 changed files with 14 additions and 11 deletions

2
.gitignore vendored
View file

@ -1,4 +1,4 @@
/doc/autogenerated/ /docs/js/
/.nyc_output/ /.nyc_output/
/node_modules/ /node_modules/
/vendor/ /vendor/

View file

Before

Width:  |  Height:  |  Size: 148 KiB

After

Width:  |  Height:  |  Size: 148 KiB

View file

@ -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
}
} }
} }

Binary file not shown.

View file

@ -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

View file

@ -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