Skip to content

Commit 21dfb50

Browse files
authored
docs: fix jsdoc in several components (#6301)
Related to: #6300
1 parent 1d11e48 commit 21dfb50

File tree

6 files changed

+30
-21
lines changed

6 files changed

+30
-21
lines changed

packages/fiori/src/FilterItem.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class FilterItem extends UI5Element {
5252

5353
/**
5454
* Defines the <code>values</code> list.
55-
* @name sap.ui.webc.fiori.FilterItem.prototype.value
55+
* @name sap.ui.webc.fiori.FilterItem.prototype.values
5656
* @type {sap.ui.webc.fiori.IFilterItemOption[]}
5757
* @slot values
5858
* @public

packages/fiori/src/ViewSettingsDialog.ts

+1
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ class ViewSettingsDialog extends UI5Element {
240240
* <b>Note:</b> If you want to use this slot, you need to import used item: <code>import "@ui5/webcomponents-fiori/dist/FilterItem";</code>
241241
*
242242
* @type {sap.ui.webc.fiori.IFilterItem[]}
243+
* @name sap.ui.webc.fiori.ViewSettingsDialog.prototype.filterItems
243244
* @slot filterItems
244245
* @public
245246
*/

packages/main/src/CardHeader.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ class CardHeader extends UI5Element {
7373
* Defines the title text.
7474
* @type {string}
7575
* @defaultvalue ""
76-
* @name sap.ui.webc.main.Card.prototype.titleText
76+
* @name sap.ui.webc.main.CardHeader.prototype.titleText
7777
* @public
7878
*/
7979
@property()
@@ -83,7 +83,7 @@ class CardHeader extends UI5Element {
8383
* Defines the subtitle text.
8484
* @type {string}
8585
* @defaultvalue ""
86-
* @name sap.ui.webc.main.Card.prototype.subtitleText
86+
* @name sap.ui.webc.main.CardHeader.prototype.subtitleText
8787
* @public
8888
*/
8989
@property()
@@ -93,7 +93,7 @@ class CardHeader extends UI5Element {
9393
* Defines the status text.
9494
* @type {string}
9595
* @defaultvalue ""
96-
* @name sap.ui.webc.main.Card.prototype.status
96+
* @name sap.ui.webc.main.CardHeader.prototype.status
9797
* @public
9898
*/
9999
@property()
@@ -104,7 +104,7 @@ class CardHeader extends UI5Element {
104104
* e.g gets hover effect, gets focus outline and <code>click</code> event is fired, when pressed.
105105
* @type {boolean}
106106
* @defaultvalue false
107-
* @name sap.ui.webc.main.Card.prototype.interactive
107+
* @name sap.ui.webc.main.CardHeader.prototype.interactive
108108
* @public
109109
*/
110110
@property({ type: Boolean })
@@ -127,7 +127,7 @@ class CardHeader extends UI5Element {
127127
* Defines an avatar image, displayed in the left most part of the header.
128128
* @type {HTMLElement[]}
129129
* @slot
130-
* @name sap.ui.webc.main.Card.prototype.avatar
130+
* @name sap.ui.webc.main.CardHeader.prototype.avatar
131131
* @public
132132
*/
133133
@slot()
@@ -137,7 +137,7 @@ class CardHeader extends UI5Element {
137137
* Defines an action, displayed in the right most part of the header.
138138
* @type {HTMLElement[]}
139139
* @slot
140-
* @name sap.ui.webc.main.Card.prototype.action
140+
* @name sap.ui.webc.main.CardHeader.prototype.action
141141
* @public
142142
*/
143143
@slot()

packages/main/src/Input.ts

+13-5
Original file line numberDiff line numberDiff line change
@@ -523,9 +523,6 @@ class Input extends UI5Element implements SuggestionComponent, IFormElement {
523523
@property({ type: Boolean, noAttribute: true })
524524
_inputIconFocused!: boolean;
525525

526-
@slot({ type: HTMLElement })
527-
icon!: Array<Icon>;
528-
529526
/**
530527
* Defines the suggestion items.
531528
* <br><br>
@@ -564,13 +561,24 @@ class Input extends UI5Element implements SuggestionComponent, IFormElement {
564561
@slot({ type: HTMLElement, "default": true })
565562
suggestionItems!: Array<SuggestionItem>;
566563

564+
/**
565+
* Defines the icon to be displayed in the component.
566+
*
567+
* @type {sap.ui.webcomponents.main.IIcon[]}
568+
* @name sap.ui.webc.main.Input.prototype.icon
569+
* @slot
570+
* @public
571+
*/
572+
@slot()
573+
icon!: Array<Icon>;
574+
567575
/**
568576
* The slot is used for native <code>input</code> HTML element to enable form submit,
569577
* when <code>name</code> property is set.
570578
* @type {HTMLElement[]}
571579
* @private
572580
*/
573-
@slot({ type: HTMLElement })
581+
@slot()
574582
formSupport!: Array<HTMLElement>;
575583

576584
/**
@@ -590,7 +598,7 @@ class Input extends UI5Element implements SuggestionComponent, IFormElement {
590598
* @slot
591599
* @public
592600
*/
593-
@slot({ type: HTMLElement })
601+
@slot()
594602
valueStateMessage!: Array<HTMLElement>;
595603

596604
hasSuggestionItemSelected: boolean;

packages/main/src/StepInput.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ class StepInput extends UI5Element implements IFormElement {
303303
* Defines the value state message that will be displayed as pop up under the component.
304304
* <br><br>
305305
*
306-
* @name sap.ui.webc.main.StepInput.prototype.valueState
306+
* @name sap.ui.webc.main.StepInput.prototype.valueStateMessage
307307
* <b>Note:</b> If not specified, a default text (in the respective language) will be displayed.
308308
* <br>
309309
* <b>Note:</b> The <code>valueStateMessage</code> would be displayed,

packages/main/src/SuggestionItem.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class SuggestionItem extends UI5Element {
2424
* Defines the text of the component.
2525
*
2626
* @type {string}
27-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.text
27+
* @name sap.ui.webc.main.SuggestionItem.prototype.text
2828
* @defaultvalue ""
2929
* @public
3030
*/
@@ -39,7 +39,7 @@ class SuggestionItem extends UI5Element {
3939
* while when <code>Inactive</code> or <code>Detail</code> - will not.
4040
*
4141
* @type {sap.ui.webc.main.types.ListItemType}
42-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.type
42+
* @name sap.ui.webc.main.SuggestionItem.prototype.type
4343
* @defaultvalue "Active"
4444
* @public
4545
* @since 1.0.0-rc.8
@@ -50,7 +50,7 @@ class SuggestionItem extends UI5Element {
5050
/**
5151
* Defines the description displayed right under the item text, if such is present.
5252
* @type {string}
53-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.description
53+
* @name sap.ui.webc.main.SuggestionItem.prototype.description
5454
* @defaultvalue: ""
5555
* @public
5656
*/
@@ -65,7 +65,7 @@ class SuggestionItem extends UI5Element {
6565
* <ui5-link target="_blank" href="https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
6666
*
6767
* @type {string}
68-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.icon
68+
* @name sap.ui.webc.main.SuggestionItem.prototype.icon
6969
* @public
7070
*/
7171
@property()
@@ -77,7 +77,7 @@ class SuggestionItem extends UI5Element {
7777
* <b>Note:</b> If <code>image</code> is set, the <code>icon</code> would be displayed after the <code>image</code>.
7878
*
7979
* @type {boolean}
80-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.iconEnd
80+
* @name sap.ui.webc.main.SuggestionItem.prototype.iconEnd
8181
* @defaultvalue false
8282
* @public
8383
*/
@@ -89,7 +89,7 @@ class SuggestionItem extends UI5Element {
8989
* <b>Note:</b> The <code>image</code> would be displayed in the beginning of the item.
9090
*
9191
* @type {string}
92-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.image
92+
* @name sap.ui.webc.main.SuggestionItem.prototype.image
9393
* @public
9494
*/
9595
@property()
@@ -98,7 +98,7 @@ class SuggestionItem extends UI5Element {
9898
/**
9999
* Defines the <code>additionalText</code>, displayed in the end of the item.
100100
* @type {string}
101-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.additionalText
101+
* @name sap.ui.webc.main.SuggestionItem.prototype.additionalText
102102
* @since 1.0.0-rc.15
103103
* @public
104104
*/
@@ -110,7 +110,7 @@ class SuggestionItem extends UI5Element {
110110
* <br><br>
111111
* Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Information"</code>, <code>"Warning"</code> and <code>"Error"</code>.
112112
* @type {sap.ui.webc.base.types.ValueState}
113-
* @name sap.ui.webc.main.SuggestionGroupItem.prototype.additionalTextState
113+
* @name sap.ui.webc.main.SuggestionItem.prototype.additionalTextState
114114
* @defaultvalue "None"
115115
* @since 1.0.0-rc.15
116116
* @public

0 commit comments

Comments
 (0)