Add XML documentation and inheritdoc to CSV classes

Added <inheritdoc /> tags to public methods and properties in CsvDataReader and numeric type converter classes for improved documentation and code clarity. Also refactored array resizing logic in CsvDataReader for better readability.

Author: potatoqualitee

project/dbatools/Csv/Reader/CsvDataReader.cs

@@ -1887,24 +1887,38 @@ public bool IsDBNull(int ordinal)
 
         #region Typed Accessors
 
+        /// <inheritdoc />
         public bool GetBoolean(int ordinal) => (bool)GetValue(ordinal);
+        /// <inheritdoc />
         public byte GetByte(int ordinal) => (byte)GetValue(ordinal);
+        /// <inheritdoc />
         public char GetChar(int ordinal) => (char)GetValue(ordinal);
+        /// <inheritdoc />
         public DateTime GetDateTime(int ordinal) => (DateTime)GetValue(ordinal);
+        /// <inheritdoc />
         public decimal GetDecimal(int ordinal) => (decimal)GetValue(ordinal);
+        /// <inheritdoc />
         public double GetDouble(int ordinal) => (double)GetValue(ordinal);
+        /// <inheritdoc />
         public float GetFloat(int ordinal) => (float)GetValue(ordinal);
+        /// <inheritdoc />
         public Guid GetGuid(int ordinal) => (Guid)GetValue(ordinal);
+        /// <inheritdoc />
         public short GetInt16(int ordinal) => (short)GetValue(ordinal);
+        /// <inheritdoc />
         public int GetInt32(int ordinal) => (int)GetValue(ordinal);
+        /// <inheritdoc />
         public long GetInt64(int ordinal) => (long)GetValue(ordinal);
+        /// <inheritdoc />
         public string GetString(int ordinal) => GetValue(ordinal)?.ToString();
 
+        /// <inheritdoc />
         public long GetBytes(int ordinal, long fieldOffset, byte[] buffer, int bufferOffset, int length)
         {
             throw new NotSupportedException("GetBytes is not supported for CSV data");
         }
 
+        /// <inheritdoc />
         public long GetChars(int ordinal, long fieldOffset, char[] buffer, int bufferOffset, int length)
         {
             string value = GetString(ordinal);
@@ -1916,6 +1930,7 @@ public long GetChars(int ordinal, long fieldOffset, char[] buffer, int bufferOff
             return copyLength;
         }
 
+        /// <inheritdoc />
         public IDataReader GetData(int ordinal)
         {
             throw new NotSupportedException("Nested data readers are not supported for CSV data");
@@ -3526,10 +3541,12 @@ public void AddStaticColumn(StaticColumn column)
 
             _staticColumns.Add(column);
 
-            if (_convertedValues != null)
+            var convertedValues = _convertedValues;
+            if (convertedValues != null)
             {
                 // Resize converted values array
-                Array.Resize(ref _convertedValues, _columns.Count + _staticColumns.Count);
+                Array.Resize(ref convertedValues, _columns.Count + _staticColumns.Count);
+                _convertedValues = convertedValues;
             }
         }
 
@@ -3546,12 +3563,17 @@ public void AddStaticColumn(StaticColumn column)
 
         #region IDataReader Members
 
+        /// <inheritdoc />
         public int Depth => 0;
+        /// <inheritdoc />
         public bool IsClosed => _isClosed;
+        /// <inheritdoc />
         public int RecordsAffected => -1;
 
+        /// <inheritdoc />
         public bool NextResult() => false;
 
+        /// <inheritdoc />
         public void Close()
         {
             if (!_isClosed)
@@ -3575,6 +3597,7 @@ public void Close()
             }
         }
 
+        /// <inheritdoc />
         public void Dispose()
         {
             Close();

project/dbatools/Csv/TypeConverters/NumericConverters.cs

@@ -9,17 +9,21 @@ namespace Dataplat.Dbatools.Csv.TypeConverters
     /// </summary>
     public sealed class Int16Converter : CultureAwareConverterBase<short>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static Int16Converter Default { get; } = new Int16Converter();
 
+        /// <summary>Initializes a new instance of the <see cref="Int16Converter"/> class.</summary>
         public Int16Converter()
         {
             NumberStyles = NumberStyles.Integer;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out short result)
             => short.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out short result)
             => short.TryParse(value, styles, provider, out result);
 #endif
@@ -31,17 +35,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class Int32Converter : CultureAwareConverterBase<int>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static Int32Converter Default { get; } = new Int32Converter();
 
+        /// <summary>Initializes a new instance of the <see cref="Int32Converter"/> class.</summary>
         public Int32Converter()
         {
             NumberStyles = NumberStyles.Integer;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out int result)
             => int.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out int result)
             => int.TryParse(value, styles, provider, out result);
 #endif
@@ -53,17 +61,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class Int64Converter : CultureAwareConverterBase<long>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static Int64Converter Default { get; } = new Int64Converter();
 
+        /// <summary>Initializes a new instance of the <see cref="Int64Converter"/> class.</summary>
         public Int64Converter()
         {
             NumberStyles = NumberStyles.Integer;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out long result)
             => long.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out long result)
             => long.TryParse(value, styles, provider, out result);
 #endif
@@ -75,17 +87,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class SingleConverter : CultureAwareConverterBase<float>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static SingleConverter Default { get; } = new SingleConverter();
 
+        /// <summary>Initializes a new instance of the <see cref="SingleConverter"/> class.</summary>
         public SingleConverter()
         {
             NumberStyles = NumberStyles.Float | NumberStyles.AllowThousands;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out float result)
             => float.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out float result)
             => float.TryParse(value, styles, provider, out result);
 #endif
@@ -97,17 +113,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class DoubleConverter : CultureAwareConverterBase<double>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static DoubleConverter Default { get; } = new DoubleConverter();
 
+        /// <summary>Initializes a new instance of the <see cref="DoubleConverter"/> class.</summary>
         public DoubleConverter()
         {
             NumberStyles = NumberStyles.Float | NumberStyles.AllowThousands;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out double result)
             => double.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out double result)
             => double.TryParse(value, styles, provider, out result);
 #endif
@@ -120,17 +140,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class DecimalConverter : CultureAwareConverterBase<decimal>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static DecimalConverter Default { get; } = new DecimalConverter();
 
+        /// <summary>Initializes a new instance of the <see cref="DecimalConverter"/> class.</summary>
         public DecimalConverter()
         {
             NumberStyles = NumberStyles.Number;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out decimal result)
             => decimal.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out decimal result)
             => decimal.TryParse(value, styles, provider, out result);
 #endif
@@ -142,17 +166,21 @@ protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styl
     /// </summary>
     public sealed class ByteConverter : CultureAwareConverterBase<byte>
     {
+        /// <summary>Gets the default instance of the converter.</summary>
         public static ByteConverter Default { get; } = new ByteConverter();
 
+        /// <summary>Initializes a new instance of the <see cref="ByteConverter"/> class.</summary>
         public ByteConverter()
         {
             NumberStyles = NumberStyles.Integer;
         }
 
+        /// <inheritdoc />
         protected override bool TryParseCore(string value, NumberStyles styles, IFormatProvider provider, out byte result)
             => byte.TryParse(value, styles, provider, out result);
 
 #if NET8_0_OR_GREATER
+        /// <inheritdoc />
         protected override bool TryParseSpan(ReadOnlySpan<char> value, NumberStyles styles, IFormatProvider provider, out byte result)
             => byte.TryParse(value, styles, provider, out result);
 #endif