Minor formatting for JSDoc comments

Added a number of minor formatting changes to JSDoc comments in /src
This commit is contained in:
Matthew Nickson 2022-06-02 15:15:21 +01:00 committed by GitHub
parent c94dcf1533
commit 0e28707307
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 7 additions and 7 deletions

View file

@ -58,7 +58,7 @@ export default {
this.modal.show(); this.modal.show();
}, },
/** /**
* @emits "yes" - Notify the parent when Yes is pressed * @emits string "yes" Notify the parent when Yes is pressed
*/ */
yes() { yes() {
this.$emit("yes"); this.$emit("yes");

View file

@ -13,7 +13,7 @@ dayjs.extend(relativeTime);
export default { export default {
props: { props: {
/** Value of data time */ /** Value of date time */
value: { value: {
type: String, type: String,
default: null, default: null,

View file

@ -125,7 +125,7 @@ export default {
window.removeEventListener("scroll", this.onScroll); window.removeEventListener("scroll", this.onScroll);
}, },
methods: { methods: {
/** Called when the user scrolls */ /** Handle user scroll */
onScroll() { onScroll() {
if (window.top.scrollY <= 133) { if (window.top.scrollY <= 133) {
this.windowTop = window.top.scrollY; this.windowTop = window.top.scrollY;

View file

@ -29,7 +29,7 @@
<script> <script>
export default { export default {
props: { props: {
/** Heading of the Section */ /** Heading of the section */
heading: { heading: {
type: String, type: String,
default: "", default: "",

View file

@ -15,7 +15,7 @@ export default {
type: String, type: String,
default: null, default: null,
}, },
/** Is this a pill */ /** Is this a pill? */
pill: { pill: {
type: Boolean, type: Boolean,
default: false, default: false,

View file

@ -12,7 +12,7 @@ export default {
}, },
methods: { methods: {
/** Called when the screen changes size */ /** Handle screen resize */
onResize() { onResize() {
this.windowWidth = window.innerWidth; this.windowWidth = window.innerWidth;
this.updateBody(); this.updateBody();

View file

@ -120,7 +120,7 @@ export default {
/** /**
* Load the general settings page * Load the general settings page
* For desktop only, mobile do nothing * For desktop only, on mobile do nothing
*/ */
loadGeneralPage() { loadGeneralPage() {
if (!this.currentPage && !this.$root.isMobile) { if (!this.currentPage && !this.$root.isMobile) {