Merge pull request #4 from VisualStudioEX3/feature/fixed-documentation

Updated and fixed documentation.

Author: José Miguel Sánchez Fernández

DIV2.Format.Exporter/ColorPalette.cs

@@ -20,7 +20,7 @@ public enum ColorFormat : byte
         /// </summary>
         DAC = Color.MAX_DAC_VALUE,
         /// <summary>
-        /// RGB format [0.255].
+        /// RGB format [0..255].
         /// </summary>
         RGB = byte.MaxValue
     }
@@ -295,7 +295,7 @@ public Color ToDAC()
         /// Gets a <see cref="Vector3"/> with normalized values [0..1].
         /// </summary>
         /// <param name="colorType">Indicate the color range for set the normalization factor.</param>
-        /// <returns>Returns a <see cref="Vector3"/> with the <see cref="Color"/> componentes normalized.</returns>
+        /// <returns>Returns a <see cref="Vector3"/> with the <see cref="Color"/> components normalized.</returns>
         public Vector3 Normalize(ColorFormat colorType)
         {
             float factor = (float)colorType;
@@ -350,7 +350,7 @@ public override bool Equals(object obj)
         /// <summary>
         /// Generates a hash code for this instance.
         /// </summary>
-        /// <returns>Returns an <see cref="int"/> value compose with the RGB values for the first 3 bytes and a zero for fourth byte.</returns>
+        /// <returns>Returns an <see cref="int"/> value composed by the RGB values for the first 3 bytes and a zero for fourth byte.</returns>
         public override int GetHashCode()
         {
             return BitConverter.ToInt32(new byte[] { this.red, this.green, this.blue, 0 }, 0);

DIV2.Format.Exporter/ExtensionMethods/ByteExtensions.cs

@@ -24,7 +24,7 @@ public static byte ClearBits(this byte value, byte mask)
         /// Calculates the checksum of this <see cref="string"/>.
         /// </summary>
         /// <param name="buffer"><see cref="byte"/> array.</param>
-        /// <returns>Returns the checksum string of this <see cref="byte"/> array.</returns>
+        /// <returns>Returns the checksum <see cref="string"/> value of this <see cref="byte"/> array.</returns>
         public static string CalculateChecksum(this byte[] buffer)
         {
             return HashGenerator.CalculateChecksum(buffer);

DIV2.Format.Exporter/ExtensionMethods/MathExtensions.cs

@@ -12,7 +12,7 @@ public static class MathExtensions
         /// <param name="value"><see cref="int"/> value instance.</param>
         /// <param name="min">Min value of the range.</param>
         /// <param name="max">Max value of the range.</param>
-        /// <returns>Returns true if the value is in range.</returns>
+        /// <returns>Returns <see langword="true"/> if the value is in range.</returns>
         public static bool IsClamped(this int value, int min, int max)
         {
             return value >= min && value <= max;
@@ -24,7 +24,7 @@ public static bool IsClamped(this int value, int min, int max)
         /// <param name="value"><see cref="uint"/> value instance.</param>
         /// <param name="min">Min value of the range.</param>
         /// <param name="max">Max value of the range.</param>
-        /// <returns>Returns true if the value is in range.</returns>
+        /// <returns>Returns <see langword="true"/> if the value is in range.</returns>
         public static bool IsClamped(this uint value, uint min, uint max)
         {
             return value >= min && value <= max;
@@ -36,7 +36,7 @@ public static bool IsClamped(this uint value, uint min, uint max)
         /// <param name="value"><see cref="short"/> value instance.</param>
         /// <param name="min">Min value of the range.</param>
         /// <param name="max">Max value of the range.</param>
-        /// <returns>Returns true if the value is in range.</returns>
+        /// <returns>Returns <see langword="true"/> if the value is in range.</returns>
         public static bool IsClamped(this short value, short min, short max)
         {
             return value >= min && value <= max;
@@ -48,7 +48,7 @@ public static bool IsClamped(this short value, short min, short max)
         /// <param name="value"><see cref="byte"/> value instance.</param>
         /// <param name="min">Min value of the range.</param>
         /// <param name="max">Max value of the range.</param>
-        /// <returns>Returns true if the value is in range.</returns>
+        /// <returns>Returns <see langword="true"/> if the value is in range.</returns>
         public static bool IsClamped(this byte value, byte min, byte max)
         {
             return value >= min && value <= max;

DIV2.Format.Exporter/ExtensionMethods/StringExtensions.cs

@@ -10,10 +10,10 @@ public static class StringExtensions
     {
         #region Methods & Functions
         /// <summary>
-        /// Get <see cref="string"/> representation, without null chars and other possible garbage data.
+        /// Gets <see cref="string"/> representation, without null chars and other possible garbage data.
         /// </summary>
         /// <param name="buffer"><see cref="byte"/> array with the ASCIIZ string data (ASCII null terminated string or C string).</param>
-        /// <returns></returns>
+        /// <returns>Returns a <see cref="string"/> instance in ASCII format, terminated with null chars.</returns>
         public static string ToASCIIString(this byte[] buffer)
         {
             int i;
@@ -46,7 +46,7 @@ public static byte[] ToByteArray(this string text)
         }
 
         /// <summary>
-        /// Get a binary representation of this <see cref="string"/> in ASCIIZ format (ASCII null terminated string or C string).
+        /// Gets a binary representation of this <see cref="string"/> in ASCIIZ format (ASCII null terminated string or C string).
         /// </summary>
         /// <param name="text">This <see cref="string"/> instance.</param>
         /// <param name="length">Characters length.</param>

DIV2.Format.Exporter/FPG.cs

@@ -343,7 +343,7 @@ int OrderByAsc(Register x, Register y)
         /// <summary>
         /// Adds a <see cref="MAP"/> file.
         /// </summary>
-        /// <param name="filename">Filename to load.</param>
+        /// <param name="filename"><see cref="MAP"/> file to load.</param>
         public void Add(string filename)
         {
             this.Add(new MAP(File.ReadAllBytes(filename)));