Skip to content

Commit

Permalink
Fix JSDoc lint warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Raimund Schlüßler <raimund.schluessler@mailbox.org>
  • Loading branch information
raimund-schluessler committed Mar 1, 2023
1 parent 9d82207 commit bfae031
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ if (!window._vue_richtext_custom_picker_elements) {
class NcCustomPickerRenderResult {

/**
* @param {HTMLElement} element
* @param {object} object
* @param {HTMLElement} element The HTML element
* @param {object} object The object
*/
constructor(element, object) {
this.element = element
Expand Down
4 changes: 2 additions & 2 deletions src/components/NcRichText/NcReferencePicker/providerHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export function sortProviders(providerList) {
* Helper function to search a provider from a search query
* Result is a sorted list of providers
*
* @param {string} query
* @param {string} query The search query
* @param {number} limit (optional) max number of results
* @return {Array} the sorted/filtered provider list
*/
Expand All @@ -109,7 +109,7 @@ export function searchProvider(query, limit = null) {
/**
* Update the "last used timestamp" on the server side and then locally in the frontend
*
* @param providerId
* @param {number} providerId The id of the search provider
*/
export function touchProvider(providerId) {
const timestamp = Math.floor(Date.now() / 1000)
Expand Down
6 changes: 3 additions & 3 deletions src/components/NcRichText/NcReferencePicker/utils.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
let mytimer = 0
/**
*
* @param callback
* @param ms
* @param {Function} callback The callback to call after the delay
* @param {number} ms The delay in milli-seconds
*/
export function delay(callback, ms) {
return function() {
Expand All @@ -16,7 +16,7 @@ export function delay(callback, ms) {
}
/**
*
* @param str
* @param {string} str The url
*/
export function isUrl(str) {
try {
Expand Down
6 changes: 3 additions & 3 deletions src/components/NcRichText/placeholder.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ export const remarkPlaceholder = function() {

/**
*
* @param node
* @param index
* @param parent
* @param {object} node The node
* @param {number} index The index of the node
* @param {object} parent The parent node
*/
function visitor(node, index, parent) {
const placeholders = node.value.split(/(\{[a-z\-_.0-9]+\})/ig)
Expand Down
6 changes: 3 additions & 3 deletions src/components/NcRichText/remarkDisableBlocks.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ const throwing = (msg) =>

/**
*
* @param root0
* @param root0.block
* @param root0.inline
* @param {object} root0 The object to destructure
* @param {Array} root0.block The array containing blocks
* @param {Array} root0.inline The array containline inline
*/
function ignore({ block = [], inline = [] } = {}) {
if (block.length) {
Expand Down

0 comments on commit bfae031

Please sign in to comment.