Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-18 20:38:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/tools/jsdoc
History
milad e436f65d4c reworking gravprep to fix most links and oddities
2018-05-20 23:32:18 -07:00
..
plugins merging onto mac 2018-05-19 22:44:18 -07:00
.gitignore saved before laptop acts up more 2018-05-01 16:23:50 -07:00
badLinks Links fixed 2018-05-06 21:39:37 -07:00
Check.js fixed undefined errors 2018-05-07 15:49:53 -07:00
CMakeLists.txt Include JSDoc Web pages in the install 2018-04-16 16:08:26 +12:00
config.json JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
grav.bat pre TOC add 2018-04-30 16:32:15 -07:00
grav.sh Added pre typedef splits 2018-05-20 20:40:23 -07:00
gravPrep-Explore.js Links fixed 2018-05-06 21:39:37 -07:00
gravPrep.js reworking gravprep to fix most links and oddities 2018-05-20 23:32:18 -07:00
Links-Untouched gravprep redo for link fixes 2018-05-20 14:18:39 -07:00
package.json fixed undefined errors 2018-05-07 15:49:53 -07: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
warningLog Links fixed 2018-05-06 21:39:37 -07: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.