docs: Adapt JSDocs for new CЕM and Remove Redundancies

packages/base/src/types/CalendarType.ts

@@ -1,36 +1,27 @@
 /**
  * Different calendar types.
  *
- * @readonly
- * @enum {string}
  * @public
- * @author SAP SE
- * @alias sap.ui.webc.base.types.CalendarType
  */
 enum CalendarType {
  /**
  * @public
- * @type {Gregorian}
  */
  Gregorian = "Gregorian",
  /**
  * @public
- * @type {Islamic}
  */
  Islamic = "Islamic",
  /**
  * @public
- * @type {Japanese}
  */
  Japanese = "Japanese",
  /**
  * @public
- * @type {Buddhist}
  */
  Buddhist = "Buddhist",
  /**
  * @public
- * @type {Persian}
  */
  Persian = "Persian",
 }

packages/base/src/types/NavigationMode.ts

@@ -1,31 +1,23 @@
 /**
  * Different navigation modes for ItemNavigation.
  *
- * @readonly
- * @enum {string}
  * @public
- * @author SAP SE
- * @alias sap.ui.webc.base.types.NavigationMode
  */
 enum NavigationMode {
  /**
  * @public
- * @type {Auto}
  */
  Auto = "Auto",
  /**
  * @public
- * @type {Vertical}
  */
  Vertical = "Vertical",
  /**
  * @public
- * @type {Horizontal}
  */
  Horizontal = "Horizontal",
  /**
  * @public
- * @type {Paging}
  */
  Paging = "Paging",
 }

packages/base/src/types/ValueState.ts

@@ -1,45 +1,36 @@
 /**
  * Different types of ValueStates.
  *
- * @readonly
- * @enum {string}
  * @public
- * @author SAP SE
- * @alias sap.ui.webc.base.types.ValueState
  */
 enum ValueState {
  /**
  *
  * @public
- * @type {None}
  */
  None = "None",
 
  /**
  *
  * @public
- * @type {Success}
  */
  Success = "Success",
 
  /**
  *
  * @public
- * @type {Warning}
  */
  Warning = "Warning",
 
  /**
  *
  * @public
- * @type {Error}
  */
  Error = "Error",
 
  /**
  *
  * @public
- * @type {Information}
  */
  Information = "Information",
 }

packages/fiori/src/Bar.ts

@@ -5,6 +5,7 @@ import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
 import BarDesign from "./types/BarDesign.js";
+import type { IBar } from "./Interfaces";
 
 // Template
 import BarTemplate from "./generated/templates/BarTemplate.lit.js";
@@ -30,15 +31,6 @@ import BarCss from "./generated/themes/Bar.css.js";
  * The default slot will be centered in the available space between the startContent and the endContent areas,
  * therefore it might not always be centered in the entire bar.
  *
- * <h3>CSS Shadow Parts</h3>
- *
- * <ui5-link target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part">CSS Shadow Parts</ui5-link> allow developers to style elements inside the Shadow DOM.
- * <br>
- * The <code>ui5-bar</code> exposes the following CSS Shadow Parts:
- * <ul>
- * <li>bar - Used to style the wrapper of the content of the component</li>
- * </ul>
- *
  * <h3>Keyboard Handling</h3>
  *
  * <h4>Fast Navigation</h4>
@@ -51,12 +43,10 @@ import BarCss from "./generated/themes/Bar.css.js";
  *
  * <code>import "@ui5/webcomponents-fiori/dist/Bar.js";</code>
  *
+ * @csspart bar - Used to style the wrapper of the content of the component
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.fiori.Bar
- * @implements sap.ui.webc.fiori.IBar
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-bar
+ * @implements { IBar }
+ * @extends UI5Element
  * @public
  * @since 1.0.0-rc.11
  */
@@ -67,43 +57,32 @@ import BarCss from "./generated/themes/Bar.css.js";
  styles: BarCss,
  template: BarTemplate,
 })
-class Bar extends UI5Element {
+class Bar extends UI5Element implements IBar {
  /**
  * Defines the component's design.
  *
- * @type {sap.ui.webc.fiori.types.BarDesign}
- * @name sap.ui.webc.fiori.Bar.prototype.design
- * @defaultvalue "Header"
+ * @default "Header"
  * @public
  */
  @property({ type: BarDesign, defaultValue: BarDesign.Header })
  design!: `${BarDesign}`
 
  /**
  * Defines the content at the start of the bar.
- * @type {HTMLElement[]}
- * @name sap.ui.webc.fiori.Bar.prototype.startContent
- * @slot
  * @public
  */
  @slot({ type: HTMLElement })
  startContent!: Array<HTMLElement>;
 
  /**
  * Defines the content in the middle of the bar.
- * @type {HTMLElement[]}
- * @name sap.ui.webc.fiori.Bar.prototype.default
- * @slot middleContent
  * @public
  */
  @slot({ type: HTMLElement, "default": true })
  middleContent!: Array<HTMLElement>
 
  /**
  * Defines the content at the end of the bar.
- * @type {HTMLElement[]}
- * @name sap.ui.webc.fiori.Bar.prototype.endContent
- * @slot
  * @public
  */
  @slot({ type: HTMLElement })

packages/fiori/src/DynamicSideContent.ts

@@ -104,12 +104,10 @@ type DynamicSideContentLayoutChangeEventDetail = {
  * <code>import "@ui5/webcomponents-fiori/dist/DynamicSideContent";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.fiori.DynamicSideContent
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-dynamic-side-content
+ * @extends UI5Element
  * @public
  * @since 1.1.0
+ * @slot {HTMLElement[]} default - Defines the main content.
  */
 @customElement({
  tag: "ui5-dynamic-side-content",
@@ -119,7 +117,6 @@ type DynamicSideContentLayoutChangeEventDetail = {
 })
 /**
  * Fires when the current breakpoint has been changed.
- * @event sap.ui.webc.fiori.DynamicSideContent#layout-change
  * @param {string} currentBreakpoint the current breakpoint.
  * @param {string} previousBreakpoint the breakpoint that was active before change to current breakpoint.
  * @param {boolean} mainContentVisible visibility of the main content.
@@ -128,15 +125,27 @@ type DynamicSideContentLayoutChangeEventDetail = {
  */
 @event("layout-change", {
  detail: {
+ /**
+ * @public
+ */
  currentBreakpoint: {
  type: String,
  },
+ /**
+ * @public
+ */
  previousBreakpoint: {
  type: String,
  },
+ /**
+ * @public
+ */
  mainContentVisible: {
  type: Boolean,
  },
+ /**
+ * @public
+ */
  sideContentVisible: {
  type: Boolean,
  },
@@ -146,9 +155,7 @@ class DynamicSideContent extends UI5Element {
  /**
  * Defines the visibility of the main content.
  *
- * @type {boolean}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.hideMainContent
- * @defaultvalue false
+ * @default false
  * @public
  *
  */
@@ -158,9 +165,7 @@ class DynamicSideContent extends UI5Element {
  /**
  * Defines the visibility of the side content.
  *
- * @type {boolean}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.hideSideContent
- * @defaultvalue false
+ * @default false
  * @public
  *
  */
@@ -179,9 +184,7 @@ class DynamicSideContent extends UI5Element {
  * <li><code>End</code></li>
  * </ul>
  *
- * @type {sap.ui.webc.fiori.types.SideContentPosition}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.sideContentPosition
- * @defaultvalue "End"
+ * @default "End"
  * @public
  *
  */
@@ -202,9 +205,7 @@ class DynamicSideContent extends UI5Element {
  * <li><code>NeverShow</code></li>
  * </ul>
  *
- * @type {sap.ui.webc.fiori.types.SideContentVisibility}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.sideContentVisibility
- * @defaultvalue "ShowAboveS"
+ * @default "ShowAboveS"
  * @public
  *
  */
@@ -224,9 +225,7 @@ class DynamicSideContent extends UI5Element {
  * <li><code>OnMinimumWidth</code></li>
  * </ul>
  *
- * @type {sap.ui.webc.fiori.types.SideContentFallDown}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.sideContentFallDown
- * @defaultvalue "OnMinimumWidth"
+ * @default "OnMinimumWidth"
  * @public
  *
  */
@@ -239,9 +238,7 @@ class DynamicSideContent extends UI5Element {
  * except for phone, where the main and side contents are switching visibility
  * using the toggle method.
  *
- * @type {boolean}]
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.equalSplit
- * @defaultvalue false
+ * @default false
  * @public
  *
  */
@@ -272,21 +269,9 @@ class DynamicSideContent extends UI5Element {
  @property({ noAttribute: true })
  _currentBreakpoint!: string;
 
- /**
- * Defines the main content.
- *
- * @type {HTMLElement[]}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.default
- * @slot
- * @public
- */
-
  /**
  * Defines the side content.
  *
- * @type {HTMLElement[]}
- * @name sap.ui.webc.fiori.DynamicSideContent.prototype.sideContent
- * @slot
  * @public
  */
  @slot()
@@ -320,8 +305,6 @@ class DynamicSideContent extends UI5Element {
  /**
  * Toggles visibility of main and side contents on S screen size (mobile device).
  * @public
- * @method
- * @name sap.ui.webc.fiori.DynamicSideContent#toggleContents
  */
  toggleContents() {
  if (this.breakpoint === this.sizeS && this.sideContentVisibility !== SideContentVisibility.AlwaysShow) {

packages/fiori/src/FilterItem.ts

@@ -18,23 +18,17 @@ import type FilterItemOption from "./FilterItemOption.js";
  * <code>import @ui5/webcomponents-fiori/dist/FilterItem.js";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.fiori.FilterItem
- * @extends sap.ui.webc.base.UI5Element
+ * @extends UI5Element
  * @abstract
  * @since 1.0.0-rc.16
- * @tagname ui5-filter-item
- * @implements sap.ui.webc.fiori.IFilterItem
  * @public
  */
 @customElement("ui5-filter-item")
 class FilterItem extends UI5Element {
  /**
  * Defines the text of the component.
  *
- * @name sap.ui.webc.fiori.FilterItem.prototype.text
- * @type {string}
- * @defaultvalue ""
+ * @default ""
  * @public
  */
  @property()
@@ -43,19 +37,14 @@ class FilterItem extends UI5Element {
  /**
  * Defines the additional text of the component.
  *
- * @name sap.ui.webc.fiori.FilterItem.prototype.additionalText
- * @type {string}
- * @defaultvalue ""
+ * @default ""
  * @public
  */
  @property()
  additionalText!: string;
 
  /**
  * Defines the <code>values</code> list.
- * @name sap.ui.webc.fiori.FilterItem.prototype.values
- * @type {sap.ui.webc.fiori.IFilterItemOption[]}
- * @slot values
  * @public
  */
  @slot()