Did some doc texts

SweetLib.IO/Classes/Streaming/StreamManager.cs

@@ -5,6 +5,9 @@ using SweetLib.Utils.Extensions;
 
 namespace SweetLib.IO.Classes.Streaming
 {
+    /// <summary>
+    /// <see cref="StreamManager"/> wraps some useful methods for custom implementations of object streaming.
+    /// </summary>
     public static class StreamManager
     {
         enum StreamedObjectType : ushort // 2 bytes
@@ -68,38 +71,91 @@ namespace SweetLib.IO.Classes.Streaming
             return buffer;
         }
 
+        /// <summary>
+        /// Adds a <see cref="string"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="string"/> will be added.</param>
+        /// <param name="value"><see cref="string"/> value to add.</param>
         public static void SaveToStream(Stream stream, string value)
         {
             SaveToStream(stream, StreamedObjectType.StringValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="bool"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="bool"/> will be added.</param>
+        /// <param name="value"><see cref="bool"/> value to add.</param>
         public static void SaveToStream(Stream stream, bool value)
         {
             SaveToStream(stream, StreamedObjectType.BoolValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="char"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="char"/> will be added.</param>
+        /// <param name="value"><see cref="char"/> value to add.</param>
         public static void SaveToStream(Stream stream, char value)
         {
             SaveToStream(stream, StreamedObjectType.CharValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="int"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="int"/> will be added.</param>
+        /// <param name="value"><see cref="int"/> value to add.</param>
         public static void SaveToStream(Stream stream, int value)
         {
             SaveToStream(stream, StreamedObjectType.IntValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="long"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="long"/> will be added.</param>
+        /// <param name="value"><see cref="long"/> value to add.</param>
         public static void SaveToStream(Stream stream, long value)
         {
             SaveToStream(stream, StreamedObjectType.LongValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="float"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="float"/> will be added.</param>
+        /// <param name="value"><see cref="float"/> value to add.</param>
         public static void SaveToStream(Stream stream, float value)
         {
             SaveToStream(stream, StreamedObjectType.FloatValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="double"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="double"/> will be added.</param>
+        /// <param name="value"><see cref="double"/> value to add.</param>
         public static void SaveToStream(Stream stream, double value)
         {
             SaveToStream(stream, StreamedObjectType.DoubleValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="DateTime"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="DateTime"/> will be added.</param>
+        /// <param name="value"><see cref="DateTime"/> value to add.</param>
         public static void SaveToStream(Stream stream, DateTime value)
         {
             SaveToStream(stream, StreamedObjectType.DateTimeValue, value.AsBytes());
         }
+
+        /// <summary>
+        /// Adds a <see cref="Stream"/> to a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> to which the <see cref="Stream"/> will be added.</param>
+        /// <param name="value"><see cref="Stream"/> value to add.</param>
         public static void SaveToStream(Stream stream, Stream value, bool resetSourceStream = false)
         {
             if (resetSourceStream)
@@ -110,45 +166,92 @@ namespace SweetLib.IO.Classes.Streaming
 
             SaveToStream(stream, StreamedObjectType.StreamValue, buffer);
         }
+
+        /// <summary>
+        /// Loads a <see cref="string"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="string"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="string"/> value.</param>
         public static void LoadFromStream(Stream stream, out string value)
         {
             value = LoadFromStream(stream, StreamedObjectType.StringValue).AsString();
         }
 
+        /// <summary>
+        /// Loads a <see cref="bool"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="bool"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="bool"/> value.</param>
         public static void LoadFromStream(Stream stream, out bool value)
         {
             value = LoadFromStream(stream, StreamedObjectType.BoolValue).AsBool();
         }
+
+        /// <summary>
+        /// Loads a <see cref="char"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="char"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="char"/> value.</param>
         public static void LoadFromStream(Stream stream, out char value)
         {
             value = LoadFromStream(stream, StreamedObjectType.CharValue).AsChar();
         }
 
+        /// <summary>
+        /// Loads a <see cref="int"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="int"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="int"/> value.</param>
         public static void LoadFromStream(Stream stream, out int value)
         {
             value = LoadFromStream(stream, StreamedObjectType.IntValue).AsInt32();
         }
 
+        /// <summary>
+        /// Loads a <see cref="long"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="long"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="long"/> value.</param>
         public static void LoadFromStream(Stream stream, out long value)
         {
             value = LoadFromStream(stream, StreamedObjectType.LongValue).AsInt64();
         }
 
+        /// <summary>
+        /// Loads a <see cref="string"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="string"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="string"/> value.</param>
         public static void LoadFromStream(Stream stream, out float value)
         {
             value = LoadFromStream(stream, StreamedObjectType.FloatValue).AsSingle();
         }
 
+        /// <summary>
+        /// Loads a <see cref="double"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="double"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="double"/> value.</param>
         public static void LoadFromStream(Stream stream, out double value)
         {
             value = LoadFromStream(stream, StreamedObjectType.DoubleValue).AsDouble();
         }
 
+        /// <summary>
+        /// Loads a <see cref="DateTime"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="DateTime"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="DateTime"/> value.</param>
         public static void LoadFromStream(Stream stream, out DateTime value)
         {
             value = LoadFromStream(stream, StreamedObjectType.DateTimeValue).AsDateTime();
         }
 
+        /// <summary>
+        /// Loads a <see cref="Stream"/> from a given <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="stream"><see cref="Stream"/> from which the <see cref="Stream"/> will be loaded.</param>
+        /// <param name="value">Contains the loaded <see cref="Stream"/> value.</param>
         public static void LoadFromStream(Stream stream, out Stream value)
         {
             var buffer = LoadFromStream(stream, StreamedObjectType.StreamValue);

SweetLib/Utils/Extensions/BaseTypeExtensions.cs

@@ -130,7 +130,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="short"/> type.
+        /// Converts a byte array into a <see cref="short"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -140,7 +140,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="ushort"/> type.
+        /// Converts a byte array into a <see cref="ushort"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -150,7 +150,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="int"/> type.
+        /// Converts a byte array into a <see cref="int"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -160,7 +160,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="uint"/> type.
+        /// Converts a byte array into a <see cref="uint"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -170,7 +170,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="long"/> type.
+        /// Converts a byte array into a <see cref="long"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -180,7 +180,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="ulong"/> type.
+        /// Converts a byte array into a <see cref="ulong"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -190,7 +190,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="float"/> type.
+        /// Converts a byte array into a <see cref="float"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -200,7 +200,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="double"/> type.
+        /// Converts a byte array into a <see cref="double"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -210,7 +210,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="bool"/> type.
+        /// Converts a byte array into a <see cref="bool"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -220,7 +220,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="DateTime"/> type.
+        /// Converts a byte array into a <see cref="DateTime"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -230,7 +230,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="string"/> type.
+        /// Converts a byte array into a <see cref="string"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>
@@ -241,7 +241,7 @@ namespace SweetLib.Utils.Extensions
         }
 
         /// <summary>
-        /// Converts a <see cref="byte[]"/> into a <see cref="char"/> type.
+        /// Converts a byte array into a <see cref="char"/> type.
         /// </summary>
         /// <param name="bytes">Byte array representation to convert.</param>
         /// <returns>Converted value.</returns>