docs: add comments

phnx47 · Nov 15, 2023 · 1a0b055 · 1a0b055
1 parent 9364000
commit 1a0b055
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 5 deletions.
diff --git a/src/FingerprintBuilder.cs b/src/FingerprintBuilder.cs
@@ -40,8 +40,14 @@ private FingerprintBuilder(Func<byte[], byte[]> computeHash)
         _computeHash = computeHash ?? throw new ArgumentNullException(nameof(computeHash));
     }
 
+    /// <summary>
+    ///     Create FingerprintBuilder from HashAlgorithm
+    /// </summary>
     public static IFingerprintBuilder<T> Create(HashAlgorithm hashAlgorithm) => Create(hashAlgorithm.ComputeHash);
 
+    /// <summary>
+    ///     Create FingerprintBuilder from Func
+    /// </summary>
     public static IFingerprintBuilder<T> Create(Func<byte[], byte[]> computeHash) => new FingerprintBuilder<T>(computeHash);
 
     public IFingerprintBuilder<T> For<TProperty>(Expression<Func<T, TProperty>> expression) => For(expression, f => f);

diff --git a/src/FingerprintBuilder.csproj b/src/FingerprintBuilder.csproj
@@ -1,6 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <LangVersion>11.0</LangVersion>
     <Description>Compute hash for specified .NET object</Description>
     <Copyright>2019 © Serge K</Copyright>
     <Authors>Serge K</Authors>

diff --git a/src/FingerprintBuilderExtensions.cs b/src/FingerprintBuilderExtensions.cs
@@ -22,9 +22,6 @@ public static string ToUpperHexString(this byte[] source)
         return source.ToString("X2");
     }
 
-    /// <summary>
-    ///     Convert to string
-    /// </summary>
     private static string ToString(this byte[] source, string format)
     {
         if (source == null)

diff --git a/src/IFingerprintBuilder.cs b/src/IFingerprintBuilder.cs
@@ -5,11 +5,23 @@ namespace FingerprintBuilder;
 
 public interface IFingerprintBuilder<T>
 {
+    /// <summary>
+    ///     Add Expression
+    /// </summary>
     IFingerprintBuilder<T> For<TProperty>(Expression<Func<T, TProperty>> expression);
 
+    /// <summary>
+    ///     Add Expression
+    /// </summary>
     IFingerprintBuilder<T> For(Expression<Func<T, string>> expression, bool toLower, bool trim);
 
+    /// <summary>
+    ///     Add Expression
+    /// </summary>
     IFingerprintBuilder<T> For<TProperty>(Expression<Func<T, TProperty>> expression, Expression<Func<TProperty, string>> fingerprint);
 
+    /// <summary>
+    ///     Build Func
+    /// </summary>
     Func<T, byte[]> Build();
 }
diff --git a/tests/units/FingerprintBuilder.Tests.csproj b/tests/units/FingerprintBuilder.Tests.csproj
@@ -1,6 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <LangVersion>11.0</LangVersion>
     <TargetFramework Condition="'$(OS)' == 'Unix'">net6.0</TargetFramework>
     <TargetFrameworks Condition="'$(OS)' != 'Unix'">net462;net6.0</TargetFrameworks>
     <CollectCoverage>true</CollectCoverage>