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

Namespace comments not included #1973

Closed
ClintH opened this issue Jun 30, 2022 · 2 comments
Closed

Namespace comments not included #1973

ClintH opened this issue Jun 30, 2022 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@ClintH
Copy link

ClintH commented Jun 30, 2022

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

  • Typedoc version: latest
  • TypeScript version: latest
  • Node.js version: 17.3.1
  • OS: Windows
@ClintH ClintH added the bug Functionality does not match expectation label Jun 30, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 1, 2022

Thanks for the awesome repro! Looks like I messed up here... properly handling comment discovery is hard.

@Gerrit0 Gerrit0 closed this as completed in 92df4e7 Jul 1, 2022
Gerrit0 added a commit that referenced this issue Jul 1, 2022
@ClintH
Copy link
Author

ClintH commented Jul 4, 2022

Great work! :)

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

2 participants