Mirrors/overte-AleziaKurdis
3
0
Fork 0
mirror of https://github.com/AleziaKurdis/overte.git synced 2025-04-06 17:53:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix sidebar not showing on first load.

Browse source
This commit is contained in:
Kasen IO 2020-03-27 16:07:59 -04:00
parent b4391f8218
commit fff819f56c
3 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
tools/jsdoc/README.md
View file

@ -1,19 +1,19 @@
#JavaScript Documentation Generation
# JavaScript Documentation Generation
##Prerequisites
## Prerequisites
* Install node.js.
* Install jsdoc via npm. `npm install jsdoc -g`
If you would like the extra functionality for gravPrep:
* Run npm install
* Run `npm install`
To generate html documentation for the High Fidelity JavaScript API:
To generate HTML documentation for the Vircadia JavaScript API:
* `cd tools/jsdoc`
* `jsdoc root.js -r api-mainpage.md -c config.json`
The out folder should contain index.html.
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:

5
tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl
View file

@ -45,20 +45,21 @@
var defaultDarkDisabled = false;
var darkDisabled = isLocalStorageSupported ? JSON.parse(localStorage.getItem('darkDisabled')) : defaultDarkDisabled;
var nightSheet = document.querySelector('[href="styles/night.css"]');
if (darkDisabled === null) {
localStorage.setItem('darkDisabled', JSON.stringify(defaultDarkDisabled));
} else {
var nightSheet = document.querySelector('[href="styles/night.css"]');
nightSheet.disabled = darkDisabled;
}
var defaultResponsiveDisabled = true;
var responsiveDisabled =
isLocalStorageSupported ? JSON.parse(localStorage.getItem('responsiveDisabled')) : defaultResponsiveDisabled;
var responsiveSheet = document.querySelector('[href="styles/responsive.css"]');
if (responsiveDisabled === null) {
localStorage.setItem('responsiveDisabled', JSON.stringify(defaultResponsiveDisabled));
responsiveSheet.disabled = defaultResponsiveDisabled;
} else {
var responsiveSheet = document.querySelector('[href="styles/responsive.css"]');
responsiveSheet.disabled = responsiveDisabled;
}
</script>

2
tools/jsdoc/plugins/hifi.js
View file

@ -16,7 +16,7 @@ exports.handlers = {
beforeParse: function(e) {
var pathTools = require('path');
var rootFolder = pathTools.dirname(e.filename);
console.log("Scanning hifi source for jsdoc comments...");
console.log("Scanning the Vircadia source for JSDoc comments...");
// directories to scan for jsdoc comments
var dirList = [