[api-extractor] Don't mark items documented with {@inheritDoc} references to package-external items as "undocumented" #4498
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
requested review from
D4N14L,
apostolisms,
dmichon-msft,
iclanton and
octogonz
as code owners
Josmithr
commented
Jan 29, 2024
octogonz
reviewed
Feb 20, 2024
octogonz
reviewed
Feb 20, 2024
octogonz
approved these changes
Feb 20, 2024
Collaborator
|
@Josmithr thank you for investigating this and figuring out how to fix it! 🎉 |
Collaborator
|
🚀 Released with API Extractor 7.42.0 |
octogonz
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
{@inheritDoc}references to items outside of a given package cannot currently be resolved / evaluated by api-extractor (see #1195). The logic forae-undocumenteddid not take this into account, and was treating any API item with an unresolvable inheritDoc comment as "undocumented". In reality, the "documented" status of the item cannot be determined by API-Extractor. To be safe, we no longer mark items in this ambiguous state as "undocumented".Fix for #3462
Also adds a test scenario for
@inheritDoc, and updates the repo's API reports to reflect the new policy.