Skip to content

docs: xmldoc for DisconnectReason #2300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 9, 2022
Merged

docs: xmldoc for DisconnectReason #2300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c49089c
docs: xmldoc for DisconnectReason
jeffreyrainy Nov 8, 2022
206c723
docs: xmldoc header for NetworkBehaviourEditor
jeffreyrainy Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions com.unity.netcode.gameobjects/Editor/NetworkBehaviourEditor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

namespace Unity.Netcode.Editor
{
/// <summary>
/// The <see cref="CustomEditor"/> for <see cref="NetworkBehaviour"/>
/// </summary>
[CustomEditor(typeof(NetworkBehaviour), true)]
[CanEditMultipleObjects]
public class NetworkBehaviourEditor : UnityEditor.Editor
Expand Down
15 changes: 8 additions & 7 deletions com.unity.netcode.gameobjects/Runtime/Core/NetworkManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ public NetworkPrefabHandler PrefabHandler
private bool m_ShuttingDown;
private bool m_StopProcessingMessages;

// <summary>
// When disconnected from the server, the server may send a reason. If a reason was sent, this property will
// tell client code what the reason was. It should be queried after the OnClientDisconnectCallback is called
// </summary>
/// <summary>
/// When disconnected from the server, the server may send a reason. If a reason was sent, this property will
/// tell client code what the reason was. It should be queried after the OnClientDisconnectCallback is called
/// </summary>
public string DisconnectReason { get; internal set; }

private class NetworkManagerHooks : INetworkHooks
Expand Down Expand Up @@ -450,9 +450,10 @@ public class ConnectionApprovalResponse
/// </summary>
public bool Pending;

// <summary>
// Optional reason. If Approved is false, this reason will be sent to the client so they know why they
// were not approved.
/// <summary>
/// Optional reason. If Approved is false, this reason will be sent to the client so they know why they
/// were not approved.
/// </summary>
public string Reason;
}

Expand Down