From c77e0acf01cd6cdd491e9adfbf8737a7c4370dbe Mon Sep 17 00:00:00 2001 From: Alice Pote Date: Tue, 6 Dec 2022 13:57:59 -0500 Subject: [PATCH] chore(util): update list of suppressed JSDoc tags to align with Framework 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. --- src/utils/util.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/util.ts b/src/utils/util.ts index 24b4c7bdc68..7a810a20d95 100644 --- a/src/utils/util.ts +++ b/src/utils/util.ts @@ -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 = ['virtualProp', 'slot', 'part', 'internal']; /** * Create a stylistically-appropriate JS variable name from a filename