Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current Issue
If we do something like this where there's import right after the
@module comment block
, this file will be treated as its own module and will ignore@module Voice
.To fix the above issue without updating
typedoc
npm module, we would need to add dummy comment block before the import statement like below. The reason why this happens is because latest typescript only treats a comment block at the top of the file when there's no code below it. This is a known issue and discussed here TypeStrong#603Fix typedoc module
Ideally, this needs to be fixed in the typedoc npm module. There's a recommended fix mentioned in the github issue above (TypeStrong#603) but it requires removing a piece of code, and no-one knows why that code was there. This PR is applying that fix. I didn't see any issues after applying it and this fix will only exists in our fork.