Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-08 21:12:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc
History
David Rowe f9086e31de Deprecate Entities.getMeshes() in favor of using the new Graphics API
2018-03-01 10:08:50 +13:00
..
plugins Deprecate Entities.getMeshes() in favor of using the new Graphics API 2018-03-01 10:08:50 +13:00
.gitignore Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00
CMakeLists.txt attempt to fix ubuntu build 2018-01-24 01:45:53 +01:00
config.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
package.json JS scripting console auto-complete 2018-01-19 19:11:12 +01: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.