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

Everything exported as TypeObjectName #2750

Closed
Code-Quake opened this issue Oct 15, 2024 · 2 comments
Closed

Everything exported as TypeObjectName #2750

Code-Quake opened this issue Oct 15, 2024 · 2 comments
Labels
question Question about functionality

Comments

@Code-Quake
Copy link

Search terms

Question

I have an object declared this way:

/**

  • A class for interacting with THS over WAMP. Use ThsClient.create() to create a new instance.
  • @public
    */
    export class MyClient {
    ...random code
    }

TypeDoc generates this header in the documentation:

ClassMyClient

It does that for everything in the project; Namespaces, enums, interfaces. All of it.

How do I get it to generate MyClient instead of ClassMyClient

@Code-Quake Code-Quake added the question Question about functionality label Oct 15, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 16, 2024

There was a bug which caused kind names to be mashed up against the reflection name, #2748

You could do this by (ab)using TypeDoc's locales option option to overwrite the kind translations (these ones) with empty strings.

The right way to do this is with a custom theme which overwrites the header template to remove them, there is no option to remove the type from the header, though I guess the headings option could be extended with a flag for that...

@Code-Quake
Copy link
Author

That was fast. I wrote a theme which removes the type kind. Thanks for the quick response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants