Browse Source

Docs: Improve JSDoc config. (#30430)

Michael Herzog 1 year ago
parent
commit
73019ad35a

+ 1 - 1
examples/jsm/tsl/display/SSAAPassNode.js

@@ -16,7 +16,7 @@ let _rendererState;
  *
  * Reference: {@link https://en.wikipedia.org/wiki/Supersampling}
  *
- * @augments PassNode
+ * @augments module:PassNode~PassNode
  */
 class SSAAPassNode extends PassNode {
 

+ 1 - 1
examples/jsm/tsl/display/StereoCompositePassNode.js

@@ -14,7 +14,7 @@ let _rendererState;
  * anaglyph or parallax barrier.
  *
  * @abstract
- * @augments PassNode
+ * @augments module:PassNode~PassNode
  */
 class StereoCompositePassNode extends PassNode {
 

+ 1 - 1
examples/jsm/tsl/display/StereoPassNode.js

@@ -10,7 +10,7 @@ let _rendererState;
 /**
  * A special render pass node that renders the scene as a stereoscopic image.
  *
- * @augments PassNode
+ * @augments module:PassNode~PassNode
  */
 class StereoPassNode extends PassNode {
 

+ 1 - 1
examples/jsm/tsl/display/TRAAPassNode.js

@@ -18,7 +18,7 @@ let _rendererState;
  * - {@link https://alextardif.com/TAA.html}
  * - {@link https://www.elopezr.com/temporal-aa-and-the-quest-for-the-holy-trail/}
  *
- * @augments PassNode
+ * @augments module:PassNode~PassNode
  */
 class TRAAPassNode extends PassNode {
 

+ 33 - 0
utils/docs/custom/three.css

@@ -0,0 +1,33 @@
+:root {
+    --background-color-dark: #222;
+    --background-color-light: #fff;
+    --border-style-dark: 1px solid #444;
+    --border-style-light: 1px solid #E8E8E8;
+}
+
+/* dark */
+
+body { 
+    background-color: var(--background-color-dark) !important;
+}
+.navbar-container {
+    background-color: var(--background-color-dark) !important;
+}
+.sidebar-container {
+    border-right: var(--border-style-dark);
+}
+
+/* light */
+
+body.light  { 
+    background-color: var(--background-color-light) !important;
+}
+.light .navbar-container {
+    background-color: var(--background-color-light) !important;
+}
+.light .sidebar-container {
+    border-right: var(--border-style-light);
+}
+.light .sidebar {
+    background-color: var(--background-color-light) !important;
+}

+ 3 - 1
utils/docs/jsdoc.config.json

@@ -6,7 +6,9 @@
             "recurse": true,
             "template": "node_modules/clean-jsdoc-theme",
             "theme_opts": {
-                "homepageTitle": "three.js docs"
+                "homepageTitle": "three.js docs",
+                "sections": ["Classes", "Modules"],
+                "include_css": ["utils/docs/custom/three.css"]
            }
     },
     "plugins": [ "plugins/markdown" ],

粤ICP备19079148号