From 0e28707307b77fbcec8d6aa7473322f47adfe304 Mon Sep 17 00:00:00 2001
From: Matthew Nickson <mnickson@sidingsmedia.com>
Date: Thu, 2 Jun 2022 15:15:21 +0100
Subject: [PATCH] Minor formatting for JSDoc comments

Added a number of minor formatting changes to JSDoc comments in /src
---
 src/components/Confirm.vue       | 2 +-
 src/components/Datetime.vue      | 2 +-
 src/components/MonitorList.vue   | 2 +-
 src/components/ToggleSection.vue | 2 +-
 src/components/Uptime.vue        | 2 +-
 src/mixins/mobile.js             | 2 +-
 src/pages/Settings.vue           | 2 +-
 7 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/components/Confirm.vue b/src/components/Confirm.vue
index 258724a39..1a1addc6e 100644
--- a/src/components/Confirm.vue
+++ b/src/components/Confirm.vue
@@ -58,7 +58,7 @@ export default {
             this.modal.show();
         },
         /**
-         * @emits "yes" - Notify the parent when Yes is pressed
+         * @emits string "yes" Notify the parent when Yes is pressed
          */
         yes() {
             this.$emit("yes");
diff --git a/src/components/Datetime.vue b/src/components/Datetime.vue
index 3c66f5d6e..b24ab0b3c 100644
--- a/src/components/Datetime.vue
+++ b/src/components/Datetime.vue
@@ -13,7 +13,7 @@ dayjs.extend(relativeTime);
 
 export default {
     props: {
-        /** Value of data time */
+        /** Value of date time */
         value: {
             type: String,
             default: null,
diff --git a/src/components/MonitorList.vue b/src/components/MonitorList.vue
index 1d48af710..1ae12b2ff 100644
--- a/src/components/MonitorList.vue
+++ b/src/components/MonitorList.vue
@@ -125,7 +125,7 @@ export default {
         window.removeEventListener("scroll", this.onScroll);
     },
     methods: {
-        /** Called when the user scrolls */
+        /** Handle user scroll */
         onScroll() {
             if (window.top.scrollY <= 133) {
                 this.windowTop = window.top.scrollY;
diff --git a/src/components/ToggleSection.vue b/src/components/ToggleSection.vue
index 47dc21905..a2f7c9dae 100644
--- a/src/components/ToggleSection.vue
+++ b/src/components/ToggleSection.vue
@@ -29,7 +29,7 @@
 <script>
 export default {
     props: {
-        /** Heading of the Section */
+        /** Heading of the section */
         heading: {
             type: String,
             default: "",
diff --git a/src/components/Uptime.vue b/src/components/Uptime.vue
index 8793b7a7b..8f7eba80c 100644
--- a/src/components/Uptime.vue
+++ b/src/components/Uptime.vue
@@ -15,7 +15,7 @@ export default {
             type: String,
             default: null,
         },
-        /** Is this a pill */
+        /** Is this a pill? */
         pill: {
             type: Boolean,
             default: false,
diff --git a/src/mixins/mobile.js b/src/mixins/mobile.js
index ffc50f50c..32ee209fc 100644
--- a/src/mixins/mobile.js
+++ b/src/mixins/mobile.js
@@ -12,7 +12,7 @@ export default {
     },
 
     methods: {
-        /** Called when the screen changes size */
+        /** Handle screen resize */
         onResize() {
             this.windowWidth = window.innerWidth;
             this.updateBody();
diff --git a/src/pages/Settings.vue b/src/pages/Settings.vue
index c118226c9..f8effb4ad 100644
--- a/src/pages/Settings.vue
+++ b/src/pages/Settings.vue
@@ -120,7 +120,7 @@ export default {
 
         /**
          * Load the general settings page
-         * For desktop only, mobile do nothing
+         * For desktop only, on mobile do nothing
          */
         loadGeneralPage() {
             if (!this.currentPage && !this.$root.isMobile) {