Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-Armored-Dragon/tools/jsdoc
History
David Rowe a482b7c371 Fix up JSDoc tool readme file
2017-11-10 17:09:45 +13: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 Fix up JSDoc tool readme file 2017-11-10 17:09:45 +13: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 tools/jsdoc
  • jsdoc . -c config.json

The out folder should contain index.html.