Mirrors/overte-AleziaKurdis
3
0
Fork 0
mirror of https://github.com/AleziaKurdis/overte.git synced 2025-04-11 09:22:21 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-AleziaKurdis/tools/jsdoc
History
Thijs Wenker 483074b11e jsdoc cmake fixes
2018-01-22 17:59:01 +01:00
..
plugins jsdoc cmake fixes 2018-01-22 17:59:01 +01:00
.gitignore
CMakeLists.txt jsdoc cmake fixes 2018-01-22 17:59:01 +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

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.