You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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.
The text was updated successfully, but these errors were encountered: