Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-10 08:56:57 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte/tools/jsdoc
History
Anthony J. Thibault 0c8105b551 Revert "Merge pull request #9141 from hyperlogic/feature/my-avatar-docs-part-1" 
This reverts commit 934148fea5, reversing
changes made to d2b32c3084.
2016-12-05 15:17:53 -08:00
..
plugins Revert "Merge pull request #9141 from hyperlogic/feature/my-avatar-docs-part-1" 2016-12-05 15:17:53 -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