mirror of
https://github.com/HifiExperiments/overte.git
synced 2025-05-06 15:58:35 +02:00
13 lines
282 B
Markdown
13 lines
282 B
Markdown
#JavaScript Documentation Generation
|
|
|
|
##Prerequisites
|
|
|
|
* Install node.js
|
|
* Install jsdoc via npm. `npm install jsdoc -g`
|
|
|
|
To generate html documentation for the High Fidelity JavaScript API:
|
|
|
|
* `cd tools/jsdoc`
|
|
* `jsdoc . -c config.json`
|
|
|
|
The out folder should contain index.html.
|