Node: Document more modules. (#30012)

* Node: Document more modules. * Docs: Fix typo.
mrdoob · Dec 2, 2024 · b2320be · b2320be
1 parent 480c414
commit b2320be
Show file tree

Hide file tree

Showing 6 changed files with 450 additions and 11 deletions.
diff --git a/src/nodes/core/Node.js b/src/nodes/core/Node.js
@@ -98,7 +98,22 @@ class Node extends EventDispatcher {
 
 		// private
 
+		/**
+		 * The cache key of this node.
+		 *
+		 * @private
+		 * @type {Number?}
+		 * @default null
+		 */
 		this._cacheKey = null;
+
+		/**
+		 * The cache key 's version.
+		 *
+		 * @private
+		 * @type {Number}
+		 * @default 0
+		 */
 		this._cacheKeyVersion = 0;
 
 		Object.defineProperty( this, 'id', { value: _nodeId ++ } );
@@ -244,9 +259,10 @@ class Node extends EventDispatcher {
 	}
 
 	/**
-	 * Returns a generator that can be used to iterate over the child nodes.
+	 * Generator function that can be used to iterate over the child nodes.
 	 *
-	 * @return {Generator} The generator.
+	 * @generator
+	 * @yields {Node} A child node.
 	 */
 	* getChildren() {