eui icon indicating copy to clipboard operation
eui copied to clipboard

[Docs] Handle JSDoc annotations

Open weronikaolejniczak opened this issue 7 months ago • 1 comments

The purpose of this task is to handle more edge-case JSDoc annotations. We currently handle internal references with @link (see PR) but there are cases like external links and @see that need updated logic.

Examples

@see {@link Foobar}

ref in https://eui.elastic.co/pr_8543/docs/components/display/badge/#EuiBadgeGroup

@see {@link https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom React Docs}

JSDoc comments from extending types

aria-label in many places

@see aria-labelledby

External links in @link and @see

language in https://eui.elastic.co/pr_8543/docs/components/display/code/#EuiCode

@see https://prismjs.com/#supported-languages for options

weronikaolejniczak avatar May 05 '25 11:05 weronikaolejniczak