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

intentionallyNotExported not working with symbols addressed in namespaces (. separated) #1972

Closed
frank-weindel opened this issue Jun 29, 2022 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@frank-weindel
Copy link

frank-weindel commented Jun 29, 2022

I encountered the following warning:

./src/animation/TransitionSettings.d.mts:5:2 - warning TransitionSettings.Literal is referenced by default.Element.SmoothLiteral but not included in the documentation.

5      export interface Literal {

I decided that this was intentional so I added the following to the intentionallyNotExported array:

"src/animation/TransitionSettings.d.mts:TransitionSettings.Literal"

TransitionSettings is a namespace (the file also exports a class with the same name)

Seems to be an issue with the .?

Search terms

warning is referenced by but not included in the documentation.

Expected Behavior

The warning goes away

Actual Behavior

The warning remains And an additional new warning is generated:

warning The following symbols were marked as intentionally not exported, but were either not referenced in the documentation, or were exported:
	src/animation/TransitionSettings.d.mts:TransitionSettings.Literal

Steps to reproduce the bug

See above

Environment

  • Typedoc version: 0.23.2
  • TypeScript version: 4.7.4
  • Node.js version: 16.14.0
  • OS: MacOS 12.2.1
@frank-weindel frank-weindel added the bug Functionality does not match expectation label Jun 29, 2022
@TypeStrong TypeStrong deleted a comment from Dayday10 Jun 30, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 30, 2022

Hmm, It looks like I forgot that type names are prefixed with namespace names if applicable when implementing that function. Easy fix at least!

@frank-weindel
Copy link
Author

Thank you!

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