Fix jsdoc for some emitted events

susnux · susnux · commit 95fde50636e8 · 2022-12-04T13:57:56.000+01:00
Signed-off-by: Ferdinand Thiessen &lt;rpm@fthiessen.de&gt;
diff --git a/src/components/NcBreadcrumb/NcBreadcrumb.vue b/src/components/NcBreadcrumb/NcBreadcrumb.vue
@@ -191,8 +191,8 @@ export default {
 			}
 			/**
 			 * Event emitted when something is dropped on the breadcrumb.
-			 *
-			 * @type {null}
+			 * @param {Event} event The DOM drop event
+			 * @param {[String, Object]} to The `to` prop or, if not set, the `href` prop
 			 */
 			this.$emit('dropped', e, this.to || this.href)
 			this.$parent.$emit('dropped', e, this.to || this.href)
diff --git a/src/components/NcBreadcrumbs/NcBreadcrumbs.vue b/src/components/NcBreadcrumbs/NcBreadcrumbs.vue
@@ -374,7 +374,8 @@ export default {
 				/**
 				 * Event emitted when something is dropped on the breadcrumb.
 				 *
-				 * @type {null}
+				 * @param {Event} e the drop DOM event
+				 * @param {string} path The path of the breadcrumb
 				 */
 				this.$emit('dropped', e, path)
 			}
diff --git a/src/components/NcListItem/NcListItem.vue b/src/components/NcListItem/NcListItem.vue
@@ -352,7 +352,7 @@ export default {
 		},
 
 		/**
-		 * Id for the <a> element
+		 * Id for the `<a>` element
 		 */
 		anchorId: {
 			type: String,

Original file line number	Diff line number	Diff line change
`@@ -374,7 +374,8 @@ export default {`
`374`	`374`	`/**`
`375`	`375`	`* Event emitted when something is dropped on the breadcrumb.`
`376`	`376`	`*`
`377`		`- * @type {null}`
	`377`	`+ * @param {Event} e the drop DOM event`
	`378`	`+ * @param {string} path The path of the breadcrumb`
`378`	`379`	`*/`
`379`	`380`	`this.$emit('dropped', e, path)`
`380`	`381`	`}`