Generate docs from src, publish to gh-pages

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).
This commit is contained in:
Ray Schamp
2017-02-19 23:57:55 -05:00
parent b7d5610b23
commit 3c6511d94e
13 changed files with 159 additions and 85 deletions

1
.gitignore vendored
View File

@@ -16,3 +16,4 @@ npm-*
/dist
/playground/scratch-render.js
/playground/scratch-render.js.map
/playground/docs