Docs: Improve SceneUtils page. (#944)

three-types · May 17, 2024 · 07d82a0 · 07d82a0
1 parent 19b8df3
commit 07d82a0
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/types/three/examples/jsm/utils/SceneUtils.d.ts b/types/three/examples/jsm/utils/SceneUtils.d.ts
@@ -33,19 +33,25 @@ export function reduceVertices<TValue>(
 ): TValue;
 
 /**
- * @param object Object to traverse.
+ * A generator based version of {@link Object3D.traverse}.
+ *
+ * @param object The 3D object to traverse.
  * @yields Objects that passed the filter condition.
  */
 export function traverseGenerator(object: Object3D): Generator<Object3D, void, unknown>;
 
 /**
- * @param object Object to traverse.
+ * A generator based version of {@link Object3D.traverseVisible}.
+ *
+ * @param object The 3D object to traverse.
  * @yields Objects that passed the filter condition.
  */
 export function traverseVisibleGenerator(object: Object3D): Generator<Object3D, void, unknown>;
 
 /**
- * @param object Object to traverse.
+ * A generator based version of {@link Object3D.traverseAncestors}.
+ *
+ * @param object The 3D object to traverse.
  * @yields Objects that passed the filter condition.
  */
 export function traverseAncestorsGenerator(object: Object3D): Generator<Object3D, void, unknown>;