From 7df591442e0935b5cc085c2551fcb45b57628f21 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Tue, 11 May 2021 14:45:46 +0200 Subject: [PATCH] Docs: fix grafana/ui docsExtract REF_NOT_FOUND errors (#33905) * fix(grafana-ui): re-export commonOptionsBuilder namespace for api-extractor to work * docs(grafana-ui): add docblock annotations for exported interfaces * docs(grafana-ui): export ScaleDistribution from uplot --- packages/grafana-ui/src/components/index.ts | 1 + packages/grafana-ui/src/components/uPlot/models.gen.ts | 3 +++ packages/grafana-ui/src/options/index.ts | 3 ++- packages/grafana-ui/src/options/models.gen.ts | 3 +++ 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/packages/grafana-ui/src/components/index.ts b/packages/grafana-ui/src/components/index.ts index 46ca959c97a..d270b248a10 100644 --- a/packages/grafana-ui/src/components/index.ts +++ b/packages/grafana-ui/src/components/index.ts @@ -227,6 +227,7 @@ export { LegacyForms, LegacyInputStatus }; // WIP, need renames and exports cleanup export * from './uPlot/config'; +export { ScaleDistribution } from './uPlot/models.gen'; export { UPlotConfigBuilder } from './uPlot/config/UPlotConfigBuilder'; export { UPlotChart } from './uPlot/Plot'; export * from './uPlot/geometries'; diff --git a/packages/grafana-ui/src/components/uPlot/models.gen.ts b/packages/grafana-ui/src/components/uPlot/models.gen.ts index c157e138303..b4b39742159 100644 --- a/packages/grafana-ui/src/components/uPlot/models.gen.ts +++ b/packages/grafana-ui/src/components/uPlot/models.gen.ts @@ -27,6 +27,9 @@ export enum LineInterpolation { StepAfter = 'stepAfter', StepBefore = 'stepBefore', } +/** + * @alpha + */ export enum ScaleDistribution { Linear = 'linear', Log = 'log', diff --git a/packages/grafana-ui/src/options/index.ts b/packages/grafana-ui/src/options/index.ts index cb2a99d4f6d..9aa58e65759 100644 --- a/packages/grafana-ui/src/options/index.ts +++ b/packages/grafana-ui/src/options/index.ts @@ -1,4 +1,5 @@ // namespace is too big -export * as commonOptionsBuilder from './builder'; +import * as commonOptionsBuilder from './builder'; +export { commonOptionsBuilder }; export * from './models.gen'; diff --git a/packages/grafana-ui/src/options/models.gen.ts b/packages/grafana-ui/src/options/models.gen.ts index af27807f54e..6a378394f3c 100644 --- a/packages/grafana-ui/src/options/models.gen.ts +++ b/packages/grafana-ui/src/options/models.gen.ts @@ -2,6 +2,9 @@ import { VizLegendOptions } from '../components'; +/** + * @alpha + */ export interface OptionsWithLegend { legend: VizLegendOptions; }