Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-14 16:06:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update JSDoc README with solution for out-of-memory problem

Browse source
This commit is contained in:
David Rowe 2019-03-15 11:05:58 +13:00
parent 53b5a599b1
commit f0bbd89546
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
tools/jsdoc/README.md
View file

@ -15,6 +15,13 @@ To generate html documentation for the High Fidelity JavaScript API:
The out folder should contain index.html.
If you get a "JavaScript heap out of memory" error when running the `jsdoc` command you need to increase the amount of memory
available to it. For example, to increase the memory available to 2GB on Windows:
* `where jsdoc` to find the `jsdoc.cmd` file.
* Edit the `jsdoc.cmd` file to add `--max-old-space-size=2048` after the `node` and/or `node.exe` commands.
Reference: https://medium.com/@vuongtran/how-to-solve-process-out-of-memory-in-node-js-5f0de8f8464c
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