Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-09 20:45:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc
History
David Rowe f27e8868eb Add HMD JSDoc
2018-03-28 12:25:12 +13:00
..
plugins Add HMD JSDoc 2018-03-28 12:25:12 +13:00
.gitignore
CMakeLists.txt attempt to fix ubuntu build 2018-01-24 01:45:53 +01:00
config.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
package.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
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.