Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-05 08:29:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/tools/jsdoc
History
David Rowe e44e7ca35f Fix up Resource and resource cache APIs' JSDoc
2018-05-21 11:57:16 +12:00
..
plugins Fix up Resource and resource cache APIs' JSDoc 2018-05-21 11:57:16 +12:00
.gitignore
CMakeLists.txt
config.json
package.json
README.md
root.js

README.md

#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.