Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-25 17:55:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte/tools/jsdoc/README.md
David Rowe a482b7c371 Fix up JSDoc tool readme file
2017-11-10 17:09:45 +13:00

282 B
Raw Blame History

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