Code style fixes and Intellisense comments

Author: josesimoes

Shared/MessagePack/DataTypes.cs

@@ -4,70 +4,167 @@
 namespace nanoFramework.MessagePack
 {
     /// <summary>
-    /// Supporting MessagePack types
+    /// Supporting MessagePack types.
     /// </summary>
     public enum DataTypes : byte
     {
+        /// <summary>
+        /// Represents a null value in MessagePack.
+        /// </summary>
         Null = 0xc0,
 
+        /// <summary>
+        /// Represents a boolean false value in MessagePack.
+        /// </summary>
         False = 0xc2,
 
+        /// <summary>
+        /// Represents a boolean true value in MessagePack.
+        /// </summary>
         True = 0xc3,
 
+        /// <summary>
+        /// Represents a 32-bit floating-point number in MessagePack.
+        /// </summary>
         Single = 0xca,
 
+        /// <summary>
+        /// Represents a 64-bit floating-point number in MessagePack.
+        /// </summary>
         Double = 0xcb,
 
+        /// <summary>
+        /// Represents an unsigned 8-bit integer in MessagePack.
+        /// </summary>
         UInt8 = 0xcc,
 
+        /// <summary>
+        /// Represents an unsigned 16-bit integer in MessagePack.
+        /// </summary>
         UInt16 = 0xcd,
 
+        /// <summary>
+        /// Represents an unsigned 32-bit integer in MessagePack.
+        /// </summary>
         UInt32 = 0xce,
 
+        /// <summary>
+        /// Represents an unsigned 64-bit integer in MessagePack.
+        /// </summary>
         UInt64 = 0xcf,
 
-        NegativeFixNum = 0xe0, //last 5 bits is value
+        /// <summary>
+        /// Represents a negative fixed integer in MessagePack (last 5 bits are the value).
+        /// </summary>
+        /// <remarks>Last 5 bits is the value.</remarks>
+        NegativeFixNum = 0xe0,
 
+        /// <summary>
+        /// Represents a positive fixed integer in MessagePack.
+        /// </summary>
         PositiveFixNum = 0x7f,
 
+        /// <summary>
+        /// Represents a signed 8-bit integer in MessagePack.
+        /// </summary>
         Int8 = 0xd0,
 
+        /// <summary>
+        /// Represents a signed 16-bit integer in MessagePack.
+        /// </summary>
         Int16 = 0xd1,
 
+        /// <summary>
+        /// Represents a signed 32-bit integer in MessagePack.
+        /// </summary>
         Int32 = 0xd2,
 
+        /// <summary>
+        /// Represents a signed 64-bit integer in MessagePack.
+        /// </summary>
         Int64 = 0xd3,
 
-        FixArray = 0x90, //last 4 bits is size
+        /// <summary>
+        /// Represents a fixed-size array in MessagePack (last 4 bits are the size).
+        /// </summary>
+        /// <remarks>Last 4 bits is the size.</remarks>
+        FixArray = 0x90,
 
+        /// <summary>
+        /// Represents an array with up to 16-bit length in MessagePack.
+        /// </summary>
         Array16 = 0xdc,
 
+        /// <summary>
+        /// Represents an array with up to 32-bit length in MessagePack.
+        /// </summary>
         Array32 = 0xdd,
 
-        FixMap = 0x80, //last 4 bits is size
+        /// <summary>
+        /// Represents a fixed-size map in MessagePack (last 4 bits are the size).
+        /// </summary>
+        /// <remarks>Last 4 bits is the size.</remarks>
+        FixMap = 0x80,
 
+        /// <summary>
+        /// Represents a map with up to 16-bit length in MessagePack.
+        /// </summary>
         Map16 = 0xde,
 
+        /// <summary>
+        /// Represents a map with up to 32-bit length in MessagePack.
+        /// </summary>
         Map32 = 0xdf,
 
-        FixStr = 0xa0, //last 5 bits is size
+        /// <summary>
+        /// Represents a fixed-size string in MessagePack (last 5 bits are the size).
+        /// </summary>
+        /// <remarks>Last 5 bits is the length.</remarks>
+        FixStr = 0xa0,
 
+        /// <summary>
+        /// Represents a string with up to 8-bit length in MessagePack.
+        /// </summary>
         Str8 = 0xd9,
 
+        /// <summary>
+        /// Represents a string with up to 16-bit length in MessagePack.
+        /// </summary>
         Str16 = 0xda,
 
+        /// <summary>
+        /// Represents a string with up to 32-bit length in MessagePack.
+        /// </summary>
         Str32 = 0xdb,
 
+        /// <summary>
+        /// Represents a binary data with up to 8-bit length in MessagePack.
+        /// </summary>
         Bin8 = 0xc4,
 
+        /// <summary>
+        /// Represents a binary data with up to 16-bit length in MessagePack.
+        /// </summary>
         Bin16 = 0xc5,
 
+        /// <summary>
+        /// Represents a binary data with up to 32-bit length in MessagePack.
+        /// </summary>
         Bin32 = 0xc6,
 
+        /// <summary>
+        /// Represents a 32-bit timestamp in MessagePack.
+        /// </summary>
         Timestamp32 = 0xd6,
 
+        /// <summary>
+        /// Represents a 64-bit timestamp in MessagePack.
+        /// </summary>
         Timestamp64 = 0xd7,
 
+        /// <summary>
+        /// Represents a 96-bit timestamp in MessagePack.
+        /// </summary>
         Timestamp96 = 0xc7
     }
 }

Shared/MessagePack/Dto/ArraySegment.cs

@@ -114,11 +114,19 @@ private byte[] ToArray()
             return data;
         }
 
+        /// <summary>
+        /// Implicit conversion from byte array to <see cref="ArraySegment"/>.
+        /// </summary>
+        /// <param name="bytes"></param>
         public static implicit operator ArraySegment(byte[] bytes)
         {
             return new ArraySegment(bytes, 0, bytes.Length);
         }
 
+        /// <summary>
+        /// Implicit conversion from <see cref="ArraySegment"/> to byte array.
+        /// </summary>
+        /// <param name="segment"></param>
         public static explicit operator byte[](ArraySegment segment)
         {
             return segment.ToArray();

Shared/MessagePack/Exceptions/ConverterNotFoundException.cs

@@ -5,14 +5,25 @@
 
 namespace nanoFramework.MessagePack.Exceptions
 {
+    /// <summary>
+    /// Exception for converter not found.
+    /// </summary>
     public class ConverterNotFoundException : Exception
     {
+
+        /// <summary>
+        /// Gets the type of object which converter was not found.
+        /// </summary>
+        public Type ObjectType { get; }
+
+        /// <summary>
+        /// Converter not found exception.
+        /// </summary>
+        /// <param name="type">Type of object.</param>
         public ConverterNotFoundException(Type type)
             : base($"Converter not found for type {type.FullName}")
         {
             ObjectType = type;
         }
-
-        public Type ObjectType { get; }
     }
 }

Shared/MessagePack/Exceptions/SerializationException.cs

@@ -5,8 +5,15 @@
 
 namespace nanoFramework.MessagePack.Exceptions
 {
+    /// <summary>
+    /// Exception for serialization errors.
+    /// </summary>
     public class SerializationException : Exception
     {
+        /// <summary>
+        /// Serialization exception.
+        /// </summary>
+        /// <param name="message"></param>
         public SerializationException(string message) : base(message)
         {
 

Shared/MessagePack/MessagePackSerializer.cs

@@ -7,6 +7,9 @@
 
 namespace nanoFramework.MessagePack
 {
+    /// <summary>
+    /// Class for <see cref="MessagePack"/> serialization and deserialization.
+    /// </summary>
     public static class MessagePackSerializer
     {
         /// <summary>