Adding information about jsdoc3 dependency
This commit is contained in:
@@ -79,8 +79,12 @@ Then:
|
|||||||
|
|
||||||
## Run the precommit hook before pushing a commit:
|
## Run the precommit hook before pushing a commit:
|
||||||
|
|
||||||
|
First, install the latest version of [JSDoc3](https://github.com/jsdoc3/jsdoc). Then:
|
||||||
|
|
||||||
$ ./build.py precommit
|
$ ./build.py precommit
|
||||||
|
|
||||||
|
This makes sure that your commit won't break the build. It also runs JSDoc3 to make sure that there are no invalid API doc directives.
|
||||||
|
|
||||||
## Add examples
|
## Add examples
|
||||||
|
|
||||||
The examples are located in the `examples` directory. Adding a new example
|
The examples are located in the `examples` directory. Adding a new example
|
||||||
|
|||||||
Reference in New Issue
Block a user