docs: improve stories` jsdoc (#7626)

Related: #7284 The enum values are removed from the jsdoc comments
SAP · Oct 16, 2023 · ec6e95e · ec6e95e
1 parent d55d061
commit ec6e95e
Show file tree

Hide file tree

Showing 13 changed files with 5 additions and 273 deletions.
diff --git a/packages/fiori/src/FlexibleColumnLayout.ts b/packages/fiori/src/FlexibleColumnLayout.ts
@@ -173,19 +173,6 @@ class FlexibleColumnLayout extends UI5Element {
 	* <b>Note:</b> The layout also depends on the screen size - one column for screens smaller than 599px,
 	* two columns between 599px and 1023px and three columns for sizes bigger than 1023px.
 	* <br><br>
-	* Available options are:
-	* <ul>
-	* <li><code>OneColumn</code></li>
-	* <li><code>TwoColumnsStartExpanded</code></li>
-	* <li><code>TwoColumnsMidExpanded</code></li>
-	* <li><code>ThreeColumnsMidExpanded</code></li>
-	* <li><code>ThreeColumnsEndExpanded</code></li>
-	* <li><code>ThreeColumnsStartExpandedEndHidden</code></li>
-	* <li><code>ThreeColumnsMidExpandedEndHidden</code></li>
-	* <li><code>MidColumnFullScreen</code></li>
-	* <li><code>EndColumnFullScreen</code></li>
-	* </ul>
-	* <br><br>
 	* <b>For example:</b> layout=<code>TwoColumnsStartExpanded</code> means the layout will display up to two columns
 	* in 67%/33% proportion.
 	* @type {sap.ui.webc.fiori.types.FCLLayout}

diff --git a/packages/fiori/src/IllustratedMessage.ts b/packages/fiori/src/IllustratedMessage.ts
@@ -81,103 +81,6 @@ class IllustratedMessage extends UI5Element {
 	/**
 	* Defines the illustration name that will be displayed in the component.
 	* <br><br>
-	* Available illustrations are:
-	* <ul>
-	* <li><code>AddColumn</code></li>
-	* <li><code>AddPeople</code></li>
-	* <li><code>AddDimensions</code></li>
-	* <li><code>BalloonSky</code></li>
-	* <li><code>BeforeSearch</code></li>
-	* <li><code>Connection</code></li>
-	* <li><code>EmptyCalendar</code></li>
-	* <li><code>EmptyList</code></li>
-	* <li><code>EmptyPlanningCalendar</code></li>
-	* <li><code>ErrorScreen</code></li>
-	* <li><code>FilterTable</code></li>
-	* <li><code>GroupTable</code></li>
-	* <li><code>NoActivities</code></li>
-	* <li><code>NoColumnsSet</code></li>
-	* <li><code>NoData</code></li>
-	* <li><code>NoEntries</code></li>
-	* <li><code>NoFilterResults</code></li>
-	* <li><code>NoMail_v1</code></li>
-	* <li><code>NoMail</code></li>
-	* <li><code>NoNotifications</code></li>
-	* <li><code>NoSavedItems_v1</code></li>
-	* <li><code>NoSavedItems</code></li>
-	* <li><code>NoSearchResults</code></li>
-	* <li><code>NoTasks_v1</code></li>
-	* <li><code>NoTasks</code></li>
-	* <li><code>NoDimensionsSet</code></li>
-	* <li><code>PageNotFound</code></li>
-	* <li><code>ReloadScreen</code></li>
-	* <li><code>ResizeColumn</code></li>
-	* <li><code>SearchEarth</code></li>
-	* <li><code>SearchFolder</code></li>
-	* <li><code>SimpleBalloon</code></li>
-	* <li><code>SimpleBell</code></li>
-	* <li><code>SimpleCalendar</code></li>
-	* <li><code>SimpleCheckMark</code></li>
-	* <li><code>SimpleConnection</code></li>
-	* <li><code>SimpleEmptyDoc</code></li>
-	* <li><code>SimpleEmptyList</code></li>
-	* <li><code>SimpleError</code></li>
-	* <li><code>SimpleMagnifier</code></li>
-	* <li><code>SimpleMail</code></li>
-	* <li><code>SimpleNoSavedItems</code></li>
-	* <li><code>SimpleNotFoundMagnifier</code></li>
-	* <li><code>SimpleReload</code></li>
-	* <li><code>SimpleTask</code></li>
-	* <li><code>SleepingBell</code></li>
-	* <li><code>SortColumn</code></li>
-	* <li><code>SuccessBalloon</code></li>
-	* <li><code>SuccessCheckMark</code></li>
-	* <li><code>SuccessHighFive</code></li>
-	* <li><code>SuccessScreen</code></li>
-	* <li><code>Survey</code></li>
-	* <li><code>Tent</code></li>
-	* <li><code>UnableToLoad</code></li>
-	* <li><code>UnableToLoadImage</code></li>
-	* <li><code>UnableToUpload</code></li>
-	* <li><code>UploadToCloud</code></li>
-	* <li><code>UploadCollection</code></li>
-	* <li><code>TntChartArea</code></li>
-	* <li><code>TntChartArea2</code></li>
-	* <li><code>TntChartBar</code></li>
-	* <li><code>TntChartBPMNFlow</code></li>
-	* <li><code>TntChartBullet</code></li>
-	* <li><code>TntChartDoughnut</code></li>
-	* <li><code>TntChartFlow</code></li>
-	* <li><code>TntChartGantt</code></li>
-	* <li><code>TntChartOrg</code></li>
-	* <li><code>TntChartPie</code></li>
-	* <li><code>TntCodePlaceholder</code></li>
-	* <li><code>TntCompany</code></li>
-	* <li><code>TntComponents</code></li>
-	* <li><code>TntExternalLink</code></li>
-	* <li><code>TntFaceID</code></li>
-	* <li><code>TntFingerprint</code></li>
-	* <li><code>TntLock</code></li>
-	* <li><code>TntMission</code></li>
-	* <li><code>TntNoApplications</code></li>
-	* <li><code>TntNoFlows</code></li>
-	* <li><code>TntNoUsers</code></li>
-	* <li><code>TntRadar</code></li>
-	* <li><code>TntSecrets</code></li>
-	* <li><code>TntServices</code></li>
-	* <li><code>TntSessionExpired</code></li>
-	* <li><code>TntSessionExpiring</code></li>
-	* <li><code>TntSuccess</code></li>
-	* <li><code>TntSuccessfulAuth</code></li>
-	* <li><code>TntSystems</code></li>
-	* <li><code>TntTeams</code></li>
-	* <li><code>TntTools</code></li>
-	* <li><code>TntUnableToLoad</code></li>
-	* <li><code>TntUnlock</code></li>
-	* <li><code>TntUnsuccessfulAuth</code></li>
-	* <li><code>TntUser2</code></li>
-	* </ul>
-	* <br><br>
 	* <b>Note:</b> By default the <code>BeforeSearch</code> illustration is loaded.
 	* <br>
 	* When using an illustration type, other than the default, it should be loaded in addition:
@@ -199,14 +102,6 @@ class IllustratedMessage extends UI5Element {
 	/**
 	* Determines which illustration breakpoint variant is used.
 	* <br><br>
-	* Available options are:
-	* <ul>
-	* <li><code>Auto</code></li>
-	* <li><code>Base</code></li>
-	* <li><code>Spot</code></li>
-	* <li><code>Dialog</code></li>
-	* <li><code>Scene</code></li>
-	* </ul>
 	*
 	* 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.

diff --git a/packages/fiori/src/MediaGallery.ts b/packages/fiori/src/MediaGallery.ts
@@ -158,13 +158,6 @@ class MediaGallery extends UI5Element {
 
 	/**
 	 * Determines the layout of the component.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Auto</code></li>
-	 * <li><code>Vertical</code></li>
-	 * <li><code>Horizontal</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.fiori.types.MediaGalleryLayout}
 	 * @name sap.ui.webc.fiori.MediaGallery.prototype.layout
@@ -177,12 +170,6 @@ class MediaGallery extends UI5Element {
 	/**
 	 * Determines the horizontal alignment of the thumbnails menu
 	 * vs. the central display area.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Left</code></li>
-	 * <li><code>Right</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.fiori.types.MediaGalleryMenuHorizontalAlign}
 	 * @name sap.ui.webc.fiori.MediaGallery.prototype.menuHorizontalAlign
@@ -195,12 +182,6 @@ class MediaGallery extends UI5Element {
 	/**
 	 * Determines the vertical alignment of the thumbnails menu
 	 * vs. the central display area.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Top</code></li>
-	 * <li><code>Bottom</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.fiori.types.MediaGalleryMenuVerticalAlign}
 	 * @name sap.ui.webc.fiori.MediaGallery.prototype.menuVerticalAlign
@@ -214,12 +195,6 @@ class MediaGallery extends UI5Element {
 	 * Determines the actual applied layout type
 	 * (esp. needed when the app did not specify a fixed layout type
 	 * but selected <code>Auto</code> layout type).
-	 * <br><br>
-	 * Possible values are:
-	 * <ul>
-	 * <li><code>Vertical</code></li>
-	 * <li><code>Horizontal</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.fiori.types.MediaGalleryLayout}
 	 * @defaultvalue "Vertical"

diff --git a/packages/main/src/Avatar.ts b/packages/main/src/Avatar.ts
@@ -182,12 +182,7 @@ class Avatar extends UI5Element implements ITabbable {
 
 	/**
 	 * Defines the shape of the component.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Circle</code></li>
-	 * <li><code>Square</code></li>
-	 * </ul>
+	 *
 	 * @type {sap.ui.webc.main.types.AvatarShape}
 	 * @name sap.ui.webc.main.Avatar.prototype.shape
 	 * @defaultvalue "Circle"
@@ -198,15 +193,7 @@ class Avatar extends UI5Element implements ITabbable {
 
 	/**
 	 * Defines predefined size of the component.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>XS</code></li>
-	 * <li><code>S</code></li>
-	 * <li><code>M</code></li>
-	 * <li><code>L</code></li>
-	 * <li><code>XL</code></li>
-	 * </ul>
+	 *
 	 * @type {sap.ui.webc.main.types.AvatarSize}
 	 * @name sap.ui.webc.main.Avatar.prototype.size
 	 * @defaultvalue "S"
@@ -223,21 +210,7 @@ class Avatar extends UI5Element implements ITabbable {
 
 	/**
 	 * Defines the background color of the desired image.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Accent1</code></li>
-	 * <li><code>Accent2</code></li>
-	 * <li><code>Accent3</code></li>
-	 * <li><code>Accent4</code></li>
-	 * <li><code>Accent5</code></li>
-	 * <li><code>Accent6</code></li>
-	 * <li><code>Accent7</code></li>
-	 * <li><code>Accent8</code></li>
-	 * <li><code>Accent9</code></li>
-	 * <li><code>Accent10</code></li>
-	 * <li><code>Placeholder</code></li>
-	 * </ul>
+	 *
 	 * @type {sap.ui.webc.main.types.AvatarColorScheme}
 	 * @name sap.ui.webc.main.Avatar.prototype.colorScheme
 	 * @defaultvalue "Accent6"

diff --git a/packages/main/src/AvatarGroup.ts b/packages/main/src/AvatarGroup.ts
@@ -175,12 +175,7 @@ type AvatarGroupClickEventDetail = {
 class AvatarGroup extends UI5Element {
 	/**
 	 * Defines the mode of the <code>AvatarGroup</code>.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Group</code></li>
-	 * <li><code>Individual</code></li>
-	 * </ul>
+	 *
 	 * @type {sap.ui.webc.main.types.AvatarGroupType}
 	 * @name sap.ui.webc.main.AvatarGroup.prototype.type
 	 * @defaultValue "Group"

diff --git a/packages/main/src/Breadcrumbs.ts b/packages/main/src/Breadcrumbs.ts
@@ -138,7 +138,6 @@ type FocusAdaptor = ITabbable & {
 class Breadcrumbs extends UI5Element {
 	/**
 	 * Defines the visual indication and behavior of the breadcrumbs.
-	 * Available options are <code>Standard</code> (by default) and <code>NoCurrentPage</code>.
 	 * <br><br>
 	 * <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.
@@ -154,17 +153,6 @@ class Breadcrumbs extends UI5Element {
 	/**
 	 * Determines the visual style of the separator between the breadcrumb items.
 	 *
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>Slash</code></li>
-	 * <li><code>BackSlash</code></li>
-	 * <li><code>DoubleBackSlash</code></li>
-	 * <li><code>DoubleGreaterThan</code></li>
-	 * <li><code>DoubleSlash</code></li>
-	 * <li><code>GreaterThan</code></li>
-	 * </ul>
-	 *
 	 * @type {sap.ui.webc.main.types.BreadcrumbsSeparatorStyle}
 	 * @name sap.ui.webc.main.Breadcrumbs.prototype.separatorStyle
 	 * @defaultvalue "Slash"

diff --git a/packages/main/src/CheckBox.ts b/packages/main/src/CheckBox.ts
@@ -222,17 +222,6 @@ class CheckBox extends UI5Element implements IFormElement {
 	/**
 	 * Defines the value state of the component.
 	 *
-	 * <br><br>
-	 * <b>Note:</b>
-	 *
-	 * <ul>
-	 * <li><code>Warning</code></li>
-	 * <li><code>Error</code></li>
-	 * <li><code>None</code>(default)</li>
-	 * <li><code>Success</code></li>
-	 * <li><code>Information</code></li>
-	 * </ul>
-	 *
 	 * @type {sap.ui.webc.base.types.ValueState}
 	 * @name sap.ui.webc.main.CheckBox.prototype.valueState
 	 * @defaultvalue "None"

diff --git a/packages/main/src/Icon.ts b/packages/main/src/Icon.ts
@@ -139,20 +139,6 @@ class Icon extends UI5Element {
 	/**
 	 * Defines the component semantic design.
 	 *
-	 * <br><br>
-	 * <b>The available values are:</b>
-	 *
-	 * <ul>
-	 * <li><code>Contrast</code></li>
-	 * <li><code>Critical</code></li>
-	 * <li><code>Default</code></li>
-	 * <li><code>Information</code></li>
-	 * <li><code>Negative</code></li>
-	 * <li><code>Neutral</code></li>
-	 * <li><code>NonInteractive</code></li>
-	 * <li><code>Positive</code></li>
-	 * </ul>
-	 *
 	 * @type {sap.ui.webc.main.types.IconDesign}
 	 * @name sap.ui.webc.main.Icon.prototype.design
 	 * @defaultvalue "Default"

diff --git a/packages/main/src/List.ts b/packages/main/src/List.ts
@@ -300,9 +300,6 @@ class List extends UI5Element {
 
 	/**
 	 * Defines the mode of the component.
-	 * <br><br>
-	 * <b>Note:</b> Available options are <code>None</code>, <code>SingleSelect</code>, <code>SingleSelectBegin</code>,
-	 * <code>SingleSelectEnd</code>, <code>MultiSelect</code>, and <code>Delete</code>.
 	 *
 	 * @type {sap.ui.webc.main.types.ListMode}
 	 * @name sap.ui.webc.main.List.prototype.mode
@@ -325,14 +322,6 @@ class List extends UI5Element {
 
 	/**
 	 * Defines the item separator style that is used.
-	 * <br><br>
-	 * <b>Notes:</b>
-	 * <ul>
-	 * <li>Avalaible options are <code>All</code>, <code>Inner</code>, and <code>None</code>.</li>
-	 * <li>When set to <code>None</code>, none of the items are separated by horizontal lines.</li>
-	 * <li>When set to <code>Inner</code>, the first item doesn't have a top separator and the last
-	 * item doesn't have a bottom separator.</li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.main.types.ListSeparators}
 	 * @name sap.ui.webc.main.List.prototype.separators
@@ -346,17 +335,6 @@ class List extends UI5Element {
 	 * Defines whether the component will have growing capability either by pressing a <code>More</code> button,
 	 * or via user scroll. In both cases <code>load-more</code> event is fired.
 	 * <br><br>
-	 *
-	 * Available options:
-	 * <br><br>
-	 * <code>Button</code> - Shows a <code>More</code> button at the bottom of the list,
-	 * pressing of which triggers the <code>load-more</code> event.
-	 * <br>
-	 * <code>Scroll</code> - The <code>load-more</code> event is triggered when the user scrolls to the bottom of the list;
-	 * <br>
-	 * <code>None</code> (default) - The growing is off.
-	 * <br><br>
-	 *
 	 * <b>Restrictions:</b> <code>growing="Scroll"</code> is not supported for Internet Explorer,
 	 * on IE the component will fallback to <code>growing="Button"</code>.
 	 * @type {sap.ui.webc.main.types.ListGrowingMode}

diff --git a/packages/main/src/ProgressIndicator.ts b/packages/main/src/ProgressIndicator.ts
@@ -118,15 +118,6 @@ class ProgressIndicator extends UI5Element {
 
 	/**
 	 * Defines the value state of the component.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>None</code></li>
-	 * <li><code>Error</code></li>
-	 * <li><code>Warning</code></li>
-	 * <li><code>Success</code></li>
-	 * <li><code>Information</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.base.types.ValueState}
 	 * @name sap.ui.webc.main.ProgressIndicator.prototype.valueState

diff --git a/packages/main/src/Select.ts b/packages/main/src/Select.ts
@@ -265,15 +265,6 @@ class Select extends UI5Element implements IFormElement {
 
 	/**
 	 * Defines the value state of the component.
-	 * <br><br>
-	 * Available options are:
-	 * <ul>
-	 * <li><code>None</code></li>
-	 * <li><code>Error</code></li>
-	 * <li><code>Warning</code></li>
-	 * <li><code>Success</code></li>
-	 * <li><code>Information</code></li>
-	 * </ul>
 	 *
 	 * @type {sap.ui.webc.base.types.ValueState}
 	 * @defaultvalue "None"