Skip to content

Commit 834d03d

Browse files
committed
docs(xml): Added missing xml comments for obsolete properties
1 parent 40e85e7 commit 834d03d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

MLAPI/MonoBehaviours/Core/NetworkingManager.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ public class NetworkingManager : MonoBehaviour
5050
/// </summary>
5151
[HideInInspector]
5252
public LogLevel LogLevel = LogLevel.Normal;
53+
/// <summary>
54+
/// The singleton instance of the NetworkingManager
55+
/// </summary>
5356
[Obsolete("Use Singleton instead", false)]
5457
public static NetworkingManager singleton => Singleton;
5558
/// <summary>
@@ -88,31 +91,46 @@ internal set
8891
/// Gets a dictionary of the clients that have been accepted by the transport but are still pending by the MLAPI.
8992
/// </summary>
9093
public readonly Dictionary<uint, PendingClient> PendingClients = new Dictionary<uint, PendingClient>();
94+
/// <summary>
95+
/// Gets wheter or not a server is running
96+
/// </summary>
9197
[Obsolete("Use IsServer instead", false)]
9298
public bool isServer => IsServer;
9399
/// <summary>
94100
/// Gets wheter or not a server is running
95101
/// </summary>
96102
public bool IsServer { get; internal set; }
103+
/// <summary>
104+
/// Gets wheter or not a client is running
105+
/// </summary>
97106
[Obsolete("Use IsClient instead", false)]
98107
public bool isClient => IsClient;
99108
/// <summary>
100109
/// Gets wheter or not a client is running
101110
/// </summary>
102111
public bool IsClient { get; internal set; }
112+
/// <summary>
113+
/// Gets if we are running as host
114+
/// </summary>
103115
[Obsolete("Use IsHost instead", false)]
104116
public bool isHost => IsHost;
105117
/// <summary>
106118
/// Gets if we are running as host
107119
/// </summary>
108120
public bool IsHost => IsServer && IsClient;
121+
/// <summary>
122+
/// Gets wheter or not we are listening for connections
123+
/// </summary>
109124
[Obsolete("Use IsListening instead", false)]
110125
public bool isListening => IsListening;
111126
/// <summary>
112127
/// Gets wheter or not we are listening for connections
113128
/// </summary>
114129
public bool IsListening { get; internal set; }
115130
private byte[] messageBuffer;
131+
/// <summary>
132+
/// Gets if we are connected as a client
133+
/// </summary>
116134
[Obsolete("Use IsConnectedClient instead", false)]
117135
public bool isConnectedClients => IsConnectedClient;
118136
/// <summary>

0 commit comments

Comments
 (0)