3c6511d94e
Fix any broken JSDoc syntax. Unfortunately there is no way to document tuples like `{[int, int]}` for a `[width, height]` array. We could possibly fix this and make the code more readable with `{width: number, height: number}` instead of tuples.
Remove single `@fileoverview` from Rectangle.js, since it was the only file with one and was weird to have that one module show up on the docs home page.
Add a `docs` script to `package.json`, run it from `npm test`, so invalid docs will cause tests to fail (eventually we may want to start using eslint-plugin-jsdoc to catch these errors with the linter alone).
21 lines
433 B
JSON
21 lines
433 B
JSON
{
|
|
"plugins": ["plugins/markdown"],
|
|
"templates": {
|
|
"default": {
|
|
"includeDate": false,
|
|
"outputSourceFiles": false
|
|
}
|
|
},
|
|
"source": {
|
|
"include": ["src"]
|
|
},
|
|
"opts": {
|
|
"destination": "playground/docs",
|
|
"pedantic": true,
|
|
"private": true,
|
|
"readme": "README.md",
|
|
"recurse": true,
|
|
"template": "node_modules/docdash"
|
|
}
|
|
}
|