From 5cff54e52d3ebcb375429867fa5bd914db971b9e Mon Sep 17 00:00:00 2001
From: Eddie Fiorentine <eddie@planet.net>
Date: Tue, 19 Nov 2024 19:52:37 -0500
Subject: [PATCH] fix: cleanup JSdocs

---
 server/monitor-types/sip-options.js | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/server/monitor-types/sip-options.js b/server/monitor-types/sip-options.js
index 99b75e415..1ca60ad22 100644
--- a/server/monitor-types/sip-options.js
+++ b/server/monitor-types/sip-options.js
@@ -12,6 +12,7 @@ class SIPMonitorType extends MonitorType {
      * @param {Heartbeat} heartbeat Monitor heartbeat to update
      * @param {UptimeKumaServer} server Uptime Kuma server
      * @returns {Promise<void>}
+     * @throws Will throw an error if the command execution encounters any error.
      */
     async check(monitor, heartbeat, _server) {
         try {
@@ -25,6 +26,7 @@ class SIPMonitorType extends MonitorType {
     /**
      * Runs Sipsak options ping
      * @param {string} hostname SIP server address to send options.
+     * @param {number} port SIP server port
      * @param {number} timeout timeout of options reply
      * @returns {Promise<string>} A Promise that resolves to the output of the Sipsak options ping
      * @throws Will throw an error if the command execution encounters any error.
@@ -41,6 +43,12 @@ class SIPMonitorType extends MonitorType {
         }
     }
 
+    /**
+     * 
+     * @param {string} res 
+     * @param {object} heartbeat
+     * @returns {void} 
+     */
     parseSipsakResponse(res, heartbeat){
         let lines = res.split("\n");
         for (let line of lines){