From a7abd5f35b5152f0ae9671b90622bdd3ad3cf024 Mon Sep 17 00:00:00 2001 From: mufaddal motiwala Date: Tue, 8 Feb 2022 12:09:31 +0530 Subject: [PATCH] jsDoc comment added Signed-off-by: mufaddal motiwala --- plugins/newrelic-dashboard/api-report.md | 4 +--- plugins/newrelic-dashboard/src/plugin.ts | 9 ++++++++- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/plugins/newrelic-dashboard/api-report.md b/plugins/newrelic-dashboard/api-report.md index 260efb47a6..cff24d90c6 100644 --- a/plugins/newrelic-dashboard/api-report.md +++ b/plugins/newrelic-dashboard/api-report.md @@ -9,9 +9,7 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "DashboardSnapshotComponent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const DashboardSnapshotComponent: ({ guid, name, diff --git a/plugins/newrelic-dashboard/src/plugin.ts b/plugins/newrelic-dashboard/src/plugin.ts index dc3b18e453..9bfecff18f 100644 --- a/plugins/newrelic-dashboard/src/plugin.ts +++ b/plugins/newrelic-dashboard/src/plugin.ts @@ -60,7 +60,14 @@ export const EntityNewRelicDashboardCard = newRelicDashboardPlugin.provide( }, }), ); - +/** + * Render dashboard snapshots from Newrelic in backstage. Use dashboards which have the tag `isDashboardPage: true` + * + * @remarks + * This can be helpful for rendering dashboards outside of Entity Catalog. + * + * @public + */ export const DashboardSnapshotComponent = newRelicDashboardPlugin.provide( createComponentExtension({ name: 'DashboardSnapshotComponent',