Skip to content

Commit

Permalink
Fix three warnings when the documentation is generated (issue Orange-…
Browse files Browse the repository at this point in the history
…OpenSource#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.
  • Loading branch information
sebnic committed Jun 9, 2024
1 parent 1fb7b2e commit 5572397
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/ods-charts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
3 changes: 3 additions & 0 deletions src/theme/ODS.project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
// This software is distributed under the MIT license.
//

/**
* Echarts theme options
*/
export interface EChartsProject {
color: string[];
backgroundColor: string;
Expand Down
2 changes: 1 addition & 1 deletion src/theme/ods-chart-theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 5572397

Please sign in to comment.