Initial comment conversion to TSDoc

[poolifier.git] / src / worker / cluster-worker.ts

diff --git a/src/worker/cluster-worker.ts b/src/worker/cluster-worker.ts
index 19bfa4e56fda61d46e3d22b47953b567af7cd947..4f5fbb6b2ea87dcb54227b6b06576d80dba9c849 100644 (file)
--- a/src/worker/cluster-worker.ts
+++ b/src/worker/cluster-worker.ts
@@ -13,8 +13,8 @@ import type { WorkerOptions } from './worker-options'
  * If you use a `DynamicClusterPool` the extra workers that were created will be terminated,
  * but the minimum number of workers will be guaranteed.
  *
- * @template Data Type of data this worker receives from pool's execution. This can only be serializable data.
- * @template Response Type of response the worker sends back to the main worker. This can only be serializable data.
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
+ * @typeParam Response - Type of response the worker sends back to the main worker. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -25,8 +25,8 @@ export class ClusterWorker<
   /**
    * Constructs a new poolifier cluster worker.
    *
-   * @param fn Function processed by the worker when the pool's `execution` function is invoked.
-   * @param opts Options for the worker.
+   * @param fn - Function processed by the worker when the pool's `execution` function is invoked.
+   * @param opts - Options for the worker.
    */
   public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
     super(
@@ -38,12 +38,12 @@ export class ClusterWorker<
     )
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   protected sendToMainWorker (message: MessageValue<Response>): void {
     this.getMainWorker().send(message)
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   protected handleError (e: Error | string): string {
     return e instanceof Error ? e.message : e
   }