Initial comment conversion to TSDoc

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

diff --git a/src/worker/thread-worker.ts b/src/worker/thread-worker.ts
index 20141e441c93e71adb901f5d13fb8fa0f0288957..a8424fbf0151e0ffa59674b4a5575fe604b5543e 100644 (file)
--- a/src/worker/thread-worker.ts
+++ b/src/worker/thread-worker.ts
@@ -13,8 +13,8 @@ import type { WorkerOptions } from './worker-options'
  * If you use a `DynamicThreadPool` 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 thread. 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 thread. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -25,14 +25,14 @@ export class ThreadWorker<
   /**
    * Constructs a new poolifier thread 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('worker-thread-pool:poolifier', isMainThread, fn, parentPort, opts)
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   protected sendToMainWorker (message: MessageValue<Response>): void {
     this.getMainWorker().postMessage(message)
   }