sdk-javascript/docs/images
Lance Ball b283583c0c
docs: add JSDocs for top level API objects (#140)
This commit add JSDoc documentation to the CloudEvent and HTTPReceiver
objects exposed by the API when using the top level imports, specifically
`CloudEvent` and `HTTPReceiver`.

This adds a `generate-docs` npm script to generate site and API documentation
for GitHub pages in `./docs`.

Signed-off-by: Lance Ball <lball@redhat.com>
2020-05-12 17:27:11 -04:00
..
Makefile docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
forwarder.dot docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
forwarder.svg docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
mutator.dot docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
mutator.svg docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
receiver.dot docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
receiver.svg docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
sender.dot docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
sender.svg docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
stack.dot docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00
stack.svg docs: add JSDocs for top level API objects (#140) 2020-05-12 17:27:11 -04:00