Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-05 08:29:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-lubosz/tools/jsdoc
History
ingerjm0 761a922951 Fixed per code review
2019-02-25 10:43:14 -08:00
..
hifi-jsdoc-template Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
out Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build 2019-02-19 10:36:35 -08:00
plugins Fixed per code review 2019-02-25 10:43:14 -08:00
.gitignore Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build 2019-02-19 10:36:35 -08:00
CMakeLists.txt
config.json Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
gravPrep.js
package.json
README.md
root.js

README.md

#JavaScript Documentation Generation

##Prerequisites

  • Install node.js.
  • Install jsdoc via npm. npm install jsdoc -g

If you would like the extra functionality for gravPrep:

  • Run npm install

To generate html documentation for the High Fidelity JavaScript API:

  • cd tools/jsdoc
  • jsdoc root.js -c config.json

The out folder should contain index.html.

To generate the grav automation files, run node gravPrep.js after you have made a JSdoc output folder.

This will create files that are needed for hifi-grav and hifi-grav-content repos

The md files for hifi-grav-content are located in out/grav/06.api-reference.

The template twig html files for hifi-grav are located out/grav/templates.

if you would like to copy these to a local version of the docs on your system you can run with the follows args:

  • node grav true "path/to/grav/" "path/to/grav/content"