chore!: Fix warnings when generating docs. #8660
Merged
Conversation
This file contains 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
github-actions
bot
added
breaking change
rachel-fenichel
approved these changes
Jan 6, 2025
github-actions
bot
added
breaking change
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.
The basics
The details
Resolves
Fixes #6936
Proposed Changes
This PR resolves various warnings when generating documentation. It fixes the @link syntax in various docstrings to either be valid or disambiguate the symbol being referenced, removes @Class on docstrings attached to a class, unifies docs for setters/getters to be on the getter, and updates the API Extractor config to not require leading underscores on internal symbols.
Breaking Change
WorkspaceSvg.getLayerManager()is now marked@internal; API Extractor was complaining that the class itself was internal but had a public getter. The PR that introduced the layer manager and this method (#7619) stated that "The new system should be entirely internal.", so I believe this being public was an oversight.The
IRenderedElementinterface is made public by this change.