Add support for @defaultValue TSDoc tag #473
Closed
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.
This adds support for the
@defaultValue
tag from the TSDoc specification. The existence of both specs can be pretty confusing because there's quite a bit of overlap, but I think ultimately what we're writing in.ts
files is TSDoc as it doesn't include the type information like JSDoc does. I kept support for the @default tag both for backward compatibility and because TypeScript does support actual JSDoc in.js
files, though I'm not sure whether this tool actually does support that case.For reference:
I'm happy to address any feedback and thanks for this wonderful tool!