From 1eecdec2d96ac54a3da55e4e99dfd7a7c672728f Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Fri, 22 Apr 2022 18:42:47 +0100 Subject: [PATCH] Update JSDoc for better clarity Co-authored-by: Nelson Chan Signed-off-by: Matthew Nickson --- server/jobs/util-worker.js | 4 +++- server/model/monitor.js | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/server/jobs/util-worker.js b/server/jobs/util-worker.js index 89629a2fa..1aeec794d 100644 --- a/server/jobs/util-worker.js +++ b/server/jobs/util-worker.js @@ -3,7 +3,9 @@ const Database = require("../database"); const path = require("path"); /** - * Send message to parent process + * Send message to parent process for logging + * since worker_thread does not have access to stdout, this is used + * instead of console.log() * @param {any} any The message to log */ const log = function (any) { diff --git a/server/model/monitor.js b/server/model/monitor.js index b97e424d1..60c984f31 100644 --- a/server/model/monitor.js +++ b/server/model/monitor.js @@ -145,7 +145,7 @@ class Monitor extends BeanModel { } /** - * Get status codes that are acceptable + * Get accepted status codes * @returns {Object} */ getAcceptedStatuscodes() { @@ -658,7 +658,7 @@ class Monitor extends BeanModel { } /** - * Send certificate information to information + * Send certificate information to client * @param {Server} io Socket server instance * @param {number} monitorID ID of monitor to send * @param {number} userID ID of user to send to