From e37c2b4590d7b343d5ff1101b53f8f2269bf5b64 Mon Sep 17 00:00:00 2001 From: kmarkow Date: Wed, 17 May 2023 14:24:43 -0400 Subject: [PATCH] Fix api-report in plugins/home package Signed-off-by: kmarkow --- plugins/home/api-report.md | 18 ------------------ plugins/home/src/deprecated.ts | 18 +++++++++--------- 2 files changed, 9 insertions(+), 27 deletions(-) diff --git a/plugins/home/api-report.md b/plugins/home/api-report.md index 20849501cd..56b1f54331 100644 --- a/plugins/home/api-report.md +++ b/plugins/home/api-report.md @@ -19,23 +19,15 @@ import { ReactNode } from 'react'; import { RendererProps as RendererProps_2 } from '@backstage/plugin-home-react'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type CardConfig = CardConfig_2; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type CardExtensionProps = CardExtensionProps_2; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type CardLayout = CardLayout_2; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type CardSettings = CardSettings_2; @@ -55,13 +47,9 @@ export const ComponentAccordion: (props: { ContextProvider?: ((props: any) => JSX.Element) | undefined; }) => JSX.Element; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type ComponentParts = ComponentParts_2; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type ComponentRenderer = ComponentRenderer_2; @@ -81,8 +69,6 @@ export const ComponentTabs: (props: { }[]; }) => JSX.Element; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export const createCardExtension: typeof createCardExtension_2; @@ -151,13 +137,9 @@ export type LayoutConfiguration = { height: number; }; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export type RendererProps = RendererProps_2; -// Warning: (tsdoc-at-sign-in-word) The "@" character looks like part of a TSDoc tag; use a backslash to escape it -// // @public @deprecated (undocumented) export const SettingsModal: (props: { open: boolean; diff --git a/plugins/home/src/deprecated.ts b/plugins/home/src/deprecated.ts index 6fe9320316..119e5ab731 100644 --- a/plugins/home/src/deprecated.ts +++ b/plugins/home/src/deprecated.ts @@ -28,46 +28,46 @@ import { /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export const createCardExtension = homeReactCreateCardExtension; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type CardExtensionProps = homeReactCardExtensionProps; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type CardLayout = homeReactCardLayout; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type CardSettings = homeReactCardSettings; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type CardConfig = homeReactCardConfig; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type ComponentParts = homeReactComponentParts; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type ComponentRenderer = homeReactComponentRenderer; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export type RendererProps = homeReactRendererProps; /** * @public - * @deprecated Import from '@backstage/plugin-home-react' instead + * @deprecated Import from `@backstage/plugin-home-react` instead */ export const SettingsModal = homeReactSettingsModal;