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
Aww shoot, I broke this nearly 2 years ago now, you're the first to notice. The root cause of this is TypeDoc not treating comments as a first-class citizen where they are created when a reflection is created... instead doing it on a "created" event. This works most of the time, but not in this case, because the reflection was finalized (which is when comments are attached) after type parameters were created, but the @typeParam handling expects the comment to be there when the type parameter is created.
The right solution to this is to do comments on reflection construction (actually, before, but even that would be an improvement. I plan to do this with 0.23), but for now a fix is just to swap the order of finalization and type parameter construction.
Expected Behavior
I would expect to be able to document a type parameter on a type alias like so:
Actual Behavior
The documentation shows up in a tagged section rather than under the type parameter:
Steps to reproduce the bug
Just run
npx typedoc test.ts
on the above code.Environment
The text was updated successfully, but these errors were encountered: