Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-05-30 10:20:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/tools/jsdoc
History
Ryan Huffman c6b64081fc Add Overlays jsdocs
2016-11-16 12:01:05 -08:00
..
plugins Add Overlays jsdocs 2016-11-16 12:01:05 -08:00
.gitignore
config.json
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 scripts/jsdoc jsdoc . -c config.json

The out folder should contain index.html