Fix docs

Author: vanruesc

src/effects/LensDistortionEffect.ts

@@ -49,6 +49,8 @@ export interface LensDistortionEffectOptions {
  * A lens distortion effect.
  *
  * Original shader ported from https://github.com/ycw/three-lens-distortion
+ *
+ * @category Effects
  */
 
 export class LensDistortionEffect extends Effect implements LensDistortionEffectOptions {

src/utils/DebugTools.ts

@@ -241,29 +241,39 @@ function analyzeOutputResources(passes: readonly Pass<Material | null>[],
 }
 
 /**
- * Logs details about a given render pipeline.
+ * A collection of debug tools.
  *
- * @param pipeline - A render pipeline.
+ * @category Utils
  */
 
-export function analyzePipeline(pipeline: RenderPipeline): void {
+export class DebugTools {
+
+	/**
+	 * Logs details about a given render pipeline.
+	 *
+	 * @param pipeline - A render pipeline.
+	 */
 
-	const textureIds = createTextureIds(pipeline.passes);
+	static analyzePipeline(pipeline: RenderPipeline): void {
 
-	console.debug("RenderPipeline", pipeline);
+		const textureIds = createTextureIds(pipeline.passes);
 
-	console.groupCollapsed("Data Flow");
-	analyzeDataFlow(pipeline.passes, textureIds);
-	console.groupEnd();
+		console.debug("RenderPipeline", pipeline);
 
-	console.groupCollapsed("Resources");
-	console.group("Input Buffers");
-	analyzeInputResources(pipeline.passes, textureIds);
-	console.groupEnd();
-	console.group("Output Buffers");
-	analyzeOutputResources(pipeline.passes, textureIds);
-	console.groupEnd();
+		console.groupCollapsed("Data Flow");
+		analyzeDataFlow(pipeline.passes, textureIds);
+		console.groupEnd();
 
-	console.groupEnd();
+		console.groupCollapsed("Resources");
+		console.group("Input Buffers");
+		analyzeInputResources(pipeline.passes, textureIds);
+		console.groupEnd();
+		console.group("Output Buffers");
+		analyzeOutputResources(pipeline.passes, textureIds);
+		console.groupEnd();
+
+		console.groupEnd();
+
+	}
 
 }

src/utils/ImmutableTimer.ts

@@ -8,16 +8,16 @@ export interface ImmutableTimer {
 
 	/**
 	 * Returns the current delta time in seconds.
-	 +
-	 + @return The current delta time.
+	 *
+	 * @return The current delta time.
 	 */
 
 	getDelta(): number;
 
 	/**
 	 * Returns the elapsed time in seconds.
-	 +
-	 + @return The elapsed time.
+	 *
+	 * @return The elapsed time.
 	 */
 
 	getElapsed(): number;

src/utils/index.ts

@@ -5,6 +5,7 @@ export * from "./Background.js";
 export * from "./ClearFlags.js";
 export * from "./ClearValues.js";
 export * from "./ColorDecisionList.js";
+export * from "./DebugTools.js";
 export * from "./EffectMaterialManager.js";
 export * from "./EffectShaderData.js";
 export * from "./GaussKernel.js";
@@ -17,5 +18,3 @@ export * from "./Scissor.js";
 export * from "./Selection.js";
 export * from "./ShaderDataTracker.js";
 export * from "./Viewport.js";
-
-export * as DebugTools from "./DebugTools.js";