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
Namespace comments are not included.
In typedoc 0.22.15 I was using comments on export statements to give an overview of a namespace.
export
Example source: https://github.com/ClintH/ixfx/blob/main/src/index.ts#L39 And rendered output: https://clinth.github.io/ixfx/modules/Generators.html
Since upgrading to 0.23.2, these overviews aren't visible. The pull request on the repro hopefully demonstrates the same behaviour.
I've also tried adding the overview comment with a @module tag to no avail.
If an underlying behaviour has changed, is there another way to have some kind of preamble to a namespace/module?
Thanks :)
TypeStrong/typedoc-repros#6
The text was updated successfully, but these errors were encountered:
Thanks for the awesome repro! Looks like I messed up here... properly handling comment discovery is hard.
Sorry, something went wrong.
92df4e7
Additional fixes for #1973
c75aa02
Great work! :)
No branches or pull requests
Search terms
Namespace comments are not included.
Expected Behavior
In typedoc 0.22.15 I was using comments on
export
statements to give an overview of a namespace.Example source: https://github.com/ClintH/ixfx/blob/main/src/index.ts#L39
And rendered output: https://clinth.github.io/ixfx/modules/Generators.html
Actual Behavior
Since upgrading to 0.23.2, these overviews aren't visible. The pull request on the repro hopefully demonstrates the same behaviour.
I've also tried adding the overview comment with a @module tag to no avail.
If an underlying behaviour has changed, is there another way to have some kind of preamble to a namespace/module?
Thanks :)
Steps to reproduce the bug
TypeStrong/typedoc-repros#6
Environment
The text was updated successfully, but these errors were encountered: