From 55723977cd0214d42da8393ea11c9225affc4cde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Nicaisse?= Date: Sun, 9 Jun 2024 21:11:01 +0200 Subject: [PATCH] Fix three warnings when the documentation is generated (issue #211) [warning] The signature getThemeManager has an @param with name "options:", which was not used. [warning] The signature ODSChartsTheme.getThemeManager has an @param with name "options:", which was not used. [warning] EChartsProject, defined in ./src/theme/ODS.project.ts, is referenced by ODSChartsTheme.theme but not included in the documentation. --- src/ods-charts.ts | 1 + src/theme/ODS.project.ts | 3 +++ src/theme/ods-chart-theme.ts | 2 +- 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/ods-charts.ts b/src/ods-charts.ts index a2579e4c..5ff007b3 100644 --- a/src/ods-charts.ts +++ b/src/ods-charts.ts @@ -21,6 +21,7 @@ import { ODSChartsTheme } from './theme/ods-chart-theme'; export * from './theme/ods-chart-theme'; +export * from './theme/ODS.project'; export * from './theme/css-themes/css-themes'; export * from './theme/popover/ods-chart-popover-definitions'; diff --git a/src/theme/ODS.project.ts b/src/theme/ODS.project.ts index 11619746..33265db4 100644 --- a/src/theme/ODS.project.ts +++ b/src/theme/ODS.project.ts @@ -6,6 +6,9 @@ // This software is distributed under the MIT license. // +/** + * Echarts theme options + */ export interface EChartsProject { color: string[]; backgroundColor: string; diff --git a/src/theme/ods-chart-theme.ts b/src/theme/ods-chart-theme.ts index f56252bd..0aa830ce 100644 --- a/src/theme/ods-chart-theme.ts +++ b/src/theme/ods-chart-theme.ts @@ -269,7 +269,7 @@ export class ODSChartsTheme { * This manager is used to retrieve the Apache ECharts theme and manage the chart options in accordance with the Orange Design System. * * The method takes the theme configuration as a parameter {@link ODSChartsThemeOptions}. - * @param options: default option used to generate the theme + * @param options default option used to generate the theme * @returns the theme manager */ public static getThemeManager(options?: ODSChartsThemeOptions): ODSChartsTheme {