Skip to content

Commit 881fd90

Browse files
committed
fix: remove dead API doc links to internal scene event types (UUM-131558)
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.
1 parent dcd8147 commit 881fd90

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public class SceneEvent
143143

144144
/// <summary>
145145
/// Main class for managing network scenes when <see cref="NetworkConfig.EnableSceneManagement"/> is enabled.
146-
/// Uses the <see cref="SceneEventMessage"/> message to communicate <see cref="SceneEventData"/> between the server and client(s)
146+
/// Uses the <c>SceneEventMessage</c> message to communicate <c>SceneEventData</c> between the server and client(s)
147147
/// </summary>
148148
[Serializable]
149149
public class NetworkSceneManager : IDisposable
@@ -162,8 +162,7 @@ public class NetworkSceneManager : IDisposable
162162
/// <summary>
163163
/// The delegate callback definition for scene event notifications.<br />
164164
/// See also: <br />
165-
/// <see cref="SceneEvent"/><br />
166-
/// <see cref="SceneEventData"/>
165+
/// <see cref="SceneEvent"/>
167166
/// </summary>
168167
/// <param name="sceneEvent">SceneEvent which contains information about the scene event, including type, progress, and scene details</param>
169168
public delegate void SceneEventDelegate(SceneEvent sceneEvent);

0 commit comments

Comments
 (0)