Fixed typos + improved clarity and detail of some JSDoc

Apply suggestions from code review

Co-authored-by: Nelson Chan <chakflying@hotmail.com>
This commit is contained in:
Matthew Nickson 2022-06-02 16:40:56 +01:00 committed by GitHub
parent 0e28707307
commit a927f5cd15
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions

View file

@ -130,7 +130,7 @@ export default {
}, },
methods: { methods: {
/** Show dialog to confirm delection */ /** Show dialog to confirm deletion */
deleteConfirm() { deleteConfirm() {
this.modal.hide(); this.modal.hide();
this.$refs.confirmDelete.show(); this.$refs.confirmDelete.show();

View file

@ -271,9 +271,9 @@ export default {
}, },
/** /**
* Get colour of text inside the tag * Get colour of text inside the tag
* @param {Object} option Object representing color choice. If * @param {Object} option The tag that needs to be displayed.
* option.color is set, the text color will be white, else it * Defaults to "white" unless the tag has no color, which will
* be chosen based upon application theme * then return the body color (based on application theme)
* @returns string * @returns string
*/ */
textColor(option) { textColor(option) {

View file

@ -18,7 +18,7 @@ export default {
this.updateBody(); this.updateBody();
}, },
/** Update the document body */ /** Add css-class "mobile" to body if needed */
updateBody() { updateBody() {
if (this.isMobile) { if (this.isMobile) {
document.body.classList.add("mobile"); document.body.classList.add("mobile");

View file

@ -314,9 +314,9 @@ export function getCryptoRandomInt(min: number, max: number):number {
} }
/** /**
* Generate a secret * Generate a random alphanumeric string of fixed length
* @param length Lenght of secret to generate * @param length Length of string to generate
* @returns * @returns string
*/ */
export function genSecret(length = 64) { export function genSecret(length = 64) {
let secret = ""; let secret = "";