mirror of
https://github.com/google/blockly.git
synced 2026-01-07 17:10:11 +01:00
chore: Lint TsDoc. (#6353)
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
This commit is contained in:
committed by
GitHub
parent
bb37d1b7aa
commit
037eb59b89
@@ -4,12 +4,9 @@
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @fileoverview Horizontal flyout tray containing blocks which may be created.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Horizontal flyout tray containing blocks which may be created.
|
||||
*
|
||||
* @class
|
||||
*/
|
||||
import * as goog from '../closure/goog/goog.js';
|
||||
@@ -30,6 +27,7 @@ import * as WidgetDiv from './widgetdiv.js';
|
||||
|
||||
/**
|
||||
* Class for a flyout.
|
||||
*
|
||||
* @alias Blockly.HorizontalFlyout
|
||||
*/
|
||||
export class HorizontalFlyout extends Flyout {
|
||||
@@ -47,6 +45,7 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Sets the translation of the flyout to match the scrollbars.
|
||||
*
|
||||
* @param xyRatio Contains a y property which is a float between 0 and 1
|
||||
* specifying the degree of scrolling and a similar x property.
|
||||
*/
|
||||
@@ -73,7 +72,8 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Calculates the x coordinate for the flyout position.
|
||||
* @return X coordinate.
|
||||
*
|
||||
* @returns X coordinate.
|
||||
*/
|
||||
override getX(): number {
|
||||
// X is always 0 since this is a horizontal flyout.
|
||||
@@ -82,7 +82,8 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Calculates the y coordinate for the flyout position.
|
||||
* @return Y coordinate.
|
||||
*
|
||||
* @returns Y coordinate.
|
||||
*/
|
||||
override getY(): number {
|
||||
if (!this.isVisible()) {
|
||||
@@ -150,6 +151,7 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Create and set the path for the visible boundaries of the flyout.
|
||||
*
|
||||
* @param width The width of the flyout, not including the rounded corners.
|
||||
* @param height The height of the flyout, not including rounded corners.
|
||||
*/
|
||||
@@ -199,6 +201,7 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Scroll the flyout.
|
||||
*
|
||||
* @param e Mouse wheel scroll event.
|
||||
*/
|
||||
protected override wheel_(e: WheelEvent) {
|
||||
@@ -225,6 +228,7 @@ export class HorizontalFlyout extends Flyout {
|
||||
|
||||
/**
|
||||
* Lay out the blocks in the flyout.
|
||||
*
|
||||
* @param contents The blocks and buttons to lay out.
|
||||
* @param gaps The visible gaps between blocks.
|
||||
*/
|
||||
@@ -281,9 +285,10 @@ export class HorizontalFlyout extends Flyout {
|
||||
* Determine if a drag delta is toward the workspace, based on the position
|
||||
* and orientation of the flyout. This is used in determineDragIntention_ to
|
||||
* determine if a new block should be created or if the flyout should scroll.
|
||||
*
|
||||
* @param currentDragDeltaXY How far the pointer has moved from the position
|
||||
* at mouse down, in pixel units.
|
||||
* @return True if the drag is toward the workspace.
|
||||
* @returns True if the drag is toward the workspace.
|
||||
* @internal
|
||||
*/
|
||||
override isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean {
|
||||
@@ -304,7 +309,8 @@ export class HorizontalFlyout extends Flyout {
|
||||
/**
|
||||
* Returns the bounding rectangle of the drag target area in pixel units
|
||||
* relative to viewport.
|
||||
* @return The component's bounding box. Null if drag target area should be
|
||||
*
|
||||
* @returns The component's bounding box. Null if drag target area should be
|
||||
* ignored.
|
||||
*/
|
||||
override getClientRect(): Rect|null {
|
||||
|
||||
Reference in New Issue
Block a user