Initial comment conversion to TSDoc

[poolifier.git] / src / pools / cluster / dynamic.ts

diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts
index a90e586039c6a2cc5f841618a0223aa0675983be..8b8c5185772dbea59bc0d22b2e1cb90b9383d507 100644 (file)
--- a/src/pools/cluster/dynamic.ts
+++ b/src/pools/cluster/dynamic.ts
@@ -8,8 +8,8 @@ import { FixedClusterPool } from './fixed'
  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
  * When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  *
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -20,10 +20,10 @@ export class DynamicClusterPool<
   /**
    * Constructs a new poolifier dynamic cluster pool.
    *
-   * @param min Minimum number of workers which are always active.
-   * @param max Maximum number of workers that can be created by this pool.
-   * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
-   * @param opts Options for this dynamic cluster pool.
+   * @param min - Minimum number of workers which are always active.
+   * @param max - Maximum number of workers that can be created by this pool.
+   * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic cluster pool.
    */
   public constructor (
     min: number,
@@ -34,12 +34,12 @@ export class DynamicClusterPool<
     super(min, filePath, opts)
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public get type (): PoolType {
     return PoolType.DYNAMIC
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public get busy (): boolean {
     return this.workers.length === this.max
   }