Jsdoc: More fixes (#30557)

Co-authored-by: Samuel Rigaud <[email protected]>

Author: s-rigaud

src/materials/Material.js

@@ -194,8 +194,8 @@ class Material extends EventDispatcher {
 		 *
 		 * This property has only an effect when using custom blending with `ConstantAlpha` or `OneMinusConstantAlpha`.
 		 *
-		 * @type {Color}
-		 * @default (0,0,0)
+		 * @type {number}
+		 * @default 0
 		 */
 		this.blendAlpha = 0;
 

src/nodes/core/ArrayNode.js

@@ -58,6 +58,12 @@ class ArrayNode extends TempNode {
 
 	}
 
+	/**
+	 * Returns the node's type.
+	 *
+	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {string} The type of the node.
+	 */
 	getNodeType( builder ) {
 
 		if ( this.nodeType === null ) {
@@ -70,12 +76,24 @@ class ArrayNode extends TempNode {
 
 	}
 
+	/**
+	 * Returns the node's type.
+	 *
+	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {string} The type of the node.
+	 */
 	getElementType( builder ) {
 
 		return this.getNodeType( builder );
 
 	}
 
+	/**
+	 * This method builds the output node and returns the resulting array as a shader string.
+	 *
+	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {string} The generated shader string.
+	 */
 	generate( builder ) {
 
 		const type = this.getNodeType( builder );

src/nodes/core/UniformNode.js

@@ -162,7 +162,7 @@ export default UniformNode;
  * @tsl
  * @function
  * @param {any} arg1 - The value of this node. Usually a JS primitive or three.js object (vector, matrix, color, texture).
- * @param {?string} arg2 - The node type. If no explicit type is defined, the node tries to derive the type from its value.
+ * @param {string} [arg2] - The node type. If no explicit type is defined, the node tries to derive the type from its value.
  * @returns {UniformNode}
  */
 export const uniform = ( arg1, arg2 ) => {

src/nodes/display/PassNode.js

@@ -654,7 +654,18 @@ class PassNode extends TempNode {
 
 }
 
+/**
+ * @static
+ * @type {'color'}
+ * @default 'color'
+ */
 PassNode.COLOR = 'color';
+
+/**
+ * @static
+ * @type {'depth'}
+ * @default 'depth'
+ */
 PassNode.DEPTH = 'depth';
 
 export default PassNode;

src/nodes/gpgpu/ComputeBuiltinNode.js

@@ -91,10 +91,11 @@ class ComputeBuiltinNode extends Node {
 	 * Whether the current node builder has the builtin or not.
 	 *
 	 * @param {NodeBuilder} builder - The current node builder.
+	 * @return {boolean} Whether the builder has the builtin or not.
 	 */
 	hasBuiltin( builder ) {
 
-		builder.hasBuiltin( this._builtinName );
+		return builder.hasBuiltin( this._builtinName );
 
 	}
 

src/nodes/pmrem/PMREMNode.js

@@ -37,7 +37,7 @@ function _generateCubeUVSize( imageHeight ) {
  * @param {Texture} texture - The texture to create the PMREM for.
  * @param {Renderer} renderer - The renderer.
  * @param {PMREMGenerator} generator - The PMREM generator.
- * @return {Texture} The PMREM.
+ * @return {?Texture} The PMREM.
  */
 function _getPMREMFromTexture( texture, renderer, generator ) {
 
@@ -177,7 +177,7 @@ class PMREMNode extends TempNode {
 		 * Reference to a PMREM generator.
 		 *
 		 * @private
-		 * @type {PMREMGenerator}
+		 * @type {?PMREMGenerator}
 		 * @default null
 		 */
 		this._generator = null;

src/renderers/webgpu/nodes/WGSLNodeBuilder.js

@@ -793,7 +793,7 @@ class WGSLNodeBuilder extends NodeBuilder {
 	 * Returns the native shader operator name for a given generic name.
 	 *
 	 * @param {string} op - The operator name to resolve.
-	 * @return {string} The resolved operator name.
+	 * @return {?string} The resolved operator name.
 	 */
 	getFunctionOperator( op ) {
 
@@ -985,7 +985,7 @@ class WGSLNodeBuilder extends NodeBuilder {
 	 *
 	 * @param {string} name - The builtin name.
 	 * @param {string} [shaderStage=this.shaderStage] - The shader stage this code snippet is generated for.
-	 * @return {string} Whether the given builtin is defined in the given shader stage or not.
+	 * @return {boolean} Whether the given builtin is defined in the given shader stage or not.
 	 */
 	hasBuiltin( name, shaderStage = this.shaderStage ) {
 
@@ -1847,7 +1847,7 @@ ${ flowData.code }
 	 * Returns the native shader method name for a given generic name.
 	 *
 	 * @param {string} method - The method name to resolve.
-	 * @param {string} [output=null] - An optional output.
+	 * @param {?string} [output=null] - An optional output.
 	 * @return {string} The resolved WGSL method name.
 	 */
 	getMethod( method, output = null ) {

src/renderers/webgpu/utils/WebGPUAttributeUtils.js

@@ -357,7 +357,7 @@ class WebGPUAttributeUtils {
 	 *
 	 * @private
 	 * @param {BufferAttribute} geometryAttribute - The buffer attribute.
-	 * @return {string} The vertex format (e.g. 'float32x3').
+	 * @return {string|undefined} The vertex format (e.g. 'float32x3').
 	 */
 	_getVertexFormat( geometryAttribute ) {
 

src/textures/Texture.js

@@ -30,7 +30,7 @@ class Texture extends EventDispatcher {
 	/**
 	 * Constructs a new texture.
 	 *
-	 * @param {Object} [image=Texture.DEFAULT_IMAGE] - The image holding the texture data.
+	 * @param {?Object} [image=Texture.DEFAULT_IMAGE] - The image holding the texture data.
 	 * @param {number} [mapping=Texture.DEFAULT_MAPPING] - The texture mapping.
 	 * @param {number} [wrapS=ClampToEdgeWrapping] - The wrapS value.
 	 * @param {number} [wrapT=ClampToEdgeWrapping] - The wrapT value.
@@ -352,7 +352,7 @@ class Texture extends EventDispatcher {
 	/**
 	 * The image object holding the texture data.
 	 *
-	 * @type {Object}
+	 * @type {?Object}
 	 */
 	get image() {