Mirrors/overte-thingvellir
3
0
Fork 0
mirror of https://thingvellir.net/git/overte synced 2025-03-27 23:52:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-thingvellir/tools/jsdoc
History
David Rowe fada958e72 Handle possibly undefined value
2018-04-28 19:57:45 +12:00
..
plugins Handle possibly undefined value 2018-04-28 19:57:45 +12:00
.gitignore
CMakeLists.txt Include JSDoc Web pages in the install 2018-04-16 16:08:26 +12:00
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.