Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-Armored-Dragon/tools/jsdoc
History
David Rowe 1ca6bd2f0b location getter/setter JSDoc
2018-05-15 17:37:45 +12:00
..
plugins location getter/setter JSDoc 2018-05-15 17:37:45 +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.