From ebeac7ccc9a0a026b1248823f579c109a3d299ba Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:16:21 -0400 Subject: [PATCH] chore: Add API Reference Signed-off-by: Adam Harvey --- plugins/analytics-module-ga/api-report.md | 2 -- plugins/analytics-module-ga/src/index.ts | 6 ++++++ plugins/apollo-explorer/api-report.md | 2 -- plugins/apollo-explorer/src/index.ts | 6 ++++++ plugins/dynatrace/api-report.md | 2 -- plugins/dynatrace/src/index.ts | 6 ++++++ 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/plugins/analytics-module-ga/api-report.md b/plugins/analytics-module-ga/api-report.md index 557f472f71..f28c919f33 100644 --- a/plugins/analytics-module-ga/api-report.md +++ b/plugins/analytics-module-ga/api-report.md @@ -25,6 +25,4 @@ export class GoogleAnalytics implements AnalyticsApi { }, ): GoogleAnalytics; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/analytics-module-ga/src/index.ts b/plugins/analytics-module-ga/src/index.ts index fca8d91658..7b96c761fb 100644 --- a/plugins/analytics-module-ga/src/index.ts +++ b/plugins/analytics-module-ga/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * Analytics Module plugin for Google Analytics. + * + * @packageDocumentation + */ + export { analyticsModuleGA } from './plugin'; export * from './apis/implementations/AnalyticsApi'; diff --git a/plugins/apollo-explorer/api-report.md b/plugins/apollo-explorer/api-report.md index 1d3b41eac1..66cc473d0b 100644 --- a/plugins/apollo-explorer/api-report.md +++ b/plugins/apollo-explorer/api-report.md @@ -40,6 +40,4 @@ export const apolloExplorerPlugin: BackstagePlugin< {}, {} >; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/apollo-explorer/src/index.ts b/plugins/apollo-explorer/src/index.ts index 6d07535fc3..565557e79f 100644 --- a/plugins/apollo-explorer/src/index.ts +++ b/plugins/apollo-explorer/src/index.ts @@ -13,4 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Integrates Apollo Explorer graphs as a tool to browse GraphQL API endpoints inside Backstage. + * + * @packageDocumentation + */ export { apolloExplorerPlugin, ApolloExplorerPage } from './plugin'; diff --git a/plugins/dynatrace/api-report.md b/plugins/dynatrace/api-report.md index 1677318a9f..1dded736ad 100644 --- a/plugins/dynatrace/api-report.md +++ b/plugins/dynatrace/api-report.md @@ -16,6 +16,4 @@ export const DynatraceTab: () => JSX.Element; // @public export const isDynatraceAvailable: (entity: Entity) => boolean; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/dynatrace/src/index.ts b/plugins/dynatrace/src/index.ts index 0c5da219a5..90688a544f 100644 --- a/plugins/dynatrace/src/index.ts +++ b/plugins/dynatrace/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Dynatrace. + * + * @packageDocumentation + */ + export { dynatracePlugin, DynatraceTab, isDynatraceAvailable } from './plugin';