You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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:
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
Search terms
jsdoc, typedef
Expected Behavior
A simple Object typedef with property descriptions like
should output a documentation like
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:
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
The text was updated successfully, but these errors were encountered: