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
Well.. TS 5.5 is almost out along with @import support. What I have noticed in testing is that TSC will retain the @import JSDoc comment blocks when generating declarations from ESM code. In the declarations the correct action import statements are added, but the JSDoc @import comment block is not removed. This can cause minor documentation issues if the next symbol in the declarations doesn't have an associated comment block.. Say a class, or whatever comes next. Here is an example where Test doesn't have a leading comment block (test.d.ts) and thus TypeDoc will pick up the @import comment as associated with Test.
TypeDoc will treat @import like any other unknown tag and output it:
It's a relatively small issue, but one that I'm on the fence whether it is appropriate to post in the Typescript repo, so I'm seeking your opinion. I think all @import only comment blocks can be removed from generated declarations and maybe it's just an oversight from the TS team.
The text was updated successfully, but these errors were encountered:
Well that's annoying, I added code to make TypeDoc ignore @import comments, but I only added it for the file comment parser, I didn't consider the case you described here. This is a bug!
Well.. TS 5.5 is almost out along with
@import
support. What I have noticed in testing is that TSC will retain the@import
JSDoc comment blocks when generating declarations from ESM code. In the declarations the correct actionimport
statements are added, but the JSDoc@import
comment block is not removed. This can cause minor documentation issues if the next symbol in the declarations doesn't have an associated comment block.. Say a class, or whatever comes next. Here is an example whereTest
doesn't have a leading comment block (test.d.ts
) and thus TypeDoc will pick up the@import
comment as associated withTest
.TypeDoc will treat
@import
like any other unknown tag and output it:It's a relatively small issue, but one that I'm on the fence whether it is appropriate to post in the Typescript repo, so I'm seeking your opinion. I think all
@import
only comment blocks can be removed from generated declarations and maybe it's just an oversight from the TS team.The text was updated successfully, but these errors were encountered: