JSDoc Tags

29 recognized tags grouped by where they apply. Unknown tags are not an error: theming token blocks fold them into the description, and member descriptions pass them through verbatim.

• Members 6 tags

  Recognized on properties, methods, host listeners, accessors.

  @param

  Paired with TypeScript type info. Descriptions thread onto constructor args.

  @returns

  Return-value description.

  @example

  Fenced code block, Shiki-highlighted.

  @see

  Appended as a See-also link block.

  @since

  Small version label next to the member name.

  @deprecated

  Strikethrough name plus a deprecation banner. Takes an optional reason string.

• Symbols 5 tags

  Class, interface, enum, type alias, function, variable.

  @example

  Rendered as an Examples block on the Info tab. Multiple allowed.

  @see

  See-also section with link resolution.

  @since / @deprecated

  Same semantics as on members.

  @internal

  Hides the symbol when --disableInternal is set.

  @category

  Groups the entity under this category when --groupBy category.

• Component-only 3 tags

  Recognized only when the symbol is decorated as @Component.

  @slot

  Documents an exposed content slot. Renders as a metadata card on the Info tab.

  @playground

  Author-curated runnable demo. Surfaces a Playground tab with one StackBlitz launcher per block.

  <example-url>

  JSDoc marker pointing at a hosted demo URL. Surfaces an Example tab with an iframe per URL.

• Status badges 3 tags

  Stamp the entity hero with status pills. Visible at the top of the rendered page.

  @beta

  Adds a "Beta" badge.

  @breaking <version>

  Adds a "Breaking" badge that pins the version.

  @since <version>

  Adds a version badge to the entity hero.

• Hero links 5 tags

  External links pinned to the entity hero. One per tag, multiple per entity.

  @github <url>

  GitHub source / repo link.

  @figma <url>

  Figma design file.

  @storybook <url>

  Hosted Storybook entry.

  @stackblitz <url>

  StackBlitz playground.

  @docs <url>

  External documentation page.

• Theming tokens 6 tags

  Parsed from JSDoc on CSS / SCSS files alongside @Component sources.

  @overview

  Description block at the top of the Theming tab.

  @type

  Token type (e.g. color, length, duration).

  @default

  Default value rendered next to the token name.

  @group

  Groups tokens under an H4 in the Theming tab.

  @example / @since / @see

  Same semantics as elsewhere.

  @deprecated

  Optional reason. Empty marks deprecated without a message.

• Inline 1 tag

  Used inside descriptions. Resolved at build time.

  {@link Symbol}

  Project-wide cross-reference. Resolves to a deep link, including across additional pages.

Theming token example

The token block sits above the actual property declaration. @overview blocks at file-level open the Theming tab. Per-token blocks fill the catalog.

/**
 * @overview Card surface tokens.
 */

/**
 * Background of the card body.
 *
 * @type color
 * @default hsl(220 20% 98%)
 * @group Surface
 * @since 1.4.0
 * @example
 *   --color-app-card-bg: var(--color-cdx-bg-elevated);
 */
--color-app-card-bg: hsl(220 20% 98%);