Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-05 10:53:57 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/tools/jsdoc
History
David Rowe 7cef329939 Render API JSDoc stubs
2018-05-13 11:53:57 +12:00
..
plugins Render API JSDoc stubs 2018-05-13 11:53:57 +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.