Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
ahocevar opened this issue Jul 28, 2022 · 0 comments
Labels
bug Functionality does not match expectation

Comments

@ahocevar
Copy link
Contributor

ahocevar commented Jul 28, 2022

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
@ahocevar ahocevar added the bug Functionality does not match expectation label Jul 28, 2022
@ahocevar ahocevar changed the title v0.23 regression: Descriptions from JSDoc Object typedefs are no longer picked up v0.23 regression: Property descriptions from JSDoc Object typedefs are no longer picked up Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant