Skip to content

Commit 0274c78

Browse files
committed
Fix jsdoc: Add missing documentation for events
Signed-off-by: Ferdinand Thiessen <rpm@fthiessen.de>
1 parent 7bd8617 commit 0274c78

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

src/components/NcBreadcrumb/NcBreadcrumb.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@ export default {
191191
}
192192
/**
193193
* Event emitted when something is dropped on the breadcrumb.
194-
*
195-
* @type {null}
194+
* @param {Event} event The DOM drop event
195+
* @param {(string|object)} to The `to` prop or, if not set, the `href` prop
196196
*/
197197
this.$emit('dropped', e, this.to || this.href)
198198
this.$parent.$emit('dropped', e, this.to || this.href)

src/components/NcBreadcrumbs/NcBreadcrumbs.vue

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,8 @@ export default {
374374
/**
375375
* Event emitted when something is dropped on the breadcrumb.
376376
*
377-
* @type {null}
377+
* @param {Event} e the drop DOM event
378+
* @param {string} path The path of the breadcrumb
378379
*/
379380
this.$emit('dropped', e, path)
380381
}

src/components/NcListItem/NcListItem.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ export default {
352352
},
353353
354354
/**
355-
* Id for the <a> element
355+
* Id for the `<a>` element
356356
*/
357357
anchorId: {
358358
type: String,

0 commit comments

Comments
 (0)