Code style: Fix ESLint warnings reported for JSDoc definitions (#18025)

* Code style: Fix ESLint warnings reported for JSDoc definitions

* Add WordPress type definitions to the list of names recognized by JSDoc linter

docs/designers-developers/developers/data/data-core-block-editor.md

@@ -345,7 +345,7 @@ _Parameters_
 
 _Returns_
 
--   `Array<Editor.InserterItem>`: Items that appear in inserter.
+-   `Array<WPEditorInserterItem>`: Items that appear in inserter.
 
 <a name="getLastMultiSelectedBlockClientId" href="#getLastMultiSelectedBlockClientId">#</a> **getLastMultiSelectedBlockClientId**
 

docs/designers-developers/developers/data/data-core-edit-post.md

@@ -80,11 +80,11 @@ _Parameters_
 
 -   _state_ `Object`: Global application state.
 -   _preferenceKey_ `string`: Preference Key.
--   _defaultValue_ `Mixed`: Default Value.
+-   _defaultValue_ `*`: Default Value.
 
 _Returns_
 
--   `Mixed`: Preference Value.
+-   `*`: Preference Value.
 
 <a name="getPreferences" href="#getPreferences">#</a> **getPreferences**
 

docs/designers-developers/developers/data/data-core-nux.md

@@ -30,7 +30,7 @@ _Parameters_
 
 _Returns_
 
--   `?NUX.GuideInfo`: Information about the associated guide.
+-   `?NUXGuideInfo`: Information about the associated guide.
 
 <a name="isTipVisible" href="#isTipVisible">#</a> **isTipVisible**
 

docs/designers-developers/developers/data/data-core.md

@@ -512,7 +512,7 @@ a given URl has been received.
 _Parameters_
 
 -   _url_ `string`: URL to preview the embed for.
--   _preview_ `Mixed`: Preview data.
+-   _preview_ `*`: Preview data.
 
 _Returns_
 

packages/block-editor/README.md

@@ -137,7 +137,7 @@ _Parameters_
 
 _Returns_
 
--   `WPElement`: Rendered element.
+-   `WPComponent`: The component to be rendered.
 
 <a name="BlockSelectionClearer" href="#BlockSelectionClearer">#</a> **BlockSelectionClearer**
 

packages/block-editor/src/components/block-edit/context.js

@@ -27,7 +27,7 @@ export { Provider as BlockEditContextProvider };
  *                                     expected to return object of props to
  *                                     merge with the component's own props.
  *
- * @return {Component} Enhanced component with injected context as props.
+ * @return {WPComponent} Enhanced component with injected context as props.
  */
 export const withBlockEditContext = ( mapContextToProps ) => createHigherOrderComponent( ( OriginalComponent ) => {
 	return ( props ) => (
@@ -46,9 +46,9 @@ export const withBlockEditContext = ( mapContextToProps ) => createHigherOrderCo
  * A Higher Order Component used to render conditionally the wrapped
  * component only when the BlockEdit has selected state set.
  *
- * @param {Component} OriginalComponent Component to wrap.
+ * @param {WPComponent} OriginalComponent Component to wrap.
  *
- * @return {Component} Component which renders only when the BlockEdit is selected.
+ * @return {WPComponent} Component which renders only when the BlockEdit is selected.
  */
 export const ifBlockEditSelected = createHigherOrderComponent( ( OriginalComponent ) => {
 	return ( props ) => (

packages/block-editor/src/components/block-list/breadcrumb.js

@@ -16,7 +16,7 @@ import BlockTitle from '../block-title';
  * the root block.
  *
  * @param {string}   props.clientId        Client ID of block.
- * @return {WPElement} Block Breadcrumb.
+ * @return {WPComponent} The component to be rendered.
  */
 const BlockBreadcrumb = forwardRef( ( { clientId }, ref ) => {
 	const { setNavigationMode } = useDispatch( 'core/block-editor' );

packages/block-editor/src/components/block-preview/index.js

@@ -137,7 +137,7 @@ export function BlockPreview( { blocks, viewportWidth = 700, padding, settings }
  *
  * @param {Array|Object} blocks A block instance (object) or an array of blocks to be previewed.
  * @param {number} viewportWidth Width of the preview container in pixels. Controls at what size the blocks will be rendered inside the preview. Default: 700.
- * @return {WPElement} Rendered element.
+ * @return {WPComponent} The component to be rendered.
  */
 export default withSelect( ( select ) => {
 	return {

packages/block-editor/src/components/colors/with-colors.js

@@ -49,7 +49,7 @@ const withEditorColorPalette = () => withSelect( ( select ) => {
  * @param {Array}    colorTypes       An array of color types (e.g. 'backgroundColor, borderColor).
  * @param {Function} withColorPalette A HOC for injecting the 'colors' prop into the WrappedComponent.
  *
- * @return {Component} The component that can be used as a HOC.
+ * @return {WPComponent} The component that can be used as a HOC.
  */
 function createColorHOC( colorTypes, withColorPalette ) {
 	const colorMap = reduce( colorTypes, ( colorObject, colorType ) => {

packages/block-editor/src/components/ignore-nested-events/index.js

@@ -20,7 +20,7 @@ import { Component, forwardRef, createElement } from '@wordpress/element';
  * element should stop propagation but not invoke a callback handler, since it
  * would be assumed these are invoked by the child element.
  *
- * @type {Component}
+ * @type {WPComponent}
  */
 export class IgnoreNestedEvents extends Component {
 	constructor() {

packages/block-editor/src/components/media-upload/index.js

@@ -8,7 +8,7 @@ import { withFilters } from '@wordpress/components';
  * an integration with the core blocks that handle media files. By default it renders nothing but
  * it provides a way to have it overridden with the `editor.MediaUpload` filter.
  *
- * @return {WPElement} Media upload element.
+ * @return {WPComponent} The component to be rendered.
  */
 const MediaUpload = () => null;
 

packages/block-editor/src/components/provider/index.js

@@ -73,8 +73,8 @@ class BlockEditorProvider extends Component {
 	 * This needs to be done synchronously after state changes (instead of using
 	 * `componentDidUpdate`) in order to avoid batching these changes.
 	 *
-	 * @param {WPDataRegistry} registry     Registry from which block editor
-	 *                                      dispatch is to be overriden.
+	 * @param {WPDataRegistry} registry Registry from which block editor
+	 *                                  dispatch is to be overridden.
 	 */
 	attachChangeObserver( registry ) {
 		if ( this.unsubscribe ) {

packages/block-editor/src/components/provider/index.native.js

@@ -75,8 +75,8 @@ class BlockEditorProvider extends Component {
 	 * This needs to be done synchronously after state changes (instead of using
 	 * `componentDidUpdate`) in order to avoid batching these changes.
 	 *
-	 * @param {WPDataRegistry} registry     Registry from which block editor
-	 *                                      dispatch is to be overriden.
+	 * @param {WPDataRegistry} registry Registry from which block editor
+	 *                                  dispatch is to be overridden.
 	 */
 	attachChangeObserver( registry ) {
 		if ( this.unsubscribe ) {

packages/block-editor/src/components/rich-text/remove-browser-shortcuts.js

@@ -40,6 +40,6 @@ const SHORTCUTS_ELEMENT = (
  * Component which registered keyboard event handlers to prevent default
  * behaviors for key combinations otherwise handled internally by RichText.
  *
- * @return {WPElement} WordPress element.
+ * @return {WPComponent} The component to be rendered.
  */
 export const RemoveBrowserShortcuts = () => SHORTCUTS_ELEMENT;

packages/block-editor/src/components/typewriter/index.js

@@ -100,7 +100,7 @@ class Typewriter extends Component {
 	 * Maintains the scroll position after a selection change caused by a
 	 * keyboard event.
 	 *
-	 * @param {SyntheticEvent} event Synthetic keyboard event.
+	 * @param {WPSyntheticEvent} event Synthetic keyboard event.
 	 */
 	maintainCaretPosition( { keyCode } ) {
 		if ( ! this.isSelectionEligibleForScroll() ) {

packages/block-editor/src/hooks/anchor.js

@@ -56,9 +56,9 @@ export function addAttribute( settings ) {
  * Override the default edit UI to include a new block inspector control for
  * assigning the anchor ID, if block supports anchor.
  *
- * @param {Function|Component} BlockEdit Original component.
+ * @param {WPComponent} BlockEdit Original component.
  *
- * @return {string} Wrapped component.
+ * @return {WPComponent} Wrapped component.
  */
 export const withInspectorControl = createHigherOrderComponent( ( BlockEdit ) => {
 	return ( props ) => {

packages/block-editor/src/hooks/custom-class-name.js

@@ -47,9 +47,9 @@ export function addAttribute( settings ) {
  * Override the default edit UI to include a new block inspector control for
  * assigning the custom class name, if block supports custom class name.
  *
- * @param {Function|Component} BlockEdit Original component.
+ * @param {WPComponent} BlockEdit Original component.
  *
- * @return {string} Wrapped component.
+ * @return {WPComponent} Wrapped component.
  */
 export const withInspectorControl = createHigherOrderComponent( ( BlockEdit ) => {
 	return ( props ) => {

packages/block-editor/src/store/selectors.js

@@ -29,6 +29,16 @@ import {
 } from '@wordpress/blocks';
 import { SVG, Rect, G, Path } from '@wordpress/components';
 
+/**
+ * A block selection object.
+ *
+ * @typedef {Object} WPBlockSelection
+ *
+ * @property {string} clientId     A block client ID.
+ * @property {string} attributeKey A block attribute key.
+ * @property {number} offset       A block attribute offset.
+ */
+
 // Module constants
 
 /**
@@ -281,14 +291,6 @@ export function getBlockCount( state, rootClientId ) {
 	return getBlockOrder( state, rootClientId ).length;
 }
 
-/**
- * @typedef {WPBlockSelection} A block selection object.
- *
- * @property {string} clientId     A block client ID.
- * @property {string} attributeKey A block attribute key.
- * @property {number} offset       A block attribute offset.
- */
-
 /**
  * Returns the current selection start block client ID, attribute key and text
  * offset.
@@ -1123,9 +1125,9 @@ const canIncludeBlockTypeInInserter = ( state, blockType, rootClientId ) => {
  * @param {Object}  state        Editor state.
  * @param {?string} rootClientId Optional root client ID of block list.
  *
- * @return {Editor.InserterItem[]} Items that appear in inserter.
+ * @return {WPEditorInserterItem[]} Items that appear in inserter.
  *
- * @typedef {Object} Editor.InserterItem
+ * @typedef {Object} WPEditorInserterItem
  * @property {string}   id                Unique identifier for the item.
  * @property {string}   name              The type of block to create.
  * @property {Object}   initialAttributes Attributes to pass to the newly created block.

packages/blocks/README.md

@@ -768,7 +768,7 @@ wrapped component.
 
 _Returns_
 
--   `Component`: Enhanced component with injected BlockContent as prop.
+-   `WPComponent`: Enhanced component with injected BlockContent as prop.
 
 
 <!-- END TOKEN(Autogenerated API docs) -->

packages/blocks/src/api/registration.js

@@ -60,11 +60,11 @@ import { DEPRECATED_ENTRY_KEYS } from './constants';
 /**
  * Defined behavior of a block type.
  *
- * @typedef {Object} WPBlockType
+ * @typedef {Object} WPBlock
  *
- * @property {string}           name        Block type's namespaced name.
- * @property {string}           title       Human-readable block type label.
- * @property {string}           category    Block type category classification,
+ * @property {string}          name         Block type's namespaced name.
+ * @property {string}          title        Human-readable block type label.
+ * @property {string}          category     Block type category classification,
  *                                          used in search interfaces to arrange
  *                                          block types by category.
  * @property {WPBlockTypeIcon} [icon]       Block type icon.
@@ -74,7 +74,7 @@ import { DEPRECATED_ENTRY_KEYS } from './constants';
  * @property {WPComponent}     [save]       Optional component describing
  *                                          serialized markup structure of a
  *                                          block type.
- * @property {WPComponent}      edit        Component rendering an element to
+ * @property {WPComponent}     edit         Component rendering an element to
  *                                          manipulate the attributes of a block
  *                                          in the context of an editor.
  */
@@ -114,7 +114,7 @@ export function unstable__bootstrapServerSideBlockDefinitions( definitions ) { /
  * @param {Object} settings Block settings.
  *
  * @return {?WPBlock} The block, if it has been successfully registered;
- *                     otherwise `undefined`.
+ *                    otherwise `undefined`.
  */
 export function registerBlockType( name, settings ) {
 	settings = {
@@ -234,7 +234,7 @@ export function registerBlockType( name, settings ) {
  * @param {string} name Block name.
  *
  * @return {?WPBlock} The previous block value, if it has been successfully
- *                     unregistered; otherwise `undefined`.
+ *                    unregistered; otherwise `undefined`.
  */
 export function unregisterBlockType( name ) {
 	const oldBlock = select( 'core/blocks' ).getBlockType( name );

packages/blocks/src/api/serializer.js

@@ -85,9 +85,9 @@ export function getSaveElement( blockTypeOrName, attributes, innerBlocks = [] )
 		/**
 		 * Filters the props applied to the block save result element.
 		 *
-		 * @param {Object}      props      Props applied to save element.
-		 * @param {WPBlockType} blockType  Block type definition.
-		 * @param {Object}      attributes Block attributes.
+		 * @param {Object}  props      Props applied to save element.
+		 * @param {WPBlock} blockType  Block type definition.
+		 * @param {Object}  attributes Block attributes.
 		 */
 		const props = applyFilters(
 			'blocks.getSaveContent.extraProps',
@@ -104,9 +104,9 @@ export function getSaveElement( blockTypeOrName, attributes, innerBlocks = [] )
 	/**
 	 * Filters the save result of a block during serialization.
 	 *
-	 * @param {WPElement}   element    Block save result.
-	 * @param {WPBlockType} blockType  Block type definition.
-	 * @param {Object}      attributes Block attributes.
+	 * @param {WPElement} element    Block save result.
+	 * @param {WPBlock}   blockType  Block type definition.
+	 * @param {Object}    attributes Block attributes.
 	 */
 	element = applyFilters( 'blocks.getSaveElement', element, blockType, attributes );
 

packages/blocks/src/block-content-provider/index.js

@@ -26,7 +26,7 @@ const { Consumer, Provider } = createContext( () => {} );
  * </BlockContentProvider>
  * ```
  *
- * @return {WPElement} Element with BlockContent injected via context.
+ * @return {WPComponent} Element with BlockContent injected via context.
  */
 const BlockContentProvider = ( { children, innerBlocks } ) => {
 	const BlockContent = () => {
@@ -48,7 +48,7 @@ const BlockContentProvider = ( { children, innerBlocks } ) => {
  * A Higher Order Component used to inject BlockContent using context to the
  * wrapped component.
  *
- * @return {Component} Enhanced component with injected BlockContent as prop.
+ * @return {WPComponent} Enhanced component with injected BlockContent as prop.
  */
 export const withBlockContentContext = createHigherOrderComponent( ( OriginalComponent ) => {
 	return ( props ) => (

packages/components/src/autocomplete/index.js

@@ -91,7 +91,7 @@ import withSpokenMessages from '../higher-order/with-spoken-messages';
  */
 
 /**
- * @typedef {Object} Completer
+ * @typedef {Object} WPCompleter
  * @property {string} name a way to identify a completer, useful for selective overriding.
  * @property {?string} className A class to apply to the popup menu.
  * @property {string} triggerPrefix the prefix that will display the menu.
@@ -232,8 +232,8 @@ export class Autocomplete extends Component {
 	/**
 	 * Load options for an autocompleter.
 	 *
-	 * @param {Completer} completer The autocompleter.
-	 * @param {string}    query     The query, if any.
+	 * @param {WPCompleter} completer The autocompleter.
+	 * @param {string}      query     The query, if any.
 	 */
 	loadOptions( completer, query ) {
 		const { options } = completer;

packages/components/src/date-time/date.js

@@ -65,7 +65,7 @@ class DatePicker extends Component {
 	 * object representing now. If a null value is passed, return a null value.
 	 *
 	 * @param {?string} currentDate Date representing the currently selected date or null to signify no selection.
-	 * @return {?Moment} Moment object for selected date or null.
+	 * @return {?moment.Moment} Moment object for selected date or null.
 	 */
 	getMomentDate( currentDate ) {
 		if ( null === currentDate ) {

packages/components/src/higher-order/with-focus-return/index.js

@@ -36,11 +36,11 @@ function isComponentLike( object ) {
  * when the component is unmounted.
  *
  * @param {(WPComponent|Object)} options The component to be enhanced with
- *                                       focus return behavior, or an object
- *                                       describing the component and the
- *                                       focus return characteristics.
+ *                                      focus return behavior, or an object
+ *                                      describing the component and the
+ *                                      focus return characteristics.
  *
- * @return {Component} Component with the focus restauration behaviour.
+ * @return {WPComponent} Component with the focus restauration behaviour.
  */
 function withFocusReturn( options ) {
 	// Normalize as overloaded form `withFocusReturn( options )( Component )`

packages/components/src/higher-order/with-notices/index.js

@@ -17,8 +17,9 @@ import NoticeList from '../../notice/list';
 /**
  * Override the default edit UI to include notices if supported.
  *
- * @param  {Function|Component} OriginalComponent Original component.
- * @return {Component}                            Wrapped component.
+ * @param  {WPComponent} OriginalComponent Original component.
+ *
+ * @return {WPComponent} Wrapped component.
  */
 export default createHigherOrderComponent( ( OriginalComponent ) => {
 	return class WrappedBlockEdit extends Component {

packages/components/src/higher-order/with-spoken-messages/index.js

@@ -14,9 +14,9 @@ import { createHigherOrderComponent } from '@wordpress/compose';
  * A Higher Order Component used to be provide a unique instance ID by
  * component.
  *
- * @param {WPElement} WrappedComponent  The wrapped component.
+ * @param {WPComponent} WrappedComponent  The wrapped component.
  *
- * @return {Component} Component with an instanceId prop.
+ * @return {WPComponent} The component to be rendered.
  */
 export default createHigherOrderComponent( ( WrappedComponent ) => {
 	return class extends Component {

packages/components/src/menu-item/index.js

@@ -18,7 +18,7 @@ import IconButton from '../icon-button';
 /**
  * Renders a generic menu item for use inside the more menu.
  *
- * @return {WPElement} More menu item.
+ * @return {WPComponent} The component to be rendered.
  */
 export function MenuItem( {
 	children,