Przeglądaj źródła

Docs: Clean up. (#30272)

* Docs: Clean up.

* Update ChainMap.js
Michael Herzog 1 rok temu
rodzic
commit
9f2dc5d72e

+ 4 - 4
src/nodes/accessors/MaterialNode.js

@@ -520,7 +520,7 @@ export const materialReflectivity = /*@__PURE__*/ nodeImmutable( MaterialNode, M
 
 
 /**
 /**
  * TSL object that represents the roughness of the current material.
  * TSL object that represents the roughness of the current material.
- * The value is composed via `roughness` * `roughnessMap.g`
+ * The value is composed via `roughness` * `roughnessMap.g`.
  *
  *
  * @type {Node<float>}
  * @type {Node<float>}
  */
  */
@@ -528,7 +528,7 @@ export const materialRoughness = /*@__PURE__*/ nodeImmutable( MaterialNode, Mate
 
 
 /**
 /**
  * TSL object that represents the metalness of the current material.
  * TSL object that represents the metalness of the current material.
- * The value is composed via `metalness` * `metalnessMap.b`
+ * The value is composed via `metalness` * `metalnessMap.b`.
  *
  *
  * @type {Node<float>}
  * @type {Node<float>}
  */
  */
@@ -552,7 +552,7 @@ export const materialClearcoat = /*@__PURE__*/ nodeImmutable( MaterialNode, Mate
 
 
 /**
 /**
  * TSL object that represents the clearcoat roughness of the current material.
  * TSL object that represents the clearcoat roughness of the current material.
- * The value is composed via `clearcoatRoughness` * `clearcoatRoughnessMap.r`
+ * The value is composed via `clearcoatRoughness` * `clearcoatRoughnessMap.r`.
  *
  *
  * @type {Node<float>}
  * @type {Node<float>}
  */
  */
@@ -583,7 +583,7 @@ export const materialSheen = /*@__PURE__*/ nodeImmutable( MaterialNode, Material
 
 
 /**
 /**
  * TSL object that represents the sheen roughness of the current material.
  * TSL object that represents the sheen roughness of the current material.
- * The value is composed via `sheenRoughness` * `sheenRoughnessMap.a` .
+ * The value is composed via `sheenRoughness` * `sheenRoughnessMap.a`.
  *
  *
  * @type {Node<float>}
  * @type {Node<float>}
  */
  */

+ 6 - 6
src/nodes/display/BumpMapNode.js

@@ -66,8 +66,8 @@ class BumpMapNode extends TempNode {
 	/**
 	/**
 	 * Constructs a new bump map node.
 	 * Constructs a new bump map node.
 	 *
 	 *
-	 * @param {Node} textureNode - Represents the bump map data.
-	 * @param {Node?} [scaleNode=null] - Controls the intensity of the bump effect.
+	 * @param {Node<float>} textureNode - Represents the bump map data.
+	 * @param {Node<float>?} [scaleNode=null] - Controls the intensity of the bump effect.
 	 */
 	 */
 	constructor( textureNode, scaleNode = null ) {
 	constructor( textureNode, scaleNode = null ) {
 
 
@@ -76,14 +76,14 @@ class BumpMapNode extends TempNode {
 		/**
 		/**
 		 * Represents the bump map data.
 		 * Represents the bump map data.
 		 *
 		 *
-		 * @type {Node}
+		 * @type {Node<float>}
 		 */
 		 */
 		this.textureNode = textureNode;
 		this.textureNode = textureNode;
 
 
 		/**
 		/**
 		 * Controls the intensity of the bump effect.
 		 * Controls the intensity of the bump effect.
 		 *
 		 *
-		 * @type {Node?}
+		 * @type {Node<float>?}
 		 * @default null
 		 * @default null
 		 */
 		 */
 		this.scaleNode = scaleNode;
 		this.scaleNode = scaleNode;
@@ -111,8 +111,8 @@ export default BumpMapNode;
  * TSL function for creating a bump map node.
  * TSL function for creating a bump map node.
  *
  *
  * @function
  * @function
- * @param {Node} textureNode - Represents the bump map data.
- * @param {Node?} [scaleNode=null] - Controls the intensity of the bump effect.
+ * @param {Node<float>} textureNode - Represents the bump map data.
+ * @param {Node<float>?} [scaleNode=null] - Controls the intensity of the bump effect.
  * @returns {BumpMapNode}
  * @returns {BumpMapNode}
  */
  */
 export const bumpMap = /*@__PURE__*/ nodeProxy( BumpMapNode );
 export const bumpMap = /*@__PURE__*/ nodeProxy( BumpMapNode );

+ 6 - 6
src/nodes/display/NormalMapNode.js

@@ -59,8 +59,8 @@ class NormalMapNode extends TempNode {
 	/**
 	/**
 	 * Constructs a new normal map node.
 	 * Constructs a new normal map node.
 	 *
 	 *
-	 * @param {Node} node - Represents the normal map data.
-	 * @param {Node?} [scaleNode=null] - Controls the intensity of the effect.
+	 * @param {Node<vec3>} node - Represents the normal map data.
+	 * @param {Node<vec2>?} [scaleNode=null] - Controls the intensity of the effect.
 	 */
 	 */
 	constructor( node, scaleNode = null ) {
 	constructor( node, scaleNode = null ) {
 
 
@@ -69,14 +69,14 @@ class NormalMapNode extends TempNode {
 		/**
 		/**
 		 * Represents the normal map data.
 		 * Represents the normal map data.
 		 *
 		 *
-		 * @type {Node}
+		 * @type {Node<vec3>}
 		 */
 		 */
 		this.node = node;
 		this.node = node;
 
 
 		/**
 		/**
 		 * Controls the intensity of the effect.
 		 * Controls the intensity of the effect.
 		 *
 		 *
-		 * @type {Node?}
+		 * @type {Node<vec2>?}
 		 * @default null
 		 * @default null
 		 */
 		 */
 		this.scaleNode = scaleNode;
 		this.scaleNode = scaleNode;
@@ -142,8 +142,8 @@ export default NormalMapNode;
  * TSL function for creating a normal map node.
  * TSL function for creating a normal map node.
  *
  *
  * @function
  * @function
- * @param {Node} node - Represents the normal map data.
- * @param {Node?} [scaleNode=null] - Controls the intensity of the effect.
+ * @param {Node<vec3>} node - Represents the normal map data.
+ * @param {Node<vec2>?} [scaleNode=null] - Controls the intensity of the effect.
  * @returns {NormalMapNode}
  * @returns {NormalMapNode}
  */
  */
 export const normalMap = /*@__PURE__*/ nodeProxy( NormalMapNode );
 export const normalMap = /*@__PURE__*/ nodeProxy( NormalMapNode );

+ 3 - 3
src/renderers/common/ChainMap.js

@@ -2,14 +2,14 @@
  * Data structure for the renderer. It allows defining values
  * Data structure for the renderer. It allows defining values
  * with chained, hierarchical keys. Keys are meant to be
  * with chained, hierarchical keys. Keys are meant to be
  * objects since the module internally works with Weak Maps
  * objects since the module internally works with Weak Maps
- * for perforamnce reasons.
+ * for performance reasons.
  *
  *
  * @private
  * @private
  */
  */
 class ChainMap {
 class ChainMap {
 
 
 	/**
 	/**
-	 * Constructs a new chained map.
+	 * Constructs a new Chain Map.
 	 */
 	 */
 	constructor() {
 	constructor() {
 
 
@@ -49,7 +49,7 @@ class ChainMap {
 	 *
 	 *
 	 * @param {Array<Object>} keys - List of keys.
 	 * @param {Array<Object>} keys - List of keys.
 	 * @param {Any} value - The value to set.
 	 * @param {Any} value - The value to set.
-	 * @return {ChainMap} A reference to this chain map.
+	 * @return {ChainMap} A reference to this Chain Map.
 	 */
 	 */
 	set( keys, value ) {
 	set( keys, value ) {
 
 

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

@@ -4,7 +4,10 @@
             "encoding": "utf8",
             "encoding": "utf8",
             "package": "package.json",
             "package": "package.json",
             "recurse": true,
             "recurse": true,
-            "template": "node_modules/clean-jsdoc-theme"
+            "template": "node_modules/clean-jsdoc-theme",
+            "theme_opts": {
+                "homepageTitle": "three.js docs"
+           }
     },
     },
     "plugins": [ "plugins/markdown" ],
     "plugins": [ "plugins/markdown" ],
     "source": {
     "source": {
@@ -16,5 +19,9 @@
             "src/renderers/common", 
             "src/renderers/common", 
             "src/renderers/webgpu" 
             "src/renderers/webgpu" 
         ]
         ]
+    },
+    "markdown": {
+        "hardwrap": false,
+        "idInHeadings": true
     }
     }
 }
 }

粤ICP备19079148号