Minor cleanup and add docs

Author: Genbox

Locals/Benchmarks.props

@@ -1,10 +1,10 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
-    <!-- Disable BenchmarkDotNet as code generators don't need it. We will special handle other benchmark projects -->
+  <!-- Disable BenchmarkDotNet as code generators don't need it. We will special handle other benchmark projects -->
 
-    <ItemGroup>
-        <PackageReference Remove="BenchmarkDotNet"/>
-        <Using Remove="BenchmarkDotNet.Attributes"/>
-    </ItemGroup>
+  <ItemGroup>
+    <PackageReference Remove="BenchmarkDotNet" />
+    <Using Remove="BenchmarkDotNet.Attributes" />
+  </ItemGroup>
 
 </Project>

Locals/Directory.Packages.props

@@ -21,6 +21,6 @@
     <PackageVersion Include="Serilog.Sinks.File" Version="7.0.0" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="4.14.0" />
-    <PackageVersion Include="Genbox.FastData.SourceGenerator" Version="0.1.2"/>
+    <PackageVersion Include="Genbox.FastData.SourceGenerator" Version="0.1.2" />
   </ItemGroup>
 </Project>

Src/FastData.InternalShared/Helpers/TestVectorHelper.cs

@@ -7,7 +7,6 @@ namespace Genbox.FastData.InternalShared.Helpers;
 
 public static class TestVectorHelper
 {
-
     public static IEnumerable<ITestVector> GetTestVectors()
     {
         foreach (ITestVector testVector in GenerateTestVectors(GetSingleValues(), typeof(SingleValueStructure<>)))

Src/FastData.SourceGenerator.Attributes/ClassType.cs

@@ -1,9 +1,16 @@
 namespace Genbox.FastData.SourceGenerator.Attributes;
 
+/// <summary>Specifies the type of class to generate.</summary>
 public enum ClassType
 {
     Unknown = 0,
+
+    /// <summary>It will generate a static class with static methods and properties.</summary>
     Static,
+
+    /// <summary>It will generate a class with instance methods and properties.</summary>
     Instance,
+
+    /// <summary>It will generate a struct with instance methods and properties.</summary>
     Struct
 }

Src/FastData.SourceGenerator.Attributes/ClassVisibility.cs

@@ -1,8 +1,11 @@
 namespace Genbox.FastData.SourceGenerator.Attributes;
 
+/// <summary>Specifies the visibility of the generated class.</summary>
 public enum ClassVisibility : byte
 {
     Unknown = 0,
+    /// <summary>The class will be internal.</summary>
     Internal,
+    /// <summary>The class will be public.</summary>
     Public
 }

Src/FastData.SourceGenerator.Attributes/StructureType.cs

@@ -1,16 +1,20 @@
 namespace Genbox.FastData.SourceGenerator.Attributes;
 
+/// <summary>Specifies the data structure type to generate.</summary>
 public enum StructureType : byte
 {
+    /// <summary>Automatically select the best structure type.</summary>
     Auto = 0,
 
-    // O(n) data structures
+    /// <summary>Use a simple array structure. Complexity: O(n).</summary>
     Array,
+
+    /// <summary>Use a conditional structure. Complexity: O(n).</summary>
     Conditional,
 
-    // O(log(n)) data structures
+    /// <summary>Use a binary search structure. Complexity: O(log n).</summary>
     BinarySearch,
 
-    // O(1) data structures
+    /// <summary>Use a hash set structure. Complexity: O(1).</summary>
     HashSet
 }

Src/FastData/FastDataConfig.cs

@@ -6,6 +6,9 @@ namespace Genbox.FastData;
 [UsedImplicitly(ImplicitUseTargetFlags.WithMembers)]
 public sealed class FastDataConfig(StructureType structureType = StructureType.Auto)
 {
+    /// <summary>The type of structure to create. Defaults to Auto.</summary>
     public StructureType StructureType { get; set; } = structureType;
+
+    /// <summary>For hash-based structures, you can set this factor higher or lower to control how many slots are used. A factor higher than 1 will use more memory, but can improve performance by reducing collisions. A factor lower than 1 will use less memory, but can increase collisions and thus reduce performance.</summary>
     public int HashCapacityFactor { get; set; } = 1;
 }

Src/FastData/FastDataGenerator.cs

@@ -19,6 +19,14 @@ public static partial class FastDataGenerator
 {
     internal const StringComparison DefaultStringComparison = StringComparison.Ordinal;
 
+    /// <summary>Generate source code for the provided data.</summary>
+    /// <param name="data">The data to generate from. Note that all objects must be the same type.</param>
+    /// <param name="fdCfg">The configuration to use.</param>
+    /// <param name="generator">The code generator to use.</param>
+    /// <param name="source">The source code with the generated data structure.</param>
+    /// <param name="factory">A logging factory</param>
+    /// <returns>True, if the generation succeeded, Otherwise, it returns false.</returns>
+    /// <exception cref="InvalidOperationException">Thrown when you gave an unsupported data type in data.</exception>
     public static bool TryGenerate(object[] data, FastDataConfig fdCfg, ICodeGenerator generator, out string? source, ILoggerFactory? factory = null) => data[0] switch
     {
         char => TryGenerate(data.Cast<char>().ToArray(), fdCfg, generator, out source, factory),
@@ -36,6 +44,14 @@ public static partial class FastDataGenerator
         _ => throw new InvalidOperationException($"Unsupported data type: {data[0].GetType().Name}")
     };
 
+    /// <summary>Generate source code for the provided data.</summary>
+    /// <param name="data">The data to generate from.</param>
+    /// <param name="fdCfg">The configuration to use.</param>
+    /// <param name="generator">The code generator to use.</param>
+    /// <param name="source">The source code with the generated data structure.</param>
+    /// <param name="factory">A logging factory</param>
+    /// <returns>True, if the generation succeeded, Otherwise, it returns false.</returns>
+    /// <exception cref="InvalidOperationException">Thrown when you gave an unsupported data type in data.</exception>
     public static bool TryGenerate<T>(T[] data, FastDataConfig fdCfg, ICodeGenerator generator, out string? source, ILoggerFactory? factory = null) where T : notnull
     {
         if (data.Length == 0)

Src/FastData/Generators/Abstracts/ICodeGenerator.cs

@@ -1,7 +1,16 @@
 namespace Genbox.FastData.Generators.Abstracts;
 
+/// <summary>Defines the interface for code generators</summary>
 public interface ICodeGenerator
 {
+    /// <summary>Gets a value indicating whether the generator uses UTF-16 encoding for string inputs (used in hashing).</summary>
     bool UseUTF16Encoding { get; }
+
+    /// <summary>Attempts to generate source code using the specified generator configuration and context.</summary>
+    /// <typeparam name="T">The type of data being generated.</typeparam>
+    /// <param name="genCfg">The generator configuration.</param>
+    /// <param name="context">The context for code generation.</param>
+    /// <param name="source">When this method returns, contains the generated source code if the operation succeeded; otherwise, null.</param>
+    /// <returns>True if code generation succeeded; otherwise, false.</returns>
     bool TryGenerate<T>(GeneratorConfig<T> genCfg, IContext context, out string? source);
 }

Src/FastData/Generators/Abstracts/IContext.cs

@@ -1,3 +1,4 @@
 namespace Genbox.FastData.Generators.Abstracts;
 
+/// <summary>Defines the interface for a context used during code generation. A context represents a self-contained container of data for a data structure.</summary>
 public interface IContext;