chore: add @packageDescription to plugins

packages/plugins/block-dynamic-connection/src/index.ts

@@ -5,8 +5,9 @@
  */
 
 /**
- * @fileoverview Adds blocks that replace the built-in mutator UI with dynamic
- *     connections that appear when a block is dragged over inputs on the block.
+ * A group of blocks that add connections dynamically.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/block-plus-minus/src/index.js

@@ -5,7 +5,8 @@
  */
 
 /**
- * @fileoverview Adds blocks that replace the built-in mutator UI with a +/- UI.
+ * A group of blocks that replace the built-in mutator UI with a +/- based UI.
+ * @packageDocumentation
  */
 
 import './if.js';

packages/plugins/block-shareable-procedures/src/index.ts

@@ -4,6 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A plugin that adds procedure blocks which are backed by explicit data models.
+ *
+ * @packageDocumentation
+ */
+
 import * as Blockly from 'blockly/core';
 import {ObservableParameterModel} from './observable_parameter_model';
 import {ObservableProcedureModel} from './observable_procedure_model';

packages/plugins/content-highlight/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview A plugin that highlights the content on the workspace.
+ * A Blockly workspace plugin that adds a highlight around the content area.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/continuous-toolbox/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview Continuous-scroll toolbox and flyout that is always open.
+ * A Blockly plugin that adds a continous-scrolling style toolbox and flyout
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/cross-tab-copy-paste/src/index.ts

@@ -4,6 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * Allows copying blocks between multiple tabs with Blockly editors.
+ *
+ * @packageDocumentation
+ */
+
 import * as Blockly from 'blockly/core';
 
 type TypeErrorCallback = () => void;

packages/plugins/disable-top-blocks/src/index.js

@@ -4,8 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 /**
- * @fileoverview Plugin for changing the context menu to match the
- * `disableOrphans` event handler.
+ * A Blockly plugin that shows the 'disable' context menu option only on
+ * non-orphan blocks.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/field-angle/src/index.ts

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly angle field.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_angle';

packages/plugins/field-bitmap/src/index.ts

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A field that lets users input a pixel grid with their mouse.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field-bitmap';

packages/plugins/field-colour-hsv-sliders/src/index.ts

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly colour field using HSV sliders.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_colour_hsv_sliders';

packages/plugins/field-colour/src/index.ts

@@ -4,6 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly colour field.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_colour';
 
 import * as colourPicker from './blocks/colourPicker';

packages/plugins/field-date/src/index.ts

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly date picker field that uses the browser's date picker.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_date';

packages/plugins/field-dependent-dropdown/src/index.ts

@@ -4,4 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly dropdown field that automatically updates its available options
+ * depending on the value of another field.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_dependent_dropdown';

packages/plugins/field-grid-dropdown/src/index.ts

@@ -5,7 +5,12 @@
  */
 
 /**
- * @fileoverview Grid dropdown field.
+ * A Blockly dropdown field with grid layout.
+ *
+ * @packageDocumentation
+ */
+
+/**
  * @author kozbial@google.com (Monica Kozbial)
  */
 

packages/plugins/field-multilineinput/src/index.ts

@@ -4,6 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly multilineinput field.
+ *
+ * @packageDocumentation
+ */
+
 import * as textMultiline from './blocks/textMultiline';
 
 export * from './field_multilineinput';

packages/plugins/field-slider/src/index.ts

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly slider field.
+ *
+ * @packageDocumentation
+ */
+
 export * from './field_slider';

packages/plugins/fixed-edges/src/index.js

@@ -5,8 +5,11 @@
  */
 
 /**
- * @fileoverview A metrics manager that makes fixed edges more easily
- * configurable.
+ * A plugin that provides a MetricsManager that can be used to prevent the
+ * workspace from expanding to the top/left/right/bottom when blocks are dragged
+ * to that edge.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/modal/src/index.js

@@ -5,7 +5,11 @@
  */
 
 /**
- * @fileoverview Class responsible for creating a Blockly modal.
+ * A Blockly plugin that creates a modal.
+ * @packageDocumentation
+ */
+
+/**
  * @author aschmiedt@google.com (Abby Schmiedt)
  */
 

packages/plugins/scroll-options/src/index.ts

@@ -4,6 +4,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly plugin that adds advanced scroll options such as scroll-on-drag and
+ * scroll while holding a block.
+ *
+ * @packageDocumentation
+ */
+
 import * as Blockly from 'blockly/core';
 import type {EdgeScrollOptions} from './ScrollBlockDragger';
 import {ScrollBlockDragger} from './ScrollBlockDragger';

packages/plugins/shadow-block-converter/src/index.ts

@@ -4,4 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A workspace change listener that converts shadow blocks to real blocks when
+ * the user edits them.
+ *
+ * @packageDocumentation
+ */
+
 export * from './shadow_block_converter';

packages/plugins/strict-connection-checker/src/index.js

@@ -5,7 +5,10 @@
  */
 
 /**
- * @fileoverview A Blockly plugin that makes connection type checks strict.
+ * A connection checker that prevents blocks that don't provide type information
+ * from being connected to blocks that do.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/suggested-blocks/src/index.js

@@ -5,7 +5,10 @@
  */
 
 /**
- * @fileoverview Utility functions for handling suggestions.
+ * A plugin that adds toolbox panes with suggested blocks based on the user's
+ * past usage of blocks.
+ *
+ * @packageDocumentation
  */
 'use strict';
 

packages/plugins/theme-dark/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview Dark theme.
+ * A Blockly dark theme.
+ *
+ * @packageDocumentation
  */
 
 import * as Blockly from 'blockly/core';

packages/plugins/theme-deuteranopia/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview Deuteranopia theme.
+ * A Blockly theme for people that have deuteranopia.
+ *
+ * @packageDocumentation
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */

packages/plugins/theme-hackermode/src/index.ts

@@ -5,8 +5,10 @@
  */
 
 /**
- * @fileoverview Hacker Mode theme.
- * Black background and blocks with lime green text to simulate a hacker screen.
+ * A Blockly theme with an all black theme and green text to mimic a hacking
+ * page
+ *
+ * @packageDocumentation
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */

packages/plugins/theme-highcontrast/src/index.ts

@@ -5,9 +5,9 @@
  */
 
 /**
- * @fileoverview High contrast theme.
+ * A Blockly high contrast theme.
  *
- * Darker colours to contrast the white font.
+ * @packageDocumentation
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */

packages/plugins/theme-modern/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview Modern theme.
+ * A Blockly modern theme with darker block borders.
+ *
+ * @packageDocumentation
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */

packages/plugins/theme-tritanopia/src/index.ts

@@ -5,7 +5,9 @@
  */
 
 /**
- * @fileoverview Tritanopia theme.
+ * A Blockly theme for people that have tritanopia.
+ *
+ * @packageDocumentation
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */

packages/plugins/toolbox-search/src/index.ts

@@ -1,2 +1,9 @@
+/**
+ * A Blockly plugin that adds a toolbox category that allows searching for
+ * blocks.
+ *
+ * @packageDocumentation
+ */
+
 // This file exists solely as an entrypoint.
 import './toolbox_search';

packages/plugins/typed-variable-modal/src/index.js

@@ -4,4 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly plugin to create a modal for creating typed variables.
+ *
+ * @packageDocumentation
+ */
+
 export * from './TypedVariableModal';

packages/plugins/typedoc.json

@@ -19,6 +19,17 @@
     "compilerOptions": {"allowJs": true},
     "excludeInternal": true,
     "excludePrivate": true,
+    "excludeTags": [
+      "@override",
+      "@virtual",
+      "@privateRemarks",
+      "@satisfies",
+      "@overload",
+      "@inline",
+      "@inlineType",
+      "@fileoverview",
+      "@author"
+    ],
     "skipErrorChecking": true,
     "sourceLinkTemplate": "https://github.com/RaspberryPiFoundation/blockly/blob/{gitRevision}/{path}#L{line}"
   }

packages/plugins/workspace-backpack/src/index.ts

@@ -4,6 +4,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * A Blockly plugin that adds Backpack support.
+ *
+ * @packageDocumentation
+ */
+
 export {Backpack} from './backpack';
 export * from './ui_events';
 export type {BackpackOptions, BackpackContextMenuOptions} from './options';

packages/plugins/workspace-minimap/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@blockly/workspace-minimap",
   "version": "13.4.0",
-  "description": "A Blockly plugin.",
+  "description": "A Blockly plugin that adds a minimap, which is a miniature version of the blocks that appears on top of the main workspace.",
   "scripts": {
     "audit-fix": "blockly-scripts auditFix",
     "build": "blockly-scripts build",