[api-extractor] Customize which TSDoc tags appear in API reports #5079
Conversation
This file contains hidden or 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
Josmithr
force-pushed
the
api-extractor/custom-tags
branch
from
e81364b to
6dab01c
Compare
Josmithr
commented
Feb 4, 2025
octogonz
changed the title
octogonz
changed the title
Josmithr
commented
Mar 28, 2025
Josmithr
commented
Mar 28, 2025
Josmithr
requested review from
D4N14L,
apostolisms,
dmichon-msft,
iclanton and
octogonz
as code owners
Josmithr
commented
Mar 28, 2025
octogonz
reviewed
Apr 1, 2025
octogonz
reviewed
Apr 1, 2025
octogonz
previously approved these changes
Apr 1, 2025
Collaborator
octogonz
left a comment
octogonz
left a comment
There was a problem hiding this comment.
Approved with one minor suggestion
Josmithr
commented
Apr 1, 2025
Josmithr
commented
Apr 1, 2025
…regards to `tsdoc.json`s
octogonz
previously approved these changes
Apr 2, 2025
auto-merge was automatically disabled
April 2, 2025 20:38
Head branch was pushed to by a user without write access
octogonz
approved these changes
Apr 2, 2025
Josmithr
added a commit
to microsoft/FluidFramework
that referenced
this pull request
Apr 23, 2025
Updated from `0.50.1` to `0.52.4`. Of particular interest, the above update includes [support for customizing TSDoc tags that appear in API reports](microsoft/rushstack#5079). A subsequent PR will opt into additional tags.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Allow users to configure which TSDoc tags appear in API reports.
Note: this PR includes an update to the API-Extractor JSON schema, which will also need to be published.
Issue #4988