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 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.