Skip to content

Commit

Permalink
chore(util): update list of suppressed JSDoc tags to align with Frame…
Browse files Browse the repository at this point in the history
…work

When #3525 merged it contained a list of JSDoc tags which should be
suppressed from component-level generated documentation in typedef
files. This commit updates that list to add some tags that Framework
would not like to have show up all over the place.
  • Loading branch information
alicewriteswrongs committed Dec 9, 2022
1 parent 2115729 commit c77e0ac
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/utils/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type * as d from '../declarations';
import { dashToPascalCase, isString, toDashCase } from './helpers';
import { buildError } from './message-utils';

const SUPPRESSED_JSDOC_TAGS: string[] = ['internal'];
const SUPPRESSED_JSDOC_TAGS: ReadonlyArray<string> = ['virtualProp', 'slot', 'part', 'internal'];

/**
* Create a stylistically-appropriate JS variable name from a filename
Expand Down

0 comments on commit c77e0ac

Please sign in to comment.