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

interface uses @group, class that implements it remains ungrouped #2459

Closed
RobMayer opened this issue Dec 12, 2023 · 1 comment
Closed

interface uses @group, class that implements it remains ungrouped #2459

RobMayer opened this issue Dec 12, 2023 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@RobMayer
Copy link

Search terms

@group interface class inherit implements

Question

I have an interface, like so

export interface IThing<T> {

    /**
     * Does a thing
     * @param {string} key The key to check.
     * @returns {boolean} True if the key exists, false otherwise
     * @category Query
     */
    has(key: string): boolean;
 }

and a class that implements it

export class ActualThing<T> implements IThing<T> {
    //...

    has(key: string): boolean {
        //...
    }

at present the methods within the IThing are grouped, but methods within the ActualThing are not, though all the documentation details are. Is there a way to have the class typedoc get grouped according to the interface without having to duplicate all the doc details?

@RobMayer RobMayer added the question Question about functionality label Dec 12, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 17, 2023

Unfortunately not possible with the current implementation. I think both @group and @category should be inherited, and consider this a bug.

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