feat(api-markdown-documenter): Add limited support for inherited type member docs #25471
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
…properties from their hierarchy
…markdown-documenter/inherit-members
…-markdown-documenter/inherit-members
github-actions
bot
added
public api change
Josmithr
commented
Sep 17, 2025
Josmithr
commented
Sep 17, 2025
Josmithr
commented
Sep 17, 2025
| // for the type from which they are inherited. | ||
| const members = getTypeMembers(apiItem, config); | ||
|
|
||
| // TODO: display some sort of icon / notation for inherited members? ⤴️⤵️ |
Josmithr
commented
Sep 17, 2025
| return config.defaultSectionLayout(apiItem, sections, config); | ||
| } | ||
|
|
||
| // TODO: docs |
Josmithr
commented
Sep 17, 2025
| }; | ||
| } | ||
|
|
||
| function createMemberDetailsSection( |
Josmithr
commented
Sep 17, 2025
tools/api-markdown-documenter/src/api-item-transforms/helpers/TableHelpers.ts
Show resolved
Hide resolved
Josmithr
commented
Sep 17, 2025
| import type { ApiItemTransformationConfiguration } from "../../configuration/index.js"; | ||
| import { getTypeMembers } from "../InheritanceUtilities.js"; | ||
|
|
||
| // TODO: this needs a lot of documentation. |
Josmithr
commented
Sep 17, 2025
tools/api-markdown-documenter/src/api-item-transforms/utilities/ApiItemTransformUtilities.ts
Outdated
Show resolved
Hide resolved
Josmithr
commented
Sep 17, 2025
| inheritedMembers.push(...getInheritedMembers(apiInterface, extendsType, config)); | ||
| } | ||
| } else { | ||
| // TODO: type-alias |
There was a problem hiding this comment.
TODO: document this as a future change
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
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.
TODO