[api-documenter] Add new showInheritedMembers config for api-documenter and new api-documenter-scenarios test project#3
Open
zelliott wants to merge 21 commits intoinheritance-docsfrom
Conversation
octogonz
reviewed
Jul 19, 2022
octogonz
reviewed
Jul 19, 2022
octogonz
reviewed
Jul 19, 2022
zelliott
force-pushed
the
inheritance-docs
branch
2 times, most recently
from
c082a44 to
682c5b5
Compare
zelliott
force-pushed
the
inheritance-docs-api-documenter
branch
2 times, most recently
from
b7ae67f to
935852d
Compare
zelliott
force-pushed
the
inheritance-docs
branch
from
682c5b5 to
c1ab8e0
Compare
zelliott
force-pushed
the
inheritance-docs-api-documenter
branch
5 times, most recently
from
95fb572 to
08e3d1b
Compare
[api-extractor-model] Add new ApiItemContainerMixin.findMembersWithInheritance method
zelliott
force-pushed
the
inheritance-docs-api-documenter
branch
from
08e3d1b to
3e0d3e7
Compare
…beta Mark FindApiItemsMessageId as "@beta"
zelliott
force-pushed
the
inheritance-docs-api-documenter
branch
from
3e0d3e7 to
3580cf1
Compare
zelliott
force-pushed
the
inheritance-docs
branch
from
78ece37 to
c70eb5f
Compare
zelliott
force-pushed
the
inheritance-docs-api-documenter
branch
from
3580cf1 to
be00db9
Compare
[api-extractor-model] Improve `IFindApiItemsMessage` and fix two minor bugs with `findMembersWithInheritance`
…ocs-api-documenter
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
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.
Summary
Fixes microsoft#3429. microsoft#3469 includes the api-extractor-model changes necessary to support showing an item's inherited members. This PR includes the work in api-documenter to actually show an item's inherited members.
Details
showInheritedMembersapi-documenter config (only supported by theMarkdownDocumenterat the moment).How it was tested
Ran rush rebuild and manually inspected generated Markdown artifacts.