From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Sun, 4 Apr 2021 19:44:12 +0000 (+0200)
Subject: Add JSDoc.
X-Git-Tag: v1.0.1-0~64
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=6f09a43f02a15d0570d67c9143ab6702bd861be2;p=e-mobility-charging-stations-simulator.git

Add JSDoc.

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/src/charging-station/StationWorker.ts b/src/charging-station/StationWorker.ts
index 20fb27ca..84cb023b 100644
--- a/src/charging-station/StationWorker.ts
+++ b/src/charging-station/StationWorker.ts
@@ -19,7 +19,7 @@ if (Utils.workerPoolInUse()) {
 }
 
 /**
- *
+ * Listen messages send by the main thread
  */
 function addMessageListener(): void {
   parentPort.on('message', (message) => {
@@ -30,7 +30,9 @@ function addMessageListener(): void {
 }
 
 /**
- * @param data
+ * Create and start a charging station instance
+ *
+ * @param {StationWorkerData} data workerData
  */
 function startChargingStation(data: StationWorkerData): void {
   const station = new ChargingStation(data.index, data.templateFile);