Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-08 06:52:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc
History
Anthony J. Thibault f7de74109b Added jsdoc documentation for some of MyAvatar properties and methods
2017-03-24 15:10:26 -07:00
..
plugins Added jsdoc documentation for some of MyAvatar properties and methods 2017-03-24 15:10:26 -07:00
.gitignore Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00
config.json Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00
README.md Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00
root.js Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00

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 scripts/jsdoc jsdoc . -c config.json

The out folder should contain index.html