Skip to content

Commit 3a6a724

Browse files
committed
docs(xml): Fixed spelling errors
1 parent 5a24af8 commit 3a6a724

12 files changed

Lines changed: 30 additions & 30 deletions

File tree

MLAPI/Configuration/NetworkConfig.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public class NetworkConfig
7676
[Tooltip("The amount of seconds to wait for the handshake to complete before the client times out")]
7777
public int ClientConnectionBufferTimeout = 10;
7878
/// <summary>
79-
/// Wheter or not to use connection approval
79+
/// Whether or not to use connection approval
8080
/// </summary>
8181
[Tooltip("Whether or not to force clients to be approved before they connect")]
8282
public bool ConnectionApproval = false;
@@ -107,7 +107,7 @@ public class NetworkConfig
107107
[Tooltip("Ensures that NetworkedVars can be read even if a client accidental writes where its not allowed to. This will cost some CPU time and bandwidth")]
108108
public bool EnsureNetworkedVarLengthSafety = false;
109109
/// <summary>
110-
/// Wheter or not the MLAPI should check for differences in the prefabs at connection.
110+
/// Whether or not the MLAPI should check for differences in the prefabs at connection.
111111
/// If you dynamically add prefabs at runtime, turn this OFF
112112
/// </summary>
113113
[Tooltip("Whether or not the MLAPI should check for differences in the prefab lists at connection")]
@@ -140,12 +140,12 @@ public class NetworkConfig
140140
[Tooltip("The amount of seconds to wait for all clients to load a requested scene")]
141141
public int LoadSceneTimeOut = 120;
142142
/// <summary>
143-
/// Wheter or not to enable the ECDHE key exchange to allow for encryption and authentication of messages
143+
/// Whether or not to enable the ECDHE key exchange to allow for encryption and authentication of messages
144144
/// </summary>
145145
[Tooltip("Whether or not to enable the ECDHE key exchange to allow for encryption and authentication of messages")]
146146
public bool EnableEncryption = false;
147147
/// <summary>
148-
/// Wheter or not to enable signed diffie hellman key exchange.
148+
/// Whether or not to enable signed diffie hellman key exchange.
149149
/// </summary>
150150
[Tooltip("Whether or not to sign the diffie hellman key exchange to prevent MITM attacks on")]
151151
public bool SignKeyExchange = false;

MLAPI/Configuration/NetworkedPrefab.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ internal ulong Hash
3232
/// </summary>
3333
public GameObject Prefab;
3434
/// <summary>
35-
/// Wheter or not this is a playerPrefab
35+
/// Whether or not this is a playerPrefab
3636
/// </summary>
3737
public bool PlayerPrefab;
3838
}

MLAPI/Core/NetworkedBehaviour.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ public abstract partial class NetworkedBehaviour : MonoBehaviour
7777
protected bool IsHost => IsRunning && NetworkingManager.Singleton.IsHost;
7878
private bool IsRunning => NetworkingManager.Singleton != null && NetworkingManager.Singleton.IsListening;
7979
/// <summary>
80-
/// Gets wheter or not the object has a owner
80+
/// Gets Whether or not the object has a owner
8181
/// </summary>
8282
[EditorBrowsable(EditorBrowsableState.Never)]
8383
[Obsolete("Use IsOwnedByServer instead", false)]
8484
public bool isOwnedByServer => IsOwnedByServer;
8585
/// <summary>
86-
/// Gets wheter or not the object has a owner
86+
/// Gets Whether or not the object has a owner
8787
/// </summary>
8888
public bool IsOwnedByServer => NetworkedObject.IsOwnedByServer;
8989
/// <summary>

MLAPI/Core/NetworkedObject.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ internal set
114114
/// </summary>
115115
public bool IsOwner => NetworkingManager.Singleton != null && OwnerClientId == NetworkingManager.Singleton.LocalClientId;
116116
/// <summary>
117-
/// Gets wheter or not the object is owned by anyone
117+
/// Gets Whether or not the object is owned by anyone
118118
/// </summary>
119119
[EditorBrowsable(EditorBrowsableState.Never)]
120120
[Obsolete("Use IsOwnedByServer instead", false)]
121121
public bool isOwnedByServer => IsOwnedByServer;
122122
/// <summary>
123-
/// Gets wheter or not the object is owned by anyone
123+
/// Gets Whether or not the object is owned by anyone
124124
/// </summary>
125125
public bool IsOwnedByServer => NetworkingManager.Singleton != null && OwnerClientId == NetworkingManager.Singleton.ServerClientId;
126126
/// <summary>

MLAPI/Core/NetworkingManager.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,23 +93,23 @@ internal set
9393
/// </summary>
9494
public readonly Dictionary<ulong, PendingClient> PendingClients = new Dictionary<ulong, PendingClient>();
9595
/// <summary>
96-
/// Gets wheter or not a server is running
96+
/// Gets Whether or not a server is running
9797
/// </summary>
9898
[EditorBrowsable(EditorBrowsableState.Never)]
9999
[Obsolete("Use IsServer instead", false)]
100100
public bool isServer => IsServer;
101101
/// <summary>
102-
/// Gets wheter or not a server is running
102+
/// Gets Whether or not a server is running
103103
/// </summary>
104104
public bool IsServer { get; internal set; }
105105
/// <summary>
106-
/// Gets wheter or not a client is running
106+
/// Gets Whether or not a client is running
107107
/// </summary>
108108
[EditorBrowsable(EditorBrowsableState.Never)]
109109
[Obsolete("Use IsClient instead", false)]
110110
public bool isClient => IsClient;
111111
/// <summary>
112-
/// Gets wheter or not a client is running
112+
/// Gets Whether or not a client is running
113113
/// </summary>
114114
public bool IsClient { get; internal set; }
115115
/// <summary>
@@ -123,13 +123,13 @@ internal set
123123
/// </summary>
124124
public bool IsHost => IsServer && IsClient;
125125
/// <summary>
126-
/// Gets wheter or not we are listening for connections
126+
/// Gets Whether or not we are listening for connections
127127
/// </summary>
128128
[EditorBrowsable(EditorBrowsableState.Never)]
129129
[Obsolete("Use IsListening instead", false)]
130130
public bool isListening => IsListening;
131131
/// <summary>
132-
/// Gets wheter or not we are listening for connections
132+
/// Gets Whether or not we are listening for connections
133133
/// </summary>
134134
public bool IsListening { get; internal set; }
135135
/// <summary>
@@ -159,7 +159,7 @@ internal set
159159
/// </summary>
160160
/// <param name="clientId">The clientId of the approved client</param>
161161
/// <param name="prefabHash">The prefabHash to use for the client</param>
162-
/// <param name="approved">Wheter or not the client was approved</param>
162+
/// <param name="approved">Whether or not the client was approved</param>
163163
/// <param name="position">The position to spawn the client at</param>
164164
/// <param name="rotation">The rotation to spawn the client with</param>
165165
public delegate void ConnectionApprovedDelegate(ulong clientId, ulong? prefabHash, bool approved, Vector3? position, Quaternion? rotation);

MLAPI/NetworkedVar/INetworkedVar.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ public interface INetworkedVar
1717
/// </summary>
1818
void ResetDirty();
1919
/// <summary>
20-
/// Gets wheter or not the container is dirty
20+
/// Gets Whether or not the container is dirty
2121
/// </summary>
22-
/// <returns>Wheter or not the container is dirty</returns>
22+
/// <returns>Whether or not the container is dirty</returns>
2323
bool IsDirty();
2424
/// <summary>
25-
/// Gets wheter or not a specific client can write to the varaible
25+
/// Gets Whether or not a specific client can write to the varaible
2626
/// </summary>
2727
/// <param name="clientId">The clientId of the remote client</param>
28-
/// <returns>Wheter or not the client can write to the variable</returns>
28+
/// <returns>Whether or not the client can write to the variable</returns>
2929
bool CanClientWrite(ulong clientId);
3030
/// <summary>
31-
/// Gets wheter or not a specific client can read to the varaible
31+
/// Gets Whether or not a specific client can read to the varaible
3232
/// </summary>
3333
/// <param name="clientId">The clientId of the remote client</param>
34-
/// <returns>Wheter or not the client can read to the variable</returns>
34+
/// <returns>Whether or not the client can read to the variable</returns>
3535
bool CanClientRead(ulong clientId);
3636
/// <summary>
3737
/// Writes the dirty changes, that is, the changes since the variable was last dirty, to the writer

MLAPI/NetworkedVar/NetworkedVar.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace MLAPI.NetworkedVar
1313
public class NetworkedVar<T> : INetworkedVar
1414
{
1515
/// <summary>
16-
/// Gets or sets wheter or not the variable needs to be delta synced
16+
/// Gets or sets Whether or not the variable needs to be delta synced
1717
/// </summary>
1818
public bool isDirty { get; set; }
1919
/// <summary>

MLAPI/Profiling/NetworkProfiler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public static class NetworkProfiler
1515
/// </summary>
1616
public static FixedQueue<ProfilerTick> Ticks { get; private set; }
1717
/// <summary>
18-
/// Wheter or not the profiler is recording data
18+
/// Whether or not the profiler is recording data
1919
/// </summary>
2020
public static bool isRunning { get; private set; }
2121
private static int tickHistory = 1024;

MLAPI/Profiling/ProfilerTickData.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public class TickEvent
143143
/// </summary>
144144
public string MessageType;
145145
/// <summary>
146-
/// Wheter or not the event is closed
146+
/// Whether or not the event is closed
147147
/// </summary>
148148
public bool Closed;
149149

MLAPI/Prototyping/NetworkedTransform.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ internal class ClientSendInfo
9393
/// </summary>
9494
/// <param name="oldPos">The previous position</param>
9595
/// <param name="newPos">The new requested position</param>
96-
/// <returns>Returns wheter or not the move is valid</returns>
96+
/// <returns>Returns Whether or not the move is valid</returns>
9797
public delegate bool MoveValidationDelegate(Vector3 oldPos, Vector3 newPos);
9898
/// <summary>
9999
/// If set, moves will only be accepted if the custom delegate returns true

0 commit comments

Comments
 (0)