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

Add or rename symbol #2757

Open
HLuizFilipe opened this issue Oct 22, 2024 · 1 comment
Open

Add or rename symbol #2757

HLuizFilipe opened this issue Oct 22, 2024 · 1 comment
Labels
question Question about functionality

Comments

@HLuizFilipe
Copy link

I'm in a project which we define entities (or business model, from Hexagonal Architecture) as Interface.

When exported/documented, shows up in the doc.

The trick part is we want to change the name of "Interfaces" by "Entities".

Example:

/**
 * @entity - This tag is something I found how to add/create
 */
interface MyLittleEntity {
    name: string
    country: country
}

And showing up like the screenshot below I've crafted

image

I'm trying to reverse engineering some plugins and reading the documentation, but looks like "there is no way" to add a new Symbol, or I just didn't find yet.

Is there someone that can help me?

Thanks

Search terms

symbol
plugin
reverse engineering

Question

@HLuizFilipe HLuizFilipe added the question Question about functionality label Oct 22, 2024
@manticorp
Copy link

Can you just use @group Entities ?

/**
 * @group Entities
 */
interface MyLittleEntity {
    name: string
    country: string
}

This generates the following:

image

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