docs: more fix on jsDoc comments

AlaskaAirlines · Dec 18, 2024 · 58c39ef · 58c39ef
1 parent fa05a44
commit 58c39ef
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 52 deletions.
diff --git a/components/combobox/demo/api.min.js b/components/combobox/demo/api.min.js
@@ -8066,9 +8066,9 @@ var tokensCss$1 = i$c`:host{--ds-auro-menu-divider-color: var(--ds-color-border-
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -8999,7 +8999,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r$6 {
   constructor() {

diff --git a/components/combobox/demo/index.min.js b/components/combobox/demo/index.min.js
@@ -7932,9 +7932,9 @@ var tokensCss$1 = i$c`:host{--ds-auro-menu-divider-color: var(--ds-color-border-
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -8865,7 +8865,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r$6 {
   constructor() {

diff --git a/components/menu/demo/api.md b/components/menu/demo/api.md
@@ -46,8 +46,8 @@ The auro-menu element provides users a way to select from a list of options.
 | Name          | Description                                 |
 |---------------|---------------------------------------------|
 |               | Slot for insertion of menu options.         |
-| [loadingIcon](#loadingIcon) | icon to show while loading attribute is set |
-| [loadingText](#loadingText) | text to show while loading attribute is set |
+| [loadingIcon](#loadingIcon) | Icon to show while loading attribute is set |
+| [loadingText](#loadingText) | Text to show while loading attribute is set |
 
 # auro-menuoption
 

diff --git a/components/menu/demo/api.min.js b/components/menu/demo/api.min.js
@@ -164,9 +164,9 @@ class AuroLibraryRuntimeUtils {
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -1144,7 +1144,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r {
   constructor() {

diff --git a/components/menu/demo/index.min.js b/components/menu/demo/index.min.js
@@ -124,9 +124,9 @@ class AuroLibraryRuntimeUtils {
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -1104,7 +1104,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r {
   constructor() {

diff --git a/components/menu/docs/api.md b/components/menu/docs/api.md
@@ -43,8 +43,8 @@ The auro-menu element provides users a way to select from a list of options.
 | Name          | Description                                 |
 |---------------|---------------------------------------------|
 |               | Slot for insertion of menu options.         |
-| `loadingIcon` | icon to show while loading attribute is set |
-| `loadingText` | text to show while loading attribute is set |
+| `loadingIcon` | Icon to show while loading attribute is set |
+| `loadingText` | Text to show while loading attribute is set |
 
 
 # auro-menuoption

diff --git a/components/menu/scripts/wca/auro-menu.js b/components/menu/scripts/wca/auro-menu.js
@@ -3,26 +3,6 @@ import { AuroMenu } from '../../src/auro-menu.js';
 
 /**
  * The auro-menu element provides users a way to select from a list of options.
- * @attr {Object} optionSelected - Specifies the current selected menuOption.
- * @attr {String} matchWord - Specifies a string used to highlight matched string parts in options.
- * @attr {Boolean} disabled - When true, the entire menu and all options are disabled;
- * @attr {Boolean} noCheckmark - When true, selected option will not show the checkmark.
- * @attr {Boolean} loading - When true, displays a loading state using the loadingIcon and loadingText slots if provided.
- * @attr {String} value - Value selected for the menu.
- * @prop {Boolean} hasLoadingPlaceholder - Indicates whether the menu has a loadingIcon or loadingText to render when in a loading state.
- * @event auroMenu-selectedOption - Notifies that a new menuoption selection has been made.
- * @event selectedOption - (DEPRECATED) Notifies that a new menuoption selection has been made.
- * @event auroMenu-activatedOption - Notifies that a menuoption has been made `active`.
- * @event auroMenuActivatedOption - (DEPRECATED) Notifies that a menuoption has been made `active`.
- * @event auroMenu-selectValueFailure - Notifies that a an attempt to select a menuoption by matching a value has failed.
- * @event auroMenuSelectValueFailure - (DEPRECATED) Notifies that a an attempt to select a menuoption by matching a value has failed.
- * @event auroMenu-customEventFired - Notifies that a custom event has been fired.
- * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
- * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
- * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
  */
 class AuroMenuWCA extends AuroMenu {}
 

diff --git a/components/menu/src/auro-menu.js b/components/menu/src/auro-menu.js
@@ -31,9 +31,9 @@ import AuroLibraryRuntimeUtils from '@aurodesignsystem/auro-library/scripts/util
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */

diff --git a/components/menu/src/auro-menuoption.js b/components/menu/src/auro-menuoption.js
@@ -27,7 +27,7 @@ import checkmarkIcon from '@alaskaairux/icons/dist/icons/interface/checkmark-sm.
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 export class AuroMenuOption extends LitElement {
   constructor() {

diff --git a/components/select/demo/api.min.js b/components/select/demo/api.min.js
@@ -3885,9 +3885,9 @@ var tokensCss$1 = i$b`:host{--ds-auro-menu-divider-color: var(--ds-color-border-
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -4818,7 +4818,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r$4 {
   constructor() {

diff --git a/components/select/demo/index.min.js b/components/select/demo/index.min.js
@@ -3795,9 +3795,9 @@ var tokensCss$1 = i$b`:host{--ds-auro-menu-divider-color: var(--ds-color-border-
  * @event auroMenuCustomEventFired - (DEPRECATED) Notifies that a custom event has been fired.
  * @event auroMenu-selectValueReset - Notifies that the component value has been reset.
  * @event auroMenu-loadingChange - Notifies when the loading attribute is changed.
- * @slot loadingText - text to show while loading attribute is set
- * @slot loadingIcon - icon to show while loading attribute is set
- * @slot Slot for insertion of menu options.
+ * @slot loadingText - Text to show while loading attribute is set
+ * @slot loadingIcon - Icon to show while loading attribute is set
+ * @slot - Slot for insertion of menu options.
  */
 
 /* eslint-disable no-magic-numbers, max-lines */
@@ -4728,7 +4728,7 @@ var checkmarkIcon = {"role":"img","color":"currentColor","title":"","desc":"a sm
  * @attr {Boolean} disabled - When true specifies that the menuoption is disabled.
  * @attr {Boolean} selected - Specifies that an option is selected.
  * @event auroMenuOption-mouseover - Notifies that this option has been hovered over.
- * @slot Specifies text for an option, but is not the value.
+ * @slot - Specifies text for an option, but is not the value.
  */
 class AuroMenuOption extends r$4 {
   constructor() {