[api-extractor] Add support for "@defaultvalue" #837
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…for now. We'll postpone passing it through to the documentation pipeline until after TSDoc is integrated.
@cliffkoh please see the discussion for It's an open discussion so feel free to propose a different approach. |
cliffkoh
approved these changes
Sep 22, 2018
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR updates updates the doc comment parser to accept TSDoc's
@defaultvaluetag proposed in microsoft/tsdoc#27.A couple notes:
For now API Extractor ignores the text content. After we finish integrating the TSDoc engine, we can pass the
@defaultvaluecontent to the the documentation pipeline.The TSDoc standard wants multiword tags to be camelCase (
@defaultValue) in strict mode. However, API Extractor historically used all lower case, so we preserve that convention in this PR. We'll fix the casing when API Extractor 6.x brings along all the other TSDoc conventions.@kkjeer @cliffkoh