Mirrors/overte-AleziaKurdis
3
0
Fork 0
mirror of https://github.com/AleziaKurdis/overte.git synced 2025-04-11 12:22:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-AleziaKurdis/tools/jsdoc
History
Anthony J. Thibault 35eeaad590 Added jsdocs for MyAvatar 
Not complete by any means, but it's a start.
2016-12-01 17:38:43 -08:00
..
plugins Added jsdocs for MyAvatar 2016-12-01 17:38:43 -08: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