remove explicit @return for async void fns (covered by #17751)

Author: mmalerba

src/material/autocomplete/testing/autocomplete-harness.ts

@@ -50,12 +50,12 @@ export class MatAutocompleteHarness extends ComponentHarness {
     return coerceBooleanProperty(await disabled);
   }
 
-  /** Focuses the input and returns a void promise that indicates when the action is complete. */
+  /** Focuses the autocomplete input. */
   async focus(): Promise<void> {
     return (await this.host()).focus();
   }
 
-  /** Blurs the input and returns a void promise that indicates when the action is complete. */
+  /** Blurs the autocomplete input. */
   async blur(): Promise<void> {
     return (await this.host()).blur();
   }

src/material/autocomplete/testing/option-harness.ts

@@ -45,10 +45,7 @@ export class MatAutocompleteOptionHarness extends ComponentHarness {
             (harness, text) => HarnessPredicate.stringMatches(harness.getText(), text));
   }
 
-  /**
-   * Clicks the option.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Clicks the option. */
   async select(): Promise<void> {
     return (await this.host()).click();
   }

src/material/button/testing/button-harness.ts

@@ -53,12 +53,12 @@ export class MatButtonHarness extends ComponentHarness {
     return (await this.host()).text();
   }
 
-  /** Focuses the button and returns a void promise that indicates when the action is complete. */
+  /** Focuses the button. */
   async focus(): Promise<void> {
     return (await this.host()).focus();
   }
 
-  /** Blurs the button and returns a void promise that indicates when the action is complete. */
+  /** Blurs the button. */
   async blur(): Promise<void> {
     return (await this.host()).blur();
   }

src/material/checkbox/testing/checkbox-harness.ts

@@ -91,19 +91,18 @@ export class MatCheckboxHarness extends ComponentHarness {
     return (await this._label()).text();
   }
 
-  /** Focuses the checkbox and returns a void promise that indicates when the action is complete. */
+  /** Focuses the checkbox. */
   async focus(): Promise<void> {
     return (await this._input()).focus();
   }
 
-  /** Blurs the checkbox and returns a void promise that indicates when the action is complete. */
+  /** Blurs the checkbox. */
   async blur(): Promise<void> {
     return (await this._input()).blur();
   }
 
   /**
-   * Toggle the checked state of the checkbox and returns a void promise that indicates when the
-   * action is complete.
+   * Toggles the checked state of the checkbox.
    *
    * Note: This attempts to toggle the checkbox as a user would, by clicking it. Therefore if you
    * are using `MAT_CHECKBOX_CLICK_ACTION` to change the behavior on click, calling this method
@@ -115,8 +114,7 @@ export class MatCheckboxHarness extends ComponentHarness {
 
   /**
    * Puts the checkbox in a checked state by toggling it if it is currently unchecked, or doing
-   * nothing if it is already checked. Returns a void promise that indicates when the action is
-   * complete.
+   * nothing if it is already checked.
    *
    * Note: This attempts to check the checkbox as a user would, by clicking it. Therefore if you
    * are using `MAT_CHECKBOX_CLICK_ACTION` to change the behavior on click, calling this method
@@ -130,8 +128,7 @@ export class MatCheckboxHarness extends ComponentHarness {
 
   /**
    * Puts the checkbox in an unchecked state by toggling it if it is currently checked, or doing
-   * nothing if it is already unchecked. Returns a void promise that indicates when the action is
-   * complete.
+   * nothing if it is already unchecked.
    *
    * Note: This attempts to uncheck the checkbox as a user would, by clicking it. Therefore if you
    * are using `MAT_CHECKBOX_CLICK_ACTION` to change the behavior on click, calling this method

src/material/menu/testing/menu-harness.ts

@@ -47,36 +47,24 @@ export class MatMenuHarness extends ComponentHarness {
     return (await this.host()).text();
   }
 
-  /**
-   * Focuses the menu
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Focuses the menu. */
   async focus(): Promise<void> {
     return (await this.host()).focus();
   }
 
-  /**
-   * Blurs the menu.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Blurs the menu. */
   async blur(): Promise<void> {
     return (await this.host()).blur();
   }
 
-  /**
-   * Opens the menu.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Opens the menu. */
   async open(): Promise<void> {
     if (!await this.isOpen()) {
       return (await this.host()).click();
     }
   }
 
-  /**
-   * Closes the menu.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Closes the menu. */
   async close(): Promise<void> {
     const panel = await this._getMenuPanel();
     if (panel) {
@@ -105,7 +93,6 @@ export class MatMenuHarness extends ComponentHarness {
    * @param subItemFilters A list of filters representing the items to click in any subsequent
    *     sub-menus. The first item in the sub-menu matching the corresponding filter in
    *     `subItemFilters` will be clicked.
-   * @return A promise that resolves when the action is complete.
    */
   async clickItem(
       itemFilter: Omit<MenuItemHarnessFilters, 'ancestor'>,
@@ -171,26 +158,17 @@ export class MatMenuItemHarness extends ComponentHarness {
     return (await this.host()).text();
   }
 
-  /**
-   * Focuses the menu.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Focuses the menu item. */
   async focus(): Promise<void> {
     return (await this.host()).focus();
   }
 
-  /**
-   * Blurs the menu.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Blurs the menu item. */
   async blur(): Promise<void> {
     return (await this.host()).blur();
   }
 
-  /**
-   * Clicks the menu item.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Clicks the menu item. */
   async click(): Promise<void> {
     return (await this.host()).click();
   }

src/material/radio/testing/radio-harness.ts

@@ -84,7 +84,6 @@ export class MatRadioGroupHarness extends ComponentHarness {
    * Checks a radio button in this group.
    * @param filter An optional filter to apply to the child radio buttons. The first tab matching
    *     the filter will be selected.
-   * @return A promise that resolves when the action is complete.
    */
   async checkRadioButton(filter: RadioButtonHarnessFilters = {}): Promise<void> {
     const radioButtons = await this.getRadioButtons(filter);
@@ -178,7 +177,7 @@ export class MatRadioButtonHarness extends ComponentHarness {
   private _clickLabel = this.locatorFor('.mat-radio-label');
   private _input = this.locatorFor('input');
 
-  /** Whether the radio-button is checked. */
+  /** Gets a boolean promise indicating whether the radio-button is checked. */
   async isChecked(): Promise<boolean> {
     const checked = (await this._input()).getProperty('checked');
     return coerceBooleanProperty(await checked);
@@ -222,26 +221,19 @@ export class MatRadioButtonHarness extends ComponentHarness {
     return (await this._textLabel()).text();
   }
 
-  /**
-   * Focuses the radio-button.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Focuses the radio-button. */
   async focus(): Promise<void> {
     return (await this._input()).focus();
   }
 
-  /**
-   * Blurs the radio-button.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Blurs the radio-button. */
   async blur(): Promise<void> {
     return (await this._input()).blur();
   }
 
   /**
    * Puts the radio-button in a checked state by clicking it if it is currently unchecked,
    * or doing nothing if it is already checked.
-   * @return A promise that resolves when the action is complete.
    */
   async check(): Promise<void> {
     if (!(await this.isChecked())) {

src/material/slide-toggle/testing/slide-toggle-harness.ts

@@ -80,34 +80,24 @@ export class MatSlideToggleHarness extends ComponentHarness {
     return (await this._label()).text();
   }
 
-  /**
-   * Focuses the slide-toggle.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Focuses the slide-toggle. */
   async focus(): Promise<void> {
     return (await this._input()).focus();
   }
 
-  /**
-   * Blurs the slide-toggle and returns a void promise that indicates action completion.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Blurs the slide-toggle. */
   async blur(): Promise<void> {
     return (await this._input()).blur();
   }
 
-  /**
-   * Toggle the checked state of the slide-toggle.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Toggle the checked state of the slide-toggle. */
   async toggle(): Promise<void> {
     return (await this._inputContainer()).click();
   }
 
   /**
    * Puts the slide-toggle in a checked state by toggling it if it is currently unchecked, or doing
    * nothing if it is already checked.
-   * @return A promise that resolves when the action is complete.
    */
   async check(): Promise<void> {
     if (!(await this.isChecked())) {
@@ -118,7 +108,6 @@ export class MatSlideToggleHarness extends ComponentHarness {
   /**
    * Puts the slide-toggle in an unchecked state by toggling it if it is currently checked, or doing
    * nothing if it is already unchecked.
-   * @return A promise that resolves when the action is complete.
    */
   async uncheck(): Promise<void> {
     if (await this.isChecked()) {

src/material/slider/testing/slider-harness.ts

@@ -87,8 +87,6 @@ export class MatSliderHarness extends ComponentHarness {
    * can happen if not every value of the slider maps to a single pixel that could be
    * clicked using mouse interaction. In such cases consider using the keyboard to
    * select the given value or expand the slider's size for a better user experience.
-   *
-   * @return A promise that resolves when the action is complete.
    */
   async setValue(value: number): Promise<void> {
     const [sliderEl, wrapperEl, orientation] =
@@ -111,18 +109,12 @@ export class MatSliderHarness extends ComponentHarness {
     await wrapperEl.click(relativeX, relativeY);
   }
 
-  /**
-   * Focuses the slider.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Focuses the slider. */
   async focus(): Promise<void> {
     return (await this.host()).focus();
   }
 
-  /**
-   * Blurs the slider.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Blurs the slider. */
   async blur(): Promise<void> {
     return (await this.host()).blur();
   }

src/material/snack-bar/testing/snack-bar-harness.ts

@@ -61,7 +61,6 @@ export class MatSnackBarHarness extends ComponentHarness {
   /**
    * Dismisses the snack-bar by clicking the action button. Method cannot
    * be used for snack-bar's without action or with custom content.
-   * @return A promise that resolves when the action is complete.
    */
   async dismissWithAction(): Promise<void> {
     await this._assertSimpleSnackBarWithAction();

src/material/tabs/testing/tab-group-harness.ts

@@ -53,7 +53,6 @@ export class MatTabGroupHarness extends ComponentHarness {
    * Selects a tab in this tab group.
    * @param filter An optional filter to apply to the child tabs. The first tab matching the filter
    *     will be selected.
-   * @return A promise that resolves when the action is complete.
    */
   async selectTab(filter: TabHarnessFilters = {}): Promise<void> {
     const tabs = await this.getTabs(filter);

src/material/tabs/testing/tab-harness.ts

@@ -53,10 +53,7 @@ export class MatTabHarness extends ComponentHarness {
     return (await hostEl.getAttribute('aria-disabled')) === 'true';
   }
 
-  /**
-   * Selects the given tab by clicking on the label. Tab cannot be selected if disabled.
-   * @return A promise that resolves when the action is complete.
-   */
+  /** Selects the given tab by clicking on the label. Tab cannot be selected if disabled. */
   async select(): Promise<void> {
     await (await this.host()).click();
   }