defaultValue rendering defaults to code block

[erickzhao]

Search terms

defaultValue, default, code, formatting, tsdoc, tag

Expected Behavior

When setting a @defaultValue block tag, I expect to be able to link to external sources and use inline tags such as @link.

This is the behavior I get when using VSCode Intellisense as well.

Actual Behavior

When setting a @defaultValue block tag, the entire content of @defaultValue gets formatted as a code block. This prevents inline tags from rendering properly.

I can work around this by adding a piece of inline code within the description, which seems to disable the code block around the entire description.

Steps to reproduce the bug

export interface Test {
  /**
   * An optional filesystem path input that is set internally if not specified by the user.
   *
   * @defaultValue Node.js {@link https://nodejs.org/api/process.html#processexecpath| `process.execPath`} value
   */
  path?: string;

  /**
   * An optional filesystem path input that is set internally if not specified by the user.
   *
   * @defaultValue Node.js {@link https://nodejs.org/api/process.html#processexecpath| `process.execPath`} value `beep boop`
   */
  path2?: string;
}

Minimal repro:

• https://github.com/erickzhao/typedoc-repro
• https://erickzhao.github.io/typedoc-repro/interfaces/Test.html

Environment

• Typedoc version: 0.25.13
• TypeScript version: 5.4.5
• Node.js version: v20.11.0
• OS: macOS 14.5 (Sonoma)

[Gerrit0]

Huh, VSCode updated their criteria... that used to be rendered as code if the block didn't contain a code block, matching TypeDoc's implementation. Easy fix, and I like this way better...