Minor formatting for JSDoc comments

Added a number of minor formatting changes to JSDoc comments in /src
pull/1550/head
Matthew Nickson 2 years ago committed by GitHub
parent c94dcf1533
commit 0e28707307
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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");

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

@ -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;

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

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

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

@ -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) {

Loading…
Cancel
Save