Skip to content

[Docs] Handle JSDoc annotations #8681

Open
Open
@weronikaolejniczak

Description

@weronikaolejniczak

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssues or PRs that only affect documentation - will not need changelog entries

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions