Repository navigation
[api-extractor] Fix a couple documentation issues found during testing - #1192
Merged
Merged
Conversation
…lass is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ___ class."
… external package, instead let api-documenter handle them
Pete Gonzalez (octogonz)
requested review from
Aditi Mandal (aditima) and
Ian Clanton-Thuon (iclanton)
as code owners
March 28, 2019 06:22
This was referenced Nov 4, 2022
This was referenced Dec 25, 2022
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
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.
During testing, we found a bunch of cases where
@inheritDocwas used to inherit from types in an external package. This feature had been cut from AE7, but to avoid a regression, I'm implementing a temporary workaround that handles these cases in api-documenter.This PR also reintroduces the boilerplate warning for classes whose constructor was marked as
@internal. The boilerplate looks like this: