docs: new cem for Topic-P components

SAP · Nov 15, 2023 · 254f764 · 254f764
1 parent e1e1b69
commit 254f764
Show file tree

Hide file tree

Showing 9 changed files with 0 additions and 42 deletions.
diff --git a/packages/fiori/src/IllustratedMessage.ts b/packages/fiori/src/IllustratedMessage.ts
@@ -90,7 +90,6 @@ class IllustratedMessage extends UI5Element {
 	* You can import them removing the <code>Tnt</code> prefix like this:
 	* <br>
 	* <code>import "@ui5/webcomponents-fiori/dist/illustrations/tnt/SessionExpired.js";</code>
-	* @type {IllustrationMessageType}
 	* @default "BeforeSearch"
 	* @public
 	*/
@@ -104,7 +103,6 @@ class IllustratedMessage extends UI5Element {
 	* As <code>IllustratedMessage</code> adapts itself around the <code>Illustration</code>, the other
 	* elements of the component are displayed differently on the different breakpoints/illustration sizes.
 	*
-	* @type {IllustrationMessageSize}
 	* @default "Auto"
 	* @public
 	* @since 1.5.0
@@ -118,7 +116,6 @@ class IllustratedMessage extends UI5Element {
 	* <b>Note:</b> Using this property, the default subtitle text of illustration will be overwritten.
 	* <br><br>
 	* <b>Note:</b> Using <code>subtitle</code> slot, the default of this property will be overwritten.
-	* @type {string}
 	* @default ""
 	* @public
 	*/
@@ -129,7 +126,6 @@ class IllustratedMessage extends UI5Element {
 	* Defines the title of the component.
 	* <br><br>
 	* <b>Note:</b> Using this property, the default title text of illustration will be overwritten.
-	* @type {string}
 	* @default ""
 	* @public
 	*/
@@ -139,7 +135,6 @@ class IllustratedMessage extends UI5Element {
 	/**
 	* Receives id(or many ids) of the elements that label the component.
 	*
-	* @type {string}
 	* @default ""
 	* @public
 	* @since 1.7.0
@@ -165,7 +160,6 @@ class IllustratedMessage extends UI5Element {
 	* Illustration breakpoint variant for the <code>Spot</code> size.
 	*
 	* @private
-	* @type {String}
 	* @since 1.9.0
 	*/
 	@property({ noAttribute: true })
@@ -175,7 +169,6 @@ class IllustratedMessage extends UI5Element {
 	* Illustration breakpoint variant for the <code>Scene</code> size.
 	*
 	* @private
-	* @type {String}
 	* @since 1.9.0
 	*/
 	@property({ noAttribute: true })
@@ -185,7 +178,6 @@ class IllustratedMessage extends UI5Element {
 	* Illustration breakpoint variant for the <code>Dialog</code> size.
 	*
 	* @private
-	* @type {String}
 	* @since 1.9.0
 	*/
 	@property({ noAttribute: true })
@@ -202,7 +194,6 @@ class IllustratedMessage extends UI5Element {
 	* Defines the title of the component.
 	* <br><br>
 	* <b>Note:</b> Using this slot, the default title text of illustration and the value of <code>title</code> property will be overwritten.
-	* @type {HTMLElement}
 	* @public
 	* @since 1.7.0
 	*/
@@ -213,7 +204,6 @@ class IllustratedMessage extends UI5Element {
 	* Defines the subtitle of the component.
 	* <br><br>
 	* <b>Note:</b> Using this slot, the default subtitle text of illustration and the value of <code>subtitleText</code> property will be overwritten.
-	* @type {HTMLElement}
 	* @public
 	* @since 1.0.0-rc.16
 	*/
@@ -222,7 +212,6 @@ class IllustratedMessage extends UI5Element {
 
 	/**
 	* Defines the component actions.
-	* @type {IButton[]}
 	* @public
 	*/
 	@slot({ type: HTMLElement, "default": true })

diff --git a/packages/fiori/src/types/IllustrationMessageSize.ts b/packages/fiori/src/types/IllustrationMessageSize.ts
@@ -1,7 +1,6 @@
 /**
  * Different types of IllustrationMessageSize.
  *
- * @readonly
  * @public
  * @since 1.5.0
  */

diff --git a/packages/fiori/src/types/IllustrationMessageType.ts b/packages/fiori/src/types/IllustrationMessageType.ts
@@ -433,7 +433,6 @@ enum IllustrationMessageType {
 	/**
 	* "TntNoUsers" illustration type.
 	* @public
-	* @ {TntNoUsers}
 	*/
 	TntNoUsers = "TntNoUsers",
 	/**

diff --git a/packages/main/src/Breadcrumbs.ts b/packages/main/src/Breadcrumbs.ts
@@ -137,7 +137,6 @@ class Breadcrumbs extends UI5Element {
 	 * <b>Note:</b> The <code>Standard</code> breadcrumbs show the current page as the last item in the trail.
 	 * The last item contains only plain text and is not a link.
 	 *
-	 * @type {BreadcrumbsDesign}
 	 * @default "Standard"
 	 * @public
 	*/
@@ -147,7 +146,6 @@ class Breadcrumbs extends UI5Element {
 	/**
 	 * Determines the visual style of the separator between the breadcrumb items.
 	 *
-	 * @type {BreadcrumbsSeparatorStyle}
 	 * @default "Slash"
 	 * @public
 	 */
@@ -157,7 +155,6 @@ class Breadcrumbs extends UI5Element {
 	/**
 	 * Holds the number of items in the overflow.
 	 *
-	 * @type {Integer}
 	 * @default 0
 	 * @private
 	 */
@@ -169,7 +166,6 @@ class Breadcrumbs extends UI5Element {
 	 *
 	 * <br><br>
 	 * <b>Note:</b> Use the <code>ui5-breadcrumbs-item</code> component to define the desired items.
-	 * @type {IBreadcrumbsItem[]}
 	 * @public
 	 */
 	@slot({ type: HTMLElement, invalidateOnChildChange: true, "default": true })

diff --git a/packages/main/src/BreadcrumbsItem.ts b/packages/main/src/BreadcrumbsItem.ts
@@ -12,7 +12,6 @@ import type { IBreadcrumbsItem } from "./Interfaces.js";
  * The <code>ui5-breadcrumbs-item</code> component defines the content of an item in <code>ui5-breadcrumbs</code>.
  *
  * @constructor
- * @author SAP SE
  * @extends UI5Element
  * @implements {IBreadcrumbsItem}
  * @public
@@ -25,7 +24,6 @@ class BreadcrumbsItem extends UI5Element implements IBreadcrumbsItem {
 	 * <br><br>
 	 * <b>Note:</b> Standard hyperlink behavior is supported.
 	 *
-	 * @type {string}
 	 * @default ""
 	 * @public
 	 */
@@ -46,7 +44,6 @@ class BreadcrumbsItem extends UI5Element implements IBreadcrumbsItem {
 	 * <br><br>
 	 * <b>Note:<b> This property must only be used when the <code>href</code> property is set.
 	 *
-	 * @type {string}
 	 * @default undefined
 	 * @public
 	 */
@@ -56,7 +53,6 @@ class BreadcrumbsItem extends UI5Element implements IBreadcrumbsItem {
 	/**
 	 * Defines the accessible ARIA name of the item.
 	 *
-	 * @type {string}
 	 * @default undefined
 	 * @public
 	 */
@@ -68,7 +64,6 @@ class BreadcrumbsItem extends UI5Element implements IBreadcrumbsItem {
 	 * <br><br>
 	 * <b>Note:</b> Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
 	 *
-	 * @type {Node[]}
 	 * @public
 	 */
 	@slot({ type: Node, "default": true })

diff --git a/packages/main/src/CheckBox.ts b/packages/main/src/CheckBox.ts
@@ -106,7 +106,6 @@ let activeCb: CheckBox;
 class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Receives id(or many ids) of the elements that label the component
-	 * @type {string}
 	 * @default ""
 	 * @public
 	 * @since 1.1.0
@@ -117,7 +116,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Defines the accessible ARIA name of the component.
 	 *
-	 * @type {string}
 	 * @public
 	 * @default ""
 	 * @since 1.1.0
@@ -130,7 +128,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	 * <br><br>
 	 * <b>Note:</b> A disabled component is completely noninteractive.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @public
 	 */
@@ -143,7 +140,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	 * <b>Note:</b> A read-only component is not editable,
 	 * but still provides visual feedback upon user interaction.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @public
 	 */
@@ -153,7 +149,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Defines whether the component is required.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @public
 	 * @since 1.3.0
@@ -173,7 +168,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	* <li> If the component is not checked, it will be displayed as not checked regardless value of the indeterminate attribute
 	* </ul>
 	*
-	* @type {boolean}
 	* @default false
 	* @public
 	* @since 1.0.0-rc.15
@@ -188,7 +182,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	 * either by cliking/tapping on the component, or by
 	 * pressing the Enter or Space key.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @formEvents change
 	 * @formProperty
@@ -200,7 +193,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Defines the text of the component.
 	 *
-	 * @type {string}
 	 * @default ""
 	 * @public
 	 */
@@ -210,7 +202,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Defines the value state of the component.
 	 *
-	 * @type {ValueState}
 	 * @default "None"
 	 * @public
 	 */
@@ -221,7 +212,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	 * Defines whether the component text wraps when there is not enough space.
 	 * <br><b>Note:</b> for option "Normal" the text will wrap and the words will not be broken based on hyphenation.
 	 *
-	 * @type {WrappingType}
 	 * @default "None"
 	 * @public
 	 */
@@ -240,7 +230,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	 * will be created inside the component so that it can be submitted as
 	 * part of an HTML form. Do not use this property unless you need to submit a form.
 	 *
-	 * @type {string}
 	 * @default ""
 	 * @public
 	 */
@@ -257,7 +246,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * The slot is used to render native <code>input</code> HTML element within Light DOM to enable form submit,
 	 * when <code>name</code> property is set.
-	 * @type {HTMLElement[]}
 	 * @private
 	 */
 	@slot()

diff --git a/packages/main/src/ProgressIndicator.ts b/packages/main/src/ProgressIndicator.ts
@@ -53,7 +53,6 @@ class ProgressIndicator extends UI5Element {
 	/**
 	 * Defines the accessible ARIA name of the component.
 	 *
-	 * @type {string}
 	 * @default ""
 	 * @public
 	 * @since 1.16.0
@@ -64,7 +63,6 @@ class ProgressIndicator extends UI5Element {
 	/**
 	 * Defines whether component is in disabled state.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @public
 	 */
@@ -74,7 +72,6 @@ class ProgressIndicator extends UI5Element {
 	/**
 	 * Defines whether the component value is shown.
 	 *
-	 * @type {boolean}
 	 * @default false
 	 * @public
 	 */
@@ -86,7 +83,6 @@ class ProgressIndicator extends UI5Element {
 	 *
 	 * <b>Note:</b>
 	 * If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.
-	 * @type {Integer}
 	 * @default 0
 	 * @public
 	 */
@@ -102,7 +98,6 @@ class ProgressIndicator extends UI5Element {
 	 * <li>If <code>hideValue</code> property is <code>true</code> both the <code>displayValue</code> and <code>value</code> property values are not shown.</li>
 	 * </ul>
 	 *
-	 * @type {string}
 	 * @public
 	 */
 	@property()
@@ -111,7 +106,6 @@ class ProgressIndicator extends UI5Element {
 	/**
 	 * Defines the value state of the component.
 	 *
-	 * @type {ValueState}
 	 * @default "None"
 	 * @public
 	 */

diff --git a/packages/main/src/types/BreadcrumbsDesign.ts b/packages/main/src/types/BreadcrumbsDesign.ts
@@ -1,7 +1,6 @@
 /**
  * Different  Breadcrumbs designs.
  *
- * @readonly
  * @public
  */
 enum BreadcrumbsDesign {

diff --git a/packages/main/src/types/BreadcrumbsSeparatorStyle.ts b/packages/main/src/types/BreadcrumbsSeparatorStyle.ts
@@ -1,7 +1,6 @@
 /**
  * Different Breadcrumbs separator styles.
  *
- * @readonly
  * @public
  */
 enum BreadcrumbsSeparatorStyle {