fix: remove dead API doc links to internal scene event types#4064
Open
michalChrobot wants to merge 1 commit into
Open
fix: remove dead API doc links to internal scene event types#4064michalChrobot wants to merge 1 commit into
michalChrobot wants to merge 1 commit into
Conversation
…558) The NetworkSceneManager class summary and SceneEventDelegate XML docs referenced the internal types SceneEventMessage and SceneEventData via <see cref>, which generate hyperlinks in the DocFX-generated API docs. Because those types are internal they have no public documentation pages, so the links resolved to missing pages. Convert the descriptive class-summary references to inline code (<c>) and drop the internal SceneEventData entry from the SceneEventDelegate 'See also' list (a user cannot reference an internal type), keeping the public SceneEvent link.
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
1 participant
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.
Purpose of this PR
On the
NetworkSceneManagermanual/API page, the first paragraph contained hyperlinks for theSceneEventMessageandSceneEventDatatypes. Clicking either link led to a missing documentation page.SceneEventMessage(internal struct) andSceneEventData(internal class) are internalimplementation types, so they are excluded from the public DocFX-generated API documentation and
have no doc pages (Also they don't really have formatted description when you look at them).
However, the public
NetworkSceneManagerXML docs referenced them with<see cref="..."/>, which DocFX renders as hyperlinks resolving to non-existent pages:I converted the descriptive references to inline code so it keeps the names readable without emitting a dead link.
Jira ticket
https://jira.unity3d.com/browse/UUM-131558
Changelog
N/A as this is only a docs change
Documentation
Corrected docs links
Testing & QA (How your changes can be verified during release Playtest)
Manually verified that it works now
Backports
N/A