From 94059f24a4d634cb36cbd299bd5e69ccec8e33a7 Mon Sep 17 00:00:00 2001
From: Volker Schukai <volker.schukai@schukai.com>
Date: Tue, 8 Oct 2024 11:26:31 +0200
Subject: [PATCH] doc: clean the fire definitions
---
source/components/datatable/datatable.mjs | 12 ++++-----
source/components/form/action-button.mjs | 2 +-
source/components/form/button-bar.mjs | 2 +-
source/components/form/field-set.mjs | 2 +-
source/components/form/reload.mjs | 25 +++----------------
source/components/form/template.mjs | 6 ++---
source/components/host/overlay.mjs | 16 ++++++------
source/components/layout/collapse.mjs | 15 +++++------
source/components/layout/split-panel.mjs | 2 +-
source/components/layout/tabs.mjs | 7 +-----
source/components/notify/message.mjs | 1 -
.../tree-menu/dragable-tree-menu.mjs | 4 +--
12 files changed, 36 insertions(+), 58 deletions(-)
diff --git a/source/components/datatable/datatable.mjs b/source/components/datatable/datatable.mjs
index ad165fae3..6a1b1fc3e 100644
--- a/source/components/datatable/datatable.mjs
+++ b/source/components/datatable/datatable.mjs
@@ -139,9 +139,9 @@ const columnBarElementSymbol = Symbol("columnBarElement");
* @copyright schukai GmbH
* @memberOf Monster.Components.Datatable
* @summary A data table
- * @fire Monster.Components.Datatable.event:monster-datatable-row-copied
- * @fire Monster.Components.Datatable.event:monster-datatable-row-removed
- * @fire Monster.Components.Datatable.event:monster-datatable-row-added
+ * @fires monster-datatable-row-copied
+ * @fires monster-datatable-row-removed
+ * @fires monster-datatable-row-added
*/
class DataTable extends CustomElement {
/**
@@ -359,7 +359,7 @@ class DataTable extends CustomElement {
* @param {number} fromIndex
* @param {number} toIndex
* @returns {Monster.Components.Datatable.DataTable}
- * @fire Monster.Components.Datatable.event:monster-datatable-row-copied
+ * @fires monster-datatable-row-copied
*/
copyRow(fromIndex, toIndex) {
const datasource = this[datasourceLinkedElementSymbol];
@@ -413,7 +413,7 @@ class DataTable extends CustomElement {
* Remove a row from the datatable
* @param index
* @returns {Monster.Components.Datatable.DataTable}
- * @fire Monster.Components.Datatable.event:monster-datatable-row-removed
+ * @fires monster-datatable-row-removed
*/
removeRow(index) {
const datasource = this[datasourceLinkedElementSymbol];
@@ -459,7 +459,7 @@ class DataTable extends CustomElement {
* Add a row to the datatable
* @param {Object} data
* @returns {Monster.Components.Datatable.DataTable}
- * @fire Monster.Components.Datatable.event:monster-datatable-row-added
+ * @fires monster-datatable-row-added
**/
addRow(data) {
const datasource = this[datasourceLinkedElementSymbol];
diff --git a/source/components/form/action-button.mjs b/source/components/form/action-button.mjs
index f312d5621..d40efe53a 100644
--- a/source/components/form/action-button.mjs
+++ b/source/components/form/action-button.mjs
@@ -130,7 +130,7 @@ class ActionButton extends PopperButton {
/**
*
* @return {Monster.Components.Form.Popper}
- * @event monster-action-button-show-dialog
+ * @fires monster-action-button-show-dialog
*/
showDialog() {
if (this.getOption("buttons").length === 0) {
diff --git a/source/components/form/button-bar.mjs b/source/components/form/button-bar.mjs
index d8e3b5d74..a60675d07 100644
--- a/source/components/form/button-bar.mjs
+++ b/source/components/form/button-bar.mjs
@@ -155,7 +155,7 @@ const ATTRIBUTE_POPPER_POSITION = "data-monster-popper-position";
* @copyright schukai GmbH
* @memberOf Monster.Components.Form
* @summary A configurable tab control
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
*/
/**
diff --git a/source/components/form/field-set.mjs b/source/components/form/field-set.mjs
index 67066e61e..265c5ee57 100644
--- a/source/components/form/field-set.mjs
+++ b/source/components/form/field-set.mjs
@@ -275,7 +275,7 @@ function updateColumns() {
/**
* @private
* @return {initEventHandler}
- * @fires event:monster-field-set-clicked
+ * @fires monster-field-set-clicked
*/
function initEventHandler() {
this[toggleSwitchElementSymbol].setOption(
diff --git a/source/components/form/reload.mjs b/source/components/form/reload.mjs
index c41b999f6..8df27679f 100644
--- a/source/components/form/reload.mjs
+++ b/source/components/form/reload.mjs
@@ -91,23 +91,6 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
* </monster-reload>
* ```
*
- * @startuml reload.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- CustomControl
- * CustomControl <|-- Reload
- * @enduml
- *
- * @copyright schukai GmbH
- * @memberOf Monster.Components.Form
- * @summary A reload control
- * @fires Monster.Components.event:m
- */
-
-/**
- * A reload control.
- *
* @fragments /fragments/components/form/reload/
*
* @example /examples/components/form/reload-simple
@@ -115,7 +98,7 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
* @since 1.13.0
* @copyright schukai GmbH
* @summary A beautiful reload control
- * @fires onster-fetched
+ * @fires monster-fetched
*/
class Reload extends CustomElement {
/**
@@ -208,7 +191,7 @@ class Reload extends CustomElement {
* @throws {Error} request failed
* @throws {Error} not found
* @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
* @return {Monster.Components.Form.Form}
*/
[assembleMethodSymbol]() {
@@ -277,7 +260,7 @@ function initOptionsFromArguments() {
* @throws {Error} request failed
* @throws {Error} not found
* @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
*/
function initIntersectionObserver() {
if (this[intersectionObserverWasInitialized] === true) {
@@ -326,7 +309,7 @@ function initIntersectionObserver() {
* @throws {Error} undefined status or type
* @throws {TypeError} value is not an instance of
* @throws {TypeError} value is not a string
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
* @return {Promise}
*/
function loadContent() {
diff --git a/source/components/form/template.mjs b/source/components/form/template.mjs
index 74e81fea7..7724ab5b6 100644
--- a/source/components/form/template.mjs
+++ b/source/components/form/template.mjs
@@ -138,7 +138,7 @@ class Template extends CustomElement {
* @throws {Error} request failed
* @throws {Error} not found
* @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
* @return {Monster.Components.Form.Form}
*/
[assembleMethodSymbol]() {
@@ -224,7 +224,7 @@ function initOptionsFromArguments() {
* @throws {Error} request failed
* @throws {Error} not found
* @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
*/
function initIntersectionObserver() {
if (this[intersectionObserverWasInitialized] === true) {
@@ -270,7 +270,7 @@ function initIntersectionObserver() {
* @throws {Error} undefined status or type
* @throws {TypeError} value is not an instance of
* @throws {TypeError} value is not a string
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
*/
function loadContent() {
if (!this.shadowRoot) {
diff --git a/source/components/host/overlay.mjs b/source/components/host/overlay.mjs
index a1859191a..c2f0ee1b0 100644
--- a/source/components/host/overlay.mjs
+++ b/source/components/host/overlay.mjs
@@ -104,10 +104,10 @@ const ATTRIBUTE_VALUE_OVERLAY_OPEN = "overlay-open";
* @copyright schukai GmbH
* @memberOf Monster.Components.Host
* @summary A simple overlay component
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-closed
+ * @fires monster-overlay-before-open
+ * @fires monster-overlay-open
+ * @fires monster-overlay-before-close
+ * @fires monster-overlay-closed
*/
class Overlay extends CustomElement {
/**
@@ -206,10 +206,10 @@ class Overlay extends CustomElement {
/**
* @returns {Monster.Components.Host.Overlay}
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-closed
+ * @fires monster-overlay-before-open
+ * @fires monster-overlay-open
+ * @fires monster-overlay-before-close
+ * @fires monster-overlay-closed
*/
open() {
fireCustomEvent(this, "monster-overlay-before-open", {});
diff --git a/source/components/layout/collapse.mjs b/source/components/layout/collapse.mjs
index 701508b1f..b95117582 100644
--- a/source/components/layout/collapse.mjs
+++ b/source/components/layout/collapse.mjs
@@ -201,8 +201,8 @@ class Collapse extends CustomElement {
/**
* Open the collapse
* @returns {Collapse}
- * @fires monster-collapse-before-open
- * @fires monster-collapse-open
+ * @fires monster-collapse-before-open This event is fired before the collapse is opened.
+ * @fires monster-collapse-open This event is fired after the collapse is opened.
*/
open() {
let node;
@@ -245,8 +245,8 @@ class Collapse extends CustomElement {
/**
* Close the collapse
* @returns {Collapse}
- * @fires monster-collapse-before-close
- * @fires monster-collapse-closed
+ * @fires monster-collapse-before-close This event is fired before the collapse is closed.
+ * @fires monster-collapse-closed This event is fired after the collapse is closed.
*/
close() {
if (!this[detailsElementSymbol].classList.contains("active")) {
@@ -284,7 +284,7 @@ class Collapse extends CustomElement {
/**
* This method is called when the element is inserted into a document, including into a shadow tree.
* @return {Collapse}
- * @fires event:monster-collapse-adjust-height
+ * @fires monster-collapse-adjust-height This event is fired when the height is adjusted. As a detail, the height is passed.
*/
adjustHeight() {
adjustHeight.call(this);
@@ -295,7 +295,6 @@ class Collapse extends CustomElement {
/**
* @private
* @returns {void}
- * @fires event:monster-collapse-adjust-height
*/
function adjustHeight() {
let height = 0;
@@ -336,7 +335,9 @@ function adjustHeight() {
"important",
);
- fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {});
+ fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {
+ height,
+ });
}
function updateResizeObserverObservation() {
diff --git a/source/components/layout/split-panel.mjs b/source/components/layout/split-panel.mjs
index 8c8be8c48..bcf687e75 100644
--- a/source/components/layout/split-panel.mjs
+++ b/source/components/layout/split-panel.mjs
@@ -200,7 +200,7 @@ class SplitPanel extends CustomElement {
/**
* Set the dimensions of the panel based on the split type.
- * @fires Monster.Components.Layout.event:monster-dimension-changed
+ * @fires monster-dimension-changed
*/
function applyPanelDimensions() {
const splitType = this.getOption("splitType");
diff --git a/source/components/layout/tabs.mjs b/source/components/layout/tabs.mjs
index f63ff8cf3..160e0e47e 100644
--- a/source/components/layout/tabs.mjs
+++ b/source/components/layout/tabs.mjs
@@ -664,14 +664,9 @@ function initEventHandler() {
}
};
- /**
- * event:monster-tab-remove
- * @event Monster.Components.Layout.event:monster-tab-remove
- */
-
/**
* @param {Event} event
- * @fires Monster.Components.Layout.event:monster-tab-remove
+ * @fires monster-tab-remove
*/
this[removeTabEventHandler] = (event) => {
const element = findTargetElementFromEvent(
diff --git a/source/components/notify/message.mjs b/source/components/notify/message.mjs
index fd008ab31..ee09f5a0c 100644
--- a/source/components/notify/message.mjs
+++ b/source/components/notify/message.mjs
@@ -96,7 +96,6 @@ const removeEventHandlerSymbol = Symbol("removeEventHandler");
* @copyright schukai GmbH
* @memberOf Monster.Components.Notify
* @summary A highly configurable select control
- * @fires Monster.Components.Notify.event:monster-xxxx
*/
class Message extends CustomElement {
/**
diff --git a/source/components/tree-menu/dragable-tree-menu.mjs b/source/components/tree-menu/dragable-tree-menu.mjs
index a97a34597..7bce6a256 100644
--- a/source/components/tree-menu/dragable-tree-menu.mjs
+++ b/source/components/tree-menu/dragable-tree-menu.mjs
@@ -128,7 +128,7 @@
// * @copyright schukai GmbH
// * @memberOf Monster.Components.TreeMenu
// * @summary A TreeMenu control
-// * @fires Monster.Components.TreeMenu.event:monster-fetched
+// * @fires monster-fetched
// */
// class TreeMenu extends CustomElement {
// /**
@@ -613,7 +613,7 @@
// // * @throws {Error} request failed
// // * @throws {Error} not found
// // * @throws {Error} undefined status or type
-// // * @fires Monster.Components.TreeMenu.event:monster-fetched
+// // * @fires monster-fetched
// // */
// // function initIntersectionObserver() {
// // const self = this;
--
GitLab