Merge pull request #3 from VisualStudioEX3/feature/fixed-documentation-in-code

Feature/fixed documentation in code

Author: José Miguel Sánchez Fernández

DIV2.Format.Exporter/ColorPalette.cs

@@ -69,7 +69,7 @@ public struct Color : ISerializableAsset
 
         #region Properties
         /// <summary>
-        /// Get or set the component color value.
+        /// Gets or sets the component color value.
         /// </summary>
         /// <param name="index">Index of the component.</param>
         /// <returns>Returns the component color value.</returns>
@@ -151,7 +151,7 @@ public byte this[int index]
         /// </summary>
         /// <param name="a">Left <see cref="Color"/> value to compare.</param>
         /// <param name="b">Right <see cref="Color"/> value to compare.</param>
-        /// <returns>Returns true if the left value are less or equal than the right value.</returns>
+        /// <returns>Returns <see langword="true"/> if the left value are less or equal than the right value.</returns>
         public static bool operator <=(Color a, Color b)
         {
             return (int)a <= (int)b;
@@ -246,7 +246,7 @@ public Color(BinaryReader stream)
 
         #region Methods & Functions
         /// <summary>
-        /// Serialize this instance to binary format.
+        /// Serializes this instance to binary format.
         /// </summary>
         /// <returns>Returns a <see cref="byte"/> array with the serialized data.</returns>
         public byte[] Serialize()
@@ -255,7 +255,7 @@ public byte[] Serialize()
         }
 
         /// <summary>
-        /// Write this instance data in a <see cref="BinaryWriter"/> instance.
+        /// Writes this instance data in a <see cref="BinaryWriter"/> instance.
         /// </summary>
         /// <param name="stream"><see cref="BinaryWriter"/> instance.</param>
         public void Write(BinaryWriter stream)
@@ -327,7 +327,7 @@ internal Vector3 Step()
         /// <summary>
         /// Is a valid DAC color value?
         /// </summary>
-        /// <returns>Returns true if the RGB components are into the DAC range values [0..63].</returns>
+        /// <returns>Returns <see langword="true"/> if the RGB components are into the DAC range values [0..63].</returns>
         public bool IsDAC()
         {
             return this.red.IsClamped(0, MAX_DAC_VALUE) ||
@@ -348,7 +348,7 @@ public override bool Equals(object obj)
         }
 
         /// <summary>
-        /// Generate a hash code for this instance.
+        /// 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>
         public override int GetHashCode()
@@ -439,7 +439,7 @@ public sealed class ColorPalette : ISerializableAsset, IEnumerable<Color>
 
         #region Properties
         /// <summary>
-        /// Get or set a <see cref="Color"/> value in DAC format [0..63].
+        /// Gets or sets a <see cref="Color"/> value in DAC format [0..63].
         /// </summary>
         /// <param name="index">Index in palette.</param>
         /// <returns>Returns the <see cref="Color"/> value.</returns>
@@ -556,7 +556,7 @@ public ColorPalette(BinaryReader stream)
 
         #region Methods & Functions
         /// <summary>
-        /// Serialize this instance to binary format.
+        /// Serializes this instance to binary format.
         /// </summary>
         /// <returns>Returns a <see cref="byte"/> array with the serialized data.</returns>
         public byte[] Serialize()
@@ -571,7 +571,7 @@ public byte[] Serialize()
         }
 
         /// <summary>
-        /// Write this instance data in a <see cref="BinaryWriter"/> instance.
+        /// Writes this instance data in a <see cref="BinaryWriter"/> instance.
         /// </summary>
         /// <param name="stream"><see cref="BinaryWriter"/> instance.</param>
         public void Write(BinaryWriter stream)
@@ -651,7 +651,7 @@ public override bool Equals(object obj)
         }
 
         /// <summary>
-        /// Generate a hash code for this instance.
+        /// Generates a hash code for this instance.
         /// </summary>
         /// <returns>Returns an <see cref="int"/> SHA256 hash code from the MD5 hash created by the binary serialized data of this instance.</returns>
         public override int GetHashCode()

DIV2.Format.Exporter/ColorRange.cs

@@ -157,7 +157,7 @@ public enum RangeTypes : byte
 
         #region Properties
         /// <summary>
-        /// Get or set the range entry value.
+        /// Gets or sets the range entry value.
         /// </summary>
         /// <param name="index">Index of the entry.</param>
         /// <returns>Returns the range entry value.</returns>
@@ -267,7 +267,7 @@ public ColorRange(byte[] buffer)
 
         #region Methods & Functions
         /// <summary>
-        /// Serialize this instance to binary format.
+        /// Serializes this instance to binary format.
         /// </summary>
         /// <returns>Returns a <see cref="byte"/> array with the serialized data.</returns>
         public byte[] Serialize()
@@ -285,7 +285,7 @@ public byte[] Serialize()
         }
 
         /// <summary>
-        /// Write this instance data in a <see cref="BinaryWriter"/> instance.
+        /// Writes this instance data in a <see cref="BinaryWriter"/> instance.
         /// </summary>
         /// <param name="stream"><see cref="BinaryWriter"/> instance.</param>
         public void Write(BinaryWriter stream)
@@ -324,7 +324,7 @@ public override bool Equals(object obj)
         }
 
         /// <summary>
-        /// Generate a hash code for this instance.
+        /// Generates a hash code for this instance.
         /// </summary>
         /// <returns>Returns an <see cref="int"/> SHA256 hash code from the MD5 hash created by the binary serialized data of this instance.</returns>
         public override int GetHashCode()

DIV2.Format.Exporter/ColorRangeTable.cs

@@ -77,7 +77,7 @@ public sealed class ColorRangeTable : ISerializableAsset, IEnumerable<ColorRange
 
         #region Properties
         /// <summary>
-        /// Get or set the <see cref="ColorRange"/> value.
+        /// Gets or sets the <see cref="ColorRange"/> value.
         /// </summary>
         /// <param name="index">Index of the range.</param>
         /// <returns>Returns the <see cref="ColorRange"/> value.</returns>
@@ -158,7 +158,7 @@ public ColorRangeTable(byte[] buffer)
 
         #region Methods & Functions
         /// <summary>
-        /// Serialize this instance to binary format.
+        /// Serializes this instance to binary format.
         /// </summary>
         /// <returns>Returns a <see cref="byte"/> array with the serialized data.</returns>
         public byte[] Serialize()
@@ -173,7 +173,7 @@ public byte[] Serialize()
         }
 
         /// <summary>
-        /// Write this instance data in a <see cref="BinaryWriter"/> instance.
+        /// Writes this instance data in a <see cref="BinaryWriter"/> instance.
         /// </summary>
         /// <param name="stream"><see cref="BinaryWriter"/> instance.</param>
         public void Write(BinaryWriter stream)
@@ -212,7 +212,7 @@ public override bool Equals(object obj)
         }
 
         /// <summary>
-        /// Generate a hash code for this instance.
+        /// Generates a hash code for this instance.
         /// </summary>
         /// <returns>Returns an <see cref="int"/> SHA256 hash code from the MD5 hash created by the binary serialized data of this instance.</returns>
         public override int GetHashCode()

DIV2.Format.Exporter/FPG.cs

@@ -219,7 +219,7 @@ public sealed class FPG : IAssetFile, IEnumerable<MAP>
         /// </summary>
         public int Count => this._registers.Count;
         /// <summary>
-        /// Get a <see cref="MAP"/> instance.
+        /// Gets a <see cref="MAP"/> instance.
         /// </summary>
         /// <param name="index">Index of the <see cref="MAP"/> in the <see cref="FPG"/>.</param>
         /// <returns>Returns the <see cref="MAP"/> instance.</returns>
@@ -385,7 +385,7 @@ public void Add(MAP map, string filename = "")
         /// Determines whether a <see cref="MAP"/> is in this instance.
         /// </summary>
         /// <param name="map">The <see cref="MAP"/> to locate in this instance.</param>
-        /// <returns>Returns true if the <see cref="MAP"/> exists.</returns>
+        /// <returns>Returns <see langword="true"/> if the <see cref="MAP"/> exists.</returns>
         public bool Contains(MAP map)
         {
             foreach (MAP item in this)
@@ -399,7 +399,7 @@ public bool Contains(MAP map)
         /// Determines whether a <see cref="MAP"/> with a graphic identifier is in this instance.
         /// </summary>
         /// <param name="graphId"><see cref="MAP"/> graphic identifier to search.</param>
-        /// <returns>Returns true if a <see cref="MAP"/> graphic identifier exists.</returns>
+        /// <returns>Returns <see langword="true"/> if a <see cref="MAP"/> graphic identifier exists.</returns>
         public bool Contains(int graphId)
         {
             foreach (MAP map in this)
@@ -471,7 +471,7 @@ public void Clear()
         }
 
         /// <summary>
-        /// Gets the associate filename value for this <see cref="MAP"/> in the <see cref="FPG"/>.
+        /// Gets the associated filename value for this <see cref="MAP"/> in the <see cref="FPG"/>.
         /// </summary>
         /// <param name="map"><see cref="MAP"/> instance to find.</param>
         /// <returns>Returns the <see cref="MAP"/> filename value.</returns>
@@ -485,7 +485,7 @@ public string GetFilename(MAP map)
         }
 
         /// <summary>
-        /// Gets the associate filename value for this <see cref="MAP"/> in the <see cref="FPG"/>.
+        /// Gets the associated filename value for this <see cref="MAP"/> in the <see cref="FPG"/>.
         /// </summary>
         /// <param name="index">The index of the <see cref="MAP"/> instance to find. Not confuse with the <see cref="MAP.GraphId"/> value.</param>
         /// <returns>Returns the <see cref="MAP"/> filename value.</returns>
@@ -495,40 +495,40 @@ public string GetFilename(int index)
         }
 
         /// <summary>
-        /// Validate if the file is a valid <see cref="FPG"/> file.
+        /// Validates if the file is a valid <see cref="FPG"/> file.
         /// </summary>
         /// <param name="filename">File to validate.</param>
-        /// <returns>Returns true if the file is a valid <see cref="FPG"/>.</returns>
+        /// <returns>Returns <see langword="true"/> if the file is a valid <see cref="FPG"/>.</returns>
         public static bool ValidateFormat(string filename)
         {
             return VALIDATOR.Validate(filename);
         }
 
         /// <summary>
-        /// Validate if the file is a valid <see cref="FPG"/> file.
+        /// Validates if the file is a valid <see cref="FPG"/> file.
         /// </summary>
         /// <param name="buffer">Memory buffer that contain a <see cref="FPG"/> file data.</param>
-        /// <returns>Returns true if the file is a valid <see cref="FPG"/>.</returns>
+        /// <returns>Returns <see langword="true"/> if the file is a valid <see cref="FPG"/>.</returns>
         public static bool ValidateFormat(byte[] buffer)
         {
             return VALIDATOR.Validate(buffer);
         }
 
         /// <summary>
-        /// Validate if the file is a valid <see cref="FPG"/> file.
+        /// Validates if the file is a valid <see cref="FPG"/> file.
         /// </summary>
         /// <param name="filename">File to validate.</param>
-        /// <returns>Returns true if the file is a valid <see cref="FPG"/>.</returns>
+        /// <returns>Returns <see langword="true"/> if the file is a valid <see cref="FPG"/>.</returns>
         public bool Validate(string filename)
         {
             return this.Validate(File.ReadAllBytes(filename));
         }
 
         /// <summary>
-        /// Validate if the file is a valid <see cref="FPG"/> file.
+        /// Validates if the file is a valid <see cref="FPG"/> file.
         /// </summary>
         /// <param name="buffer">Memory buffer that contain a <see cref="FPG"/> file data.</param>
-        /// <returns>Returns true if the file is a valid <see cref="FPG"/>.</returns>
+        /// <returns>Returns <see langword="true"/> if the file is a valid <see cref="FPG"/>.</returns>
         public bool Validate(byte[] buffer)
         {
             return FPG_FILE_HEADER.Validate(buffer[0..DIVFileHeader.SIZE]) && this.TryToReadFile(buffer);
@@ -561,7 +561,7 @@ bool TryToReadFile(byte[] buffer)
         }
 
         /// <summary>
-        /// Serialize the <see cref="FPG"/> instance in a <see cref="byte"/> array.
+        /// Serializes the <see cref="FPG"/> instance in a <see cref="byte"/> array.
         /// </summary>
         /// <returns>Returns the <see cref="byte"/> array with the <see cref="FPG"/> serialized data.</returns>
         /// <remarks>This function not include the file header data.</remarks>
@@ -578,7 +578,7 @@ public byte[] Serialize()
         }
 
         /// <summary>
-        /// Write this instance data in a <see cref="BinaryWriter"/> instance.
+        /// Writes this instance data in a <see cref="BinaryWriter"/> instance.
         /// </summary>
         /// <param name="stream"><see cref="BinaryWriter"/> instance.</param>
         public void Write(BinaryWriter stream)
@@ -587,7 +587,7 @@ public void Write(BinaryWriter stream)
         }
 
         /// <summary>
-        /// Save the instance in a <see cref="FPG"/> file.
+        /// Saves the instance in a <see cref="FPG"/> file.
         /// </summary>
         /// <param name="filename">Filename to write the data.</param>
         public void Save(string filename)
@@ -630,7 +630,7 @@ public override bool Equals(object obj)
         }
 
         /// <summary>
-        /// Generate a hash code for this instance.
+        /// Generates a hash code for this instance.
         /// </summary>
         /// <returns>Returns an <see cref="int"/> SHA256 hash code from the MD5 hash created by the binary serialized data of this instance.</returns>
         public override int GetHashCode()