Skip to content

v0.23 regression: Property descriptions from JSDoc Object typedefs are no longer picked up #2020

@ahocevar

Description

@ahocevar

Search terms

jsdoc, typedef

Expected Behavior

A simple Object typedef with property descriptions like

/**
 * @typedef {Object} Options
 * @property {string} url - The url to send the request to.
 * @property {string} [apiKey] - The API key to use for the request.
 */

should output a documentation like
good
Note the descriptions for all properties are correctly listed. The output in the screenshot is from v0.22.x.

Actual Behavior

In v0.23.x, the properties are listed without the descriptions:
bad

Steps to reproduce the bug

This minimal repo has everything to reproduce the bug: https://github.com/ahocevar/typedoc-bug. See README.md for instructions.

Environment

  • Typedoc version: 0.23.9
  • TypeScript version: 4.7.4
  • Node.js version: 16.14.2
  • OS: MacOS Monterey 12.4

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions