From fff819f56cd98993a7d528907e49b53fbbfcc6c4 Mon Sep 17 00:00:00 2001 From: Kasen IO Date: Fri, 27 Mar 2020 16:07:59 -0400 Subject: [PATCH] Fix sidebar not showing on first load. --- tools/jsdoc/README.md | 10 +++++----- tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl | 5 +++-- tools/jsdoc/plugins/hifi.js | 2 +- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/tools/jsdoc/README.md b/tools/jsdoc/README.md index 8526bccc4e..a1b7eb1d79 100644 --- a/tools/jsdoc/README.md +++ b/tools/jsdoc/README.md @@ -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: diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl index 6d12ccd816..25644cc73e 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl @@ -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; } diff --git a/tools/jsdoc/plugins/hifi.js b/tools/jsdoc/plugins/hifi.js index aa2b81c0a8..52e8254a95 100644 --- a/tools/jsdoc/plugins/hifi.js +++ b/tools/jsdoc/plugins/hifi.js @@ -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 = [