We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
constructor properties
Documented parameters within a constructor should also be documented in the output.
Is it possible to also use the doc added to the constructor property?
class A { constructor( /** * I want to see this comment in the documentation * / readonly property: string) {} }
The generated documentation does include the parameter property but does not include the documentation of the parameter.
property
I can add a doc to the constructor itself but I can not add the same options as documenting the property directly like
class A { /** * I want to see this comment in the documentation * / readonly property: string }
> typedoc --version TypeDoc 0.23.9 Using TypeScript 4.7.4 from ./node_modules/typescript/lib > node --version v16.14.0
The text was updated successfully, but these errors were encountered:
Seems reasonable to me 👍
Sorry, something went wrong.
23bde9a
No branches or pull requests
Search terms
constructor properties
Expected Behavior
Documented parameters within a constructor should also be documented in the output.
Is it possible to also use the doc added to the constructor property?
Actual Behavior
The generated documentation does include the parameter
property
but does not include the documentation of the parameter.I can add a doc to the constructor itself but I can not add the same options as documenting the property directly like
Steps to reproduce the bug
Environment
The text was updated successfully, but these errors were encountered: