Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-04 07:43:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte/tools/jsdoc
History
milad 3450af7a3d clean up
2018-05-21 21:52:20 -07:00
..
plugins merging onto mac 2018-05-19 22:44:18 -07:00
.gitignore
Check.js fixed undefined errors 2018-05-07 15:49:53 -07:00
CMakeLists.txt
config.json
Grav-Formater.js Fixed Asset Class 2018-05-12 15:45:27 -07:00
grav.bat Before David's latest stubs 2018-05-12 23:41:56 -07:00
grav.sh Added pre typedef splits 2018-05-20 20:40:23 -07:00
gravPrep-Explore.js
gravPrep.js clean up 2018-05-21 21:52:20 -07:00
package.json fixed undefined errors 2018-05-07 15:49:53 -07:00
README.md
root.js
warningLog

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.