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

Generic type instantiation lost #32

Closed
JeroMiya opened this issue Sep 13, 2014 · 2 comments
Closed

Generic type instantiation lost #32

JeroMiya opened this issue Sep 13, 2014 · 2 comments

Comments

@JeroMiya
Copy link

When referencing a generic type with a specific type instantiation, the documentation only shows the name of the generic type and not the specific types.

note: "A of B" means A leftBracket B rightBracket (formatting fail, sorry)
example:
interface ITest of T {
field: T;
}

interface IFoo {
specificTest: ITest of string;
}

For IFoo.specificTest, I would expect to see in the documentation that the type of specificTest is ITest for T: string. Currently, all that is shown is that specificTest is an ITest.

Also, the generated documentation for ITest only indicates that ITest is generic in the type of field ("field: T in ITest of T"). It should show the generic type arguments at the top of the page for the interface.

@sebastian-lenz sebastian-lenz added the enhancement Improved functionality label Sep 20, 2014
@sebastian-lenz
Copy link
Member

The support for generics in TypeDoc is currently very basic. I've tested some simple cases and TypeDoc runs fine but, you are right, the produced documentation for generics is not optimal. We must include a better support in one of the next versions.

@sebastian-lenz
Copy link
Member

This should be fixed with version 0.2 which introduces better handling of generics.

@Gerrit0 Gerrit0 removed the enhancement Improved functionality label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants