From 531ed4420ed5bfa13eeaab5ee5f5ac7e9e3756be Mon Sep 17 00:00:00 2001
From: niyap <38278268+niyap@users.noreply.github.com>
Date: Mon, 27 Nov 2023 09:02:36 +0200
Subject: [PATCH] docs(ui5-rating-indicator): improve documentation (#7915)

---
 packages/main/src/RatingIndicator.ts | 39 ++++++++--------------------
 1 file changed, 11 insertions(+), 28 deletions(-)

diff --git a/packages/main/src/RatingIndicator.ts b/packages/main/src/RatingIndicator.ts
index 424b8911a9bd..8b61baac5039 100644
--- a/packages/main/src/RatingIndicator.ts
+++ b/packages/main/src/RatingIndicator.ts
@@ -72,10 +72,7 @@ type Star = {
  * <code>import "@ui5/webcomponents/dist/RatingIndicator.js";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.main.RatingIndicator
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-rating-indicator
+ * @extends UI5Element
  * @public
  * @since 1.0.0-rc.8
  */
@@ -91,7 +88,6 @@ type Star = {
 /**
  * The event is fired when the value changes.
  *
- * @event sap.ui.webc.main.RatingIndicator#change
  * @public
  */
 @event("change")
@@ -106,9 +102,7 @@ class RatingIndicator extends UI5Element {
 	 * <li>1.3 - 1.7 -> 1.5</li>
 	 * <li>1.8 - 1.9 -> 2</li>
 	 * <ul>
-	 * @type {sap.ui.webc.base.types.Float}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.value
-	 * @defaultvalue 0
+	 * @default 0
 	 * @public
 	 */
 	@property({ validator: Float, defaultValue: 0 })
@@ -116,9 +110,8 @@ class RatingIndicator extends UI5Element {
 
 	/**
 	 * The number of displayed rating symbols.
-	 * @type {sap.ui.webc.base.types.Integer}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.max
-	 * @defaultvalue 5
+	 *
+	 * @default 5
 	 * @public
 	 * @since 1.0.0-rc.15
 	 */
@@ -130,9 +123,8 @@ class RatingIndicator extends UI5Element {
 	 *
 	 * <br><br>
 	 * <b>Note:</b> A disabled component is completely noninteractive.
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.disabled
-	 * @defaultvalue false
+	 *
+	 * @default false
 	 * @public
 	 */
 	@property({ type: Boolean })
@@ -144,9 +136,7 @@ class RatingIndicator extends UI5Element {
 	 * <b>Note:</b> A read-only component is not editable,
 	 * but still provides visual feedback upon user interaction.
 	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.readonly
-	 * @defaultvalue false
+	 * @default false
 	 * @public
 	 */
 	@property({ type: Boolean })
@@ -155,8 +145,7 @@ class RatingIndicator extends UI5Element {
 	/**
 	 * Defines the accessible ARIA name of the component.
 	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.accessibleName
+	 * @default ""
 	 * @public
 	 * @since 1.0.0-rc.15
 	 */
@@ -166,9 +155,7 @@ class RatingIndicator extends UI5Element {
 	/**
 	 * Receives id(or many ids) of the elements that label the component.
 	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.accessibleNameRef
-	 * @defaultvalue ""
+	 * @default ""
 	 * @public
 	 * @since 1.15.0
 	 */
@@ -178,9 +165,7 @@ class RatingIndicator extends UI5Element {
 	 /**
 	 * Defines whether the component is required.
 	 *
-	 * @type {boolean}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.required
-	 * @defaultvalue false
+	 * @default false
 	 * @public
 	 * @since 1.15.0
 	 */
@@ -190,9 +175,7 @@ class RatingIndicator extends UI5Element {
 	/**
 	 * Defines the tooltip of the component.
 	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.RatingIndicator.prototype.tooltip
-	 * @defaultvalue ""
+	 * @default ""
 	 * @public
 	 * @since 1.19.0
 	 */