chore: Lint TsDoc.

core/block.ts

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview The class representing one block.
- */
-
 /**
  * The class representing one block.
  * @class

core/block_animations.ts

@@ -4,12 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview Methods animating a block on connection and disconnection.
- */
-
 /**
  * Methods animating a block on connection and disconnection.
+ *
  * @namespace Blockly.blockAnimations
  */
 import * as goog from '../closure/goog/goog.js';
@@ -37,6 +34,7 @@ let disconnectGroup: SVGElement|null = null;
 
 /**
  * Play some UI effects (sound, animation) when disposing of a block.
+ *
  * @param block The block being disposed of.
  * @alias Blockly.blockAnimations.disposeUiEffect
  * @internal
@@ -59,6 +57,7 @@ export function disposeUiEffect(block: BlockSvg) {
  * Animate a cloned block and eventually dispose of it.
  * This is a class method, not an instance method since the original block has
  * been destroyed and is no longer accessible.
+ *
  * @param clone SVG element to animate and dispose of.
  * @param rect Starting rect of the clone.
  * @param rtl True if RTL, false if LTR.
@@ -87,6 +86,7 @@ function disposeUiStep(
 
 /**
  * Play some UI effects (sound, ripple) after a connection has been established.
+ *
  * @param block The block being connected.
  * @alias Blockly.blockAnimations.connectionUiEffect
  * @internal
@@ -124,6 +124,7 @@ export function connectionUiEffect(block: BlockSvg) {
 
 /**
  * Expand a ripple around a connection.
+ *
  * @param ripple Element to animate.
  * @param start Date of animation's start.
  * @param scale Scale of workspace.
@@ -142,6 +143,7 @@ function connectionUiStep(ripple: SVGElement, start: Date, scale: number) {
 
 /**
  * Play some UI effects (sound, animation) when disconnecting a block.
+ *
  * @param block The block being disconnected.
  * @alias Blockly.blockAnimations.disconnectUiEffect
  * @internal
@@ -167,6 +169,7 @@ export function disconnectUiEffect(block: BlockSvg) {
 
 /**
  * Animate a brief wiggle of a disconnected block.
+ *
  * @param group SVG element to animate.
  * @param magnitude Maximum degrees skew (reversed for RTL).
  * @param start Date of animation's start.
@@ -190,6 +193,7 @@ function disconnectUiStep(group: SVGElement, magnitude: number, start: Date) {
 
 /**
  * Stop the disconnect UI animation immediately.
+ *
  * @alias Blockly.blockAnimations.disconnectUiStop
  * @internal
  */

core/block_drag_surface.ts

@@ -4,15 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview A class that manages a surface for dragging blocks.  When a
- * block drag is started, we move the block (and children) to a separate DOM
- * element that we move around using translate3d. At the end of the drag, the
- * blocks are put back in into the SVG they came from. This helps
- * performance by avoiding repainting the entire SVG on every mouse move
- * while dragging blocks.
- */
-
 /**
  * A class that manages a surface for dragging blocks.  When a
  * block drag is started, we move the block (and children) to a separate DOM

core/block_dragger.ts

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview Methods for dragging a block visually.
- */
-
 /**
  * Methods for dragging a block visually.
  * @class

core/block_svg.ts

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview Methods for graphically rendering a block as SVG.
- */
-
 /**
  * Methods for graphically rendering a block as SVG.
  * @class

core/blockly.ts

@@ -4,12 +4,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview The top level namespace used to access the Blockly library.
- */
-
 /**
  * The top level namespace used to access the Blockly library.
+ *
  * @namespace Blockly
  */
 import * as goog from '../closure/goog/goog.js';
@@ -186,6 +183,7 @@ import {ZoomControls} from './zoom_controls.js';
  * buildCompressed gulp task.
  * For local builds, you can pass --define='Blockly.VERSION=X.Y.Z' to the
  * compiler to override this constant.
+ *
  * @define {string}
  * @alias Blockly.VERSION
  */
@@ -290,6 +288,7 @@ export const TOOLBOX_AT_RIGHT = toolbox.Position.RIGHT;
  * See workspace.resizeContents to resize the workspace when the contents
  * change (e.g. when a block is added or removed).
  * Record the height/width of the SVG image.
+ *
  * @param workspace Any workspace in the SVG.
  * @see Blockly.common.svgResize
  * @alias Blockly.svgResize
@@ -298,6 +297,7 @@ export const svgResize = common.svgResize;
 
 /**
  * Close tooltips, context menus, dropdown selections, etc.
+ *
  * @param opt_onlyClosePopups Whether only popups should be closed.
  * @see Blockly.WorkspaceSvg.hideChaff
  * @alias Blockly.hideChaff
@@ -310,20 +310,23 @@ export function hideChaff(opt_onlyClosePopups?: boolean) {
  * Returns the main workspace.  Returns the last used main workspace (based on
  * focus).  Try not to use this function, particularly if there are multiple
  * Blockly instances on a page.
+ *
  * @see Blockly.common.getMainWorkspace
  * @alias Blockly.getMainWorkspace
  */
 export const getMainWorkspace = common.getMainWorkspace;
 
 /**
  * Returns the currently selected copyable object.
+ *
  * @alias Blockly.common.getSelected
  */
 export const getSelected = common.getSelected;
 
 /**
  * Define blocks from an array of JSON block definitions, as might be generated
  * by the Blockly Developer Tools.
+ *
  * @param jsonArray An array of JSON block definitions.
  * @see Blockly.common.defineBlocksWithJsonArray
  * @alias Blockly.defineBlocksWithJsonArray
@@ -335,6 +338,7 @@ export const defineBlocksWithJsonArray = common.defineBlocksWithJsonArray;
  * dropDownDiv, and Tooltip are rendered into the first time `Blockly.inject`
  * is called.
  * This method is a NOP if called after the first ``Blockly.inject``.
+ *
  * @param container The container element.
  * @see Blockly.common.setParentContainer
  * @alias Blockly.setParentContainer
@@ -343,8 +347,9 @@ export const setParentContainer = common.setParentContainer;
 
 /**
  * Returns the dimensions of the specified SVG image.
+ *
  * @param svg SVG image.
- * @return Contains width and height properties.
+ * @returns Contains width and height properties.
  * @deprecated Use workspace.setCachedParentSvgSize. (2021 March 5)
  * @see Blockly.WorkspaceSvg.setCachedParentSvgSize
  * @alias Blockly.svgSize
@@ -354,6 +359,7 @@ export const svgSize = svgMath.svgSize;
 /**
  * Size the workspace when the contents change.  This also updates
  * scrollbars accordingly.
+ *
  * @param workspace The workspace to resize.
  * @deprecated Use workspace.resizeContents. (2021 December)
  * @see Blockly.WorkspaceSvg.resizeContents
@@ -369,6 +375,7 @@ export const resizeSvgContents = resizeSvgContentsLocal;
 
 /**
  * Copy a block or workspace comment onto the local clipboard.
+ *
  * @param toCopy Block or Workspace Comment to be copied.
  * @deprecated Use Blockly.clipboard.copy(). (2021 December)
  * @see Blockly.clipboard.copy
@@ -383,7 +390,8 @@ export function copy(toCopy: ICopyable) {
 
 /**
  * Paste a block or workspace comment on to the main workspace.
- * @return True if the paste was successful, false otherwise.
+ *
+ * @returns True if the paste was successful, false otherwise.
  * @deprecated Use Blockly.clipboard.paste(). (2021 December)
  * @see Blockly.clipboard.paste
  * @alias Blockly.paste
@@ -397,6 +405,7 @@ export function paste(): boolean {
 
 /**
  * Duplicate this block and its children, or a workspace comment.
+ *
  * @param toDuplicate Block or Workspace Comment to be copied.
  * @deprecated Use Blockly.clipboard.duplicate(). (2021 December)
  * @see Blockly.clipboard.duplicate
@@ -411,8 +420,9 @@ export function duplicate(toDuplicate: ICopyable) {
 
 /**
  * Is the given string a number (includes negative and decimals).
+ *
  * @param str Input string.
- * @return True if number, false otherwise.
+ * @returns True if number, false otherwise.
  * @deprecated Use Blockly.utils.string.isNumber(str). (2021 December)
  * @see Blockly.utils.string.isNumber
  * @alias Blockly.isNumber
@@ -426,8 +436,9 @@ export function isNumber(str: string): boolean {
 
 /**
  * Convert a hue (HSV model) into an RGB hex triplet.
+ *
  * @param hue Hue on a colour wheel (0-360).
- * @return RGB code, e.g. '#5ba65b'.
+ * @returns RGB code, e.g. '#5ba65b'.
  * @deprecated Use Blockly.utils.colour.hueToHex(). (2021 December)
  * @see Blockly.utils.colour.hueToHex
  * @alias Blockly.hueToHex
@@ -444,11 +455,12 @@ export function hueToHex(hue: number): string {
  * of the active touch stream.
  * Use this for events that are not part of a multi-part gesture (e.g.
  * mouseover for tooltips).
+ *
  * @param node Node upon which to listen.
  * @param name Event name to listen to (e.g. 'mousedown').
  * @param thisObject The value of 'this' in the function.
  * @param func Function to call when event is triggered.
- * @return Opaque data that can be passed to unbindEvent_.
+ * @returns Opaque data that can be passed to unbindEvent_.
  * @deprecated Use Blockly.browserEvents.bind(). (December 2021)
  * @see Blockly.browserEvents.bind
  * @alias Blockly.bindEvent_
@@ -464,9 +476,10 @@ export function bindEvent_(
 
 /**
  * Unbind one or more events event from a function call.
+ *
  * @param bindData Opaque data from bindEvent_.
  *     This list is emptied during the course of calling this function.
- * @return The function call.
+ * @returns The function call.
  * @deprecated Use Blockly.browserEvents.unbind(). (December 2021)
  * @see browserEvents.unbind
  * @alias Blockly.unbindEvent_
@@ -483,6 +496,7 @@ export function unbindEvent_(bindData: browserEvents.Data): Function {
  * touch stream.
  * Use this for events that either start or continue a multi-part gesture (e.g.
  * mousedown or mousemove, which may be part of a drag or click).
+ *
  * @param node Node upon which to listen.
  * @param name Event name to listen to (e.g. 'mousedown').
  * @param thisObject The value of 'this' in the function.
@@ -493,7 +507,7 @@ export function unbindEvent_(bindData: browserEvents.Data): Function {
  * @param opt_noPreventDefault True if triggering on this event should prevent
  *     the default handler.  False by default.  If opt_noPreventDefault is
  *     provided, opt_noCaptureIdentifier must also be provided.
- * @return Opaque data that can be passed to unbindEvent_.
+ * @returns Opaque data that can be passed to unbindEvent_.
  * @deprecated Use Blockly.browserEvents.conditionalBind(). (December 2021)
  * @see browserEvents.conditionalBind
  * @alias Blockly.bindEventWithChecks_
@@ -523,6 +537,7 @@ export const COLLAPSED_FIELD_NAME = constants.COLLAPSED_FIELD_NAME;
  * String for use in the "custom" attribute of a category in toolbox XML.
  * This string indicates that the category should be dynamically populated with
  * variable blocks.
+ *
  * @alias Blockly.VARIABLE_CATEGORY_NAME
  */
 export const VARIABLE_CATEGORY_NAME: string = Variables.CATEGORY_NAME;
@@ -531,6 +546,7 @@ export const VARIABLE_CATEGORY_NAME: string = Variables.CATEGORY_NAME;
  * String for use in the "custom" attribute of a category in toolbox XML.
  * This string indicates that the category should be dynamically populated with
  * variable blocks.
+ *
  * @alias Blockly.VARIABLE_DYNAMIC_CATEGORY_NAME
  */
 export const VARIABLE_DYNAMIC_CATEGORY_NAME: string =
@@ -539,6 +555,7 @@ export const VARIABLE_DYNAMIC_CATEGORY_NAME: string =
  * String for use in the "custom" attribute of a category in toolbox XML.
  * This string indicates that the category should be dynamically populated with
  * procedure blocks.
+ *
  * @alias Blockly.PROCEDURE_CATEGORY_NAME
  */
 export const PROCEDURE_CATEGORY_NAME: string = Procedures.CATEGORY_NAME;

core/blockly_options.ts

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview Object that defines user-specified options for the workspace.
- */
-
 /**
  * Object that defines user-specified options for the workspace.
  * @namespace Blockly.BlocklyOptions

core/blocks.ts

@@ -4,10 +4,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview A mapping of block type names to block prototype objects.
- */
-
 /**
  * A mapping of block type names to block prototype objects.
  * @namespace Blockly.blocks