docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610
SAP · Nov 27, 2023 · 67e6abc · 67e6abc
1 parent d456375
commit 67e6abc
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 20 deletions.
diff --git a/packages/fiori/src/SideNavigationItemBase.ts b/packages/fiori/src/SideNavigationItemBase.ts
@@ -5,6 +5,14 @@ import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
 import type { ITabbable } from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
 import type SideNavigation from "./SideNavigation.js";
 
+/**
+ * Fired when the component is activated either with a
+ * click/tap or by using the Enter or Space key.
+ *
+ * @public
+ */
+@event("click")
+
 /**
  * @class
  * A class to serve as a foundation
@@ -16,14 +24,6 @@ import type SideNavigation from "./SideNavigation.js";
  * @public
  * @since 1.19.0
  */
-
-/**
- * Fired when the component is activated either with a
- * click/tap or by using the Enter or Space key.
- *
- * @public
- */
-@event("click")
 class SideNavigationItemBase extends UI5Element implements ITabbable {
 	/**
 	 * Defines the text of the item.

diff --git a/packages/main/src/BusyIndicator.ts b/packages/main/src/BusyIndicator.ts
@@ -111,12 +111,6 @@ class BusyIndicator extends UI5Element {
 	@property({ type: Boolean })
 	_isBusy!: boolean;
 
-	/**
-	 * Determines the content over which the component will appear.
-	 *
-	 * @public
-	 */
-
 	_keydownHandler: (e: KeyboardEvent) => void;
 	_preventEventHandler: (e: KeyboardEvent) => void;
 	_busyTimeoutId?: Timeout;

diff --git a/packages/main/src/Carousel.ts b/packages/main/src/Carousel.ts
@@ -513,7 +513,7 @@ class Carousel extends UI5Element {
 	 * @since 1.0.0-rc.15
 	 * @public
 	 */
-	navigateTo(itemIndex: number) {
+	navigateTo(itemIndex: number) : void {
 		this._resizing = false;
 		this._selectedIndex = itemIndex;
 	}

diff --git a/packages/main/src/Popup.ts b/packages/main/src/Popup.ts
@@ -419,7 +419,7 @@ abstract class Popup extends UI5Element {
 	 * Tells if the component is opened
 	 * @public
 	 */
-	isOpen() {
+	isOpen() : boolean {
 		return this.opened;
 	}
 
@@ -485,7 +485,7 @@ abstract class Popup extends UI5Element {
 	 * Closes the popup.
 	 * @public
 	 */
-	close(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false) {
+	close(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false) : void {
 		if (!this.opened) {
 			return;
 		}

diff --git a/packages/main/src/ResponsivePopover.ts b/packages/main/src/ResponsivePopover.ts
@@ -108,7 +108,7 @@ class ResponsivePopover extends Popover {
 	 * Closes the popover/dialog.
 	 * @public
 	 */
-	close(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false) {
+	close(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false) : void {
 		if (!isPhone()) {
 			super.close(escPressed, preventRegistryUpdate, preventFocusRestore);
 		} else {
@@ -128,7 +128,7 @@ class ResponsivePopover extends Popover {
 	 * Tells if the responsive popover is open.
 	 * @public
 	 */
-	isOpen() {
+	isOpen() : boolean {
 		return (isPhone() && this._dialog) ? this._dialog.isOpen() : super.isOpen();
 	}
 

diff --git a/packages/main/src/Tab.ts b/packages/main/src/Tab.ts
@@ -254,7 +254,7 @@ class Tab extends UI5Element implements ITab, ITabbable {
 	 * @public
 	 * @since 1.0.0-rc.16
 	 */
-	getTabInStripDomRef() {
+	getTabInStripDomRef() : ITab | null {
 		if (this._getElementInStrip) {
 			return this._getElementInStrip();
 		}

diff --git a/packages/main/src/TabContainer.ts b/packages/main/src/TabContainer.ts
@@ -604,6 +604,7 @@ class TabContainer extends UI5Element {
 	 * Calling <code>allItems</code> on this TabContainer will return the instances in the following order:
 	 * <code>[ ui5-tab#First, ui5-tab#Nested, ui5-tab#Second, ui5-tab-separator#sep, ui5-tab#Third ]</code>
 	 * @public
+	 * @default Array[]
 	 */
 	get allItems() : Array<ITab> {
 		return this._getAllSubItems(this.items);