Improved XML doc for serializable networkedvar classes

Author: TwoTenPvP

MLAPI/Data/NetworkConfig.cs

@@ -149,8 +149,14 @@ public class NetworkConfig
         /// Wheter or not to enable signed diffie hellman key exchange.
         /// </summary>
         public bool SignKeyExchange = false;
+        /// <summary>
+        /// Pfx file in base64 encoding containing private and public key
+        /// </summary>
         [TextArea]
         public string ServerBase64PfxCertificate;
+        /// <summary>
+        /// Gets the currently in use certificate
+        /// </summary>
         public X509Certificate2 ServerX509Certificate
         {
             get
@@ -164,6 +170,9 @@ internal set
             }
         }
         private X509Certificate2 serverX509Certificate;
+        /// <summary>
+        /// Gets the cached binary representation of the server certificate that's used for handshaking
+        /// </summary>
         public byte[] ServerX509CertificateBytes
         {
             get

MLAPI/Data/NetworkedVar.cs

@@ -166,6 +166,7 @@ public bool CanClientWrite(uint clientId)
         /// Reads value from the reader and applies it
         /// </summary>
         /// <param name="stream">The stream to read the value from</param>
+        /// <param name="keepDirtyDelta">Whether or not the container should keep the dirty delta, or mark the delta as consumed</param>
         public void ReadDelta(Stream stream, bool keepDirtyDelta)
         {
             using (PooledBitReader reader = PooledBitReader.Get(stream))
@@ -208,175 +209,307 @@ public string GetChannel()
         }
     }
 
-    // These support serialization
+    /// <summary>
+    /// A NetworkedVar that holds strings and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarString : NetworkedVar<string>
     {
+        /// <inheritdoc />
         public NetworkedVarString() { }
+        /// <inheritdoc />
         public NetworkedVarString(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarString(string value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarString(NetworkedVarSettings settings, string value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds bools and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarBool : NetworkedVar<bool>
     {
+        /// <inheritdoc />
         public NetworkedVarBool() { }
+        /// <inheritdoc />
         public NetworkedVarBool(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarBool(bool value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarBool(NetworkedVarSettings settings, bool value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds bytes and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarByte : NetworkedVar<byte>
     {
+        /// <inheritdoc />
         public NetworkedVarByte() { }
+        /// <inheritdoc />
         public NetworkedVarByte(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarByte(byte value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarByte(NetworkedVarSettings settings, byte value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds sbytes and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarSByte : NetworkedVar<sbyte>
     {
+        /// <inheritdoc />
         public NetworkedVarSByte() { }
+        /// <inheritdoc />
         public NetworkedVarSByte(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarSByte(sbyte value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarSByte(NetworkedVarSettings settings, sbyte value) : base(settings, value) { }
     }
-
+    
+    /// <summary>
+    /// A NetworkedVar that holds ushorts and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarUShort : NetworkedVar<ushort>
     {
+        /// <inheritdoc />
         public NetworkedVarUShort() { }
+        /// <inheritdoc />
         public NetworkedVarUShort(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarUShort(ushort value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarUShort(NetworkedVarSettings settings, ushort value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds shorts and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarShort : NetworkedVar<short>
     {
+        /// <inheritdoc />
         public NetworkedVarShort() { }
+        /// <inheritdoc />
         public NetworkedVarShort(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarShort(short value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarShort(NetworkedVarSettings settings, short value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds uints and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarUInt : NetworkedVar<uint>
     {
+        /// <inheritdoc />
         public NetworkedVarUInt() { }
+        /// <inheritdoc />
         public NetworkedVarUInt(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarUInt(uint value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarUInt(NetworkedVarSettings settings, uint value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds ints and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarInt : NetworkedVar<int>
     {
+        /// <inheritdoc />
         public NetworkedVarInt() { }
+        /// <inheritdoc />
         public NetworkedVarInt(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarInt(int value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarInt(NetworkedVarSettings settings, int value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds ulongs and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarULong : NetworkedVar<ulong>
     {
+        /// <inheritdoc />
         public NetworkedVarULong() { }
+        /// <inheritdoc />
         public NetworkedVarULong(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarULong(ulong value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarULong(NetworkedVarSettings settings, ulong value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds longs and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarLong : NetworkedVar<long>
     {
+        /// <inheritdoc />
         public NetworkedVarLong() { }
+        /// <inheritdoc />
         public NetworkedVarLong(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarLong(long value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarLong(NetworkedVarSettings settings, long value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds floats and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarFloat : NetworkedVar<float>
     {
+        /// <inheritdoc />
         public NetworkedVarFloat() { }
+        /// <inheritdoc />
         public NetworkedVarFloat(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarFloat(float value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarFloat(NetworkedVarSettings settings, float value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds doubles and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarDouble : NetworkedVar<double>
     {
+        /// <inheritdoc />
         public NetworkedVarDouble() { }
+        /// <inheritdoc />
         public NetworkedVarDouble(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarDouble(double value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarDouble(NetworkedVarSettings settings, double value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds vector2s and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarVector2 : NetworkedVar<Vector2>
     {
+        /// <inheritdoc />
         public NetworkedVarVector2() { }
+        /// <inheritdoc />
         public NetworkedVarVector2(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarVector2(Vector2 value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarVector2(NetworkedVarSettings settings, Vector2 value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds vector3s and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarVector3 : NetworkedVar<Vector3>
     {
+        /// <inheritdoc />
         public NetworkedVarVector3() { }
+        /// <inheritdoc />
         public NetworkedVarVector3(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarVector3(Vector3 value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarVector3(NetworkedVarSettings settings, Vector3 value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds vector4s and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarVector4 : NetworkedVar<Vector4>
     {
+        /// <inheritdoc />
         public NetworkedVarVector4() { }
+        /// <inheritdoc />
         public NetworkedVarVector4(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarVector4(Vector4 value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarVector4(NetworkedVarSettings settings, Vector4 value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds colors and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarColor : NetworkedVar<Color>
     {
+        /// <inheritdoc />
         public NetworkedVarColor() { }
+        /// <inheritdoc />
         public NetworkedVarColor(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarColor(Color value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarColor(NetworkedVarSettings settings, Color value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds color32s and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarColor32 : NetworkedVar<Color32>
     {
+        /// <inheritdoc />
         public NetworkedVarColor32() { }
+        /// <inheritdoc />
         public NetworkedVarColor32(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarColor32(Color32 value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarColor32(NetworkedVarSettings settings, Color32 value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds rays and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarRay : NetworkedVar<Ray>
     {
+        /// <inheritdoc />
         public NetworkedVarRay() { }
+        /// <inheritdoc />
         public NetworkedVarRay(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarRay(Ray value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarRay(NetworkedVarSettings settings, Ray value) : base(settings, value) { }
     }
 
+    /// <summary>
+    /// A NetworkedVar that holds quaternions and support serialization
+    /// </summary>
     [Serializable]
     public class NetworkedVarQuaternion : NetworkedVar<Quaternion>
     {
+        /// <inheritdoc />
         public NetworkedVarQuaternion() { }
+        /// <inheritdoc />
         public NetworkedVarQuaternion(NetworkedVarSettings settings) : base(settings) { }
+        /// <inheritdoc />
         public NetworkedVarQuaternion(Quaternion value) : base(value) { }
+        /// <inheritdoc />
         public NetworkedVarQuaternion(NetworkedVarSettings settings, Quaternion value) : base(settings, value) { }
     }
 }