From 7e4d312aed205698e986ee845580e1f8bb0bd784 Mon Sep 17 00:00:00 2001 From: hawkgs Date: Fri, 29 Nov 2024 15:27:37 +0200 Subject: [PATCH] feat(docs-infra): remove redundant JSDoc transform related to code examples (#59004) The transform is no longer relevant nor it served any functional purpose. PR Close #59004 --- .../rendering/transforms/jsdoc-transforms.ts | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/adev/shared-docs/pipeline/api-gen/rendering/transforms/jsdoc-transforms.ts b/adev/shared-docs/pipeline/api-gen/rendering/transforms/jsdoc-transforms.ts index dbc659efb1f..75ab234fad8 100644 --- a/adev/shared-docs/pipeline/api-gen/rendering/transforms/jsdoc-transforms.ts +++ b/adev/shared-docs/pipeline/api-gen/rendering/transforms/jsdoc-transforms.ts @@ -101,9 +101,7 @@ export function addHtmlUsageNotes(entry: T): T & HasHtml ({name}) => name === JS_DOC_USAGE_NOTES_TAG || name === JS_DOC_REMARKS_TAG, ); const htmlUsageNotes = usageNotesTag - ? (marked.parse( - convertJsDocExampleToHtmlExample(wrapExampleHtmlElementsWithCode(usageNotesTag.comment)), - ) as string) + ? (marked.parse(wrapExampleHtmlElementsWithCode(usageNotesTag.comment)) as string) : ''; const transformedHtml = addApiLinksToHtml(htmlUsageNotes); @@ -178,17 +176,6 @@ function wrapExampleHtmlElementsWithCode(text: string) { .replace(/''/g, ``); } -function convertJsDocExampleToHtmlExample(text: string): string { - const codeExampleAtRule = /{@example (\S+) region=(['"])([^'"]+)\2\s*}/g; - - return text.replace( - codeExampleAtRule, - (_: string, path: string, separator: string, region: string) => { - return ``; - }, - ); -} - /** * Converts {@link } tags into html anchor elements */