From 8a7fcf1fe1e2c12ba56c59614f2cf019c451b4ab Mon Sep 17 00:00:00 2001
From: Bart Koelman <10324372+bkoelman@users.noreply.github.com>
Date: Sun, 3 Mar 2024 13:43:12 +0100
Subject: [PATCH] Add missing documentation for type parameters

---
 .../Queries/Expressions/QueryExpressionVisitor.cs           | 6 ++++++
 src/JsonApiDotNetCore/Repositories/DbContextResolver.cs     | 3 +++
 .../Repositories/EntityFrameworkCoreRepository.cs           | 6 ++++++
 src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs   | 3 +++
 .../Resources/QueryStringParameterHandlers.cs               | 3 +++
 .../Serialization/Objects/SingleOrManyData.cs               | 3 +++
 6 files changed, 24 insertions(+)

diff --git a/src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionVisitor.cs b/src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionVisitor.cs
index 7dcf44b1f4..12242c29ff 100644
--- a/src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionVisitor.cs
+++ b/src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionVisitor.cs
@@ -5,6 +5,12 @@ namespace JsonApiDotNetCore.Queries.Expressions;
 /// <summary>
 /// Implements the visitor design pattern that enables traversing a <see cref="QueryExpression" /> tree.
 /// </summary>
+/// <typeparam name="TArgument">
+/// The type to use for passing custom state between visit methods.
+/// </typeparam>
+/// <typeparam name="TResult">
+/// The type that is returned from visit methods.
+/// </typeparam>
 [PublicAPI]
 public abstract class QueryExpressionVisitor<TArgument, TResult>
 {
diff --git a/src/JsonApiDotNetCore/Repositories/DbContextResolver.cs b/src/JsonApiDotNetCore/Repositories/DbContextResolver.cs
index 794eecc6f2..bc275a96c1 100644
--- a/src/JsonApiDotNetCore/Repositories/DbContextResolver.cs
+++ b/src/JsonApiDotNetCore/Repositories/DbContextResolver.cs
@@ -4,6 +4,9 @@
 namespace JsonApiDotNetCore.Repositories;
 
 /// <inheritdoc cref="IDbContextResolver" />
+/// <typeparam name="TDbContext">
+/// The type of the <see cref="DbContext" /> to resolve.
+/// </typeparam>
 [PublicAPI]
 public sealed class DbContextResolver<TDbContext> : IDbContextResolver
     where TDbContext : DbContext
diff --git a/src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs b/src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs
index 4c3314ddab..a5f083932b 100644
--- a/src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs
+++ b/src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs
@@ -21,6 +21,12 @@ namespace JsonApiDotNetCore.Repositories;
 /// <summary>
 /// Implements the foundational Repository layer in the JsonApiDotNetCore architecture that uses Entity Framework Core.
 /// </summary>
+/// <typeparam name="TResource">
+/// The resource type.
+/// </typeparam>
+/// <typeparam name="TId">
+/// The resource identifier type.
+/// </typeparam>
 [PublicAPI]
 public class EntityFrameworkCoreRepository<TResource, TId> : IResourceRepository<TResource, TId>, IRepositorySupportsTransaction
     where TResource : class, IIdentifiable<TId>
diff --git a/src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs b/src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs
index 1f69735f92..13404f2759 100644
--- a/src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs
+++ b/src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs
@@ -3,6 +3,9 @@ namespace JsonApiDotNetCore.Resources;
 /// <summary>
 /// Used to determine whether additional changes to a resource (side effects), not specified in a POST or PATCH request, have been applied.
 /// </summary>
+/// <typeparam name="TResource">
+/// The resource type.
+/// </typeparam>
 public interface IResourceChangeTracker<in TResource>
     where TResource : class, IIdentifiable
 {
diff --git a/src/JsonApiDotNetCore/Resources/QueryStringParameterHandlers.cs b/src/JsonApiDotNetCore/Resources/QueryStringParameterHandlers.cs
index b48c46e26e..7fe8970b53 100644
--- a/src/JsonApiDotNetCore/Resources/QueryStringParameterHandlers.cs
+++ b/src/JsonApiDotNetCore/Resources/QueryStringParameterHandlers.cs
@@ -6,4 +6,7 @@ namespace JsonApiDotNetCore.Resources;
 /// This is an alias type intended to simplify the implementation's method signature. See
 /// <see cref="IResourceDefinition{TResource, TId}.OnRegisterQueryableHandlersForQueryStringParameters" /> for usage details.
 /// </summary>
+/// <typeparam name="TResource">
+/// The resource type.
+/// </typeparam>
 public sealed class QueryStringParameterHandlers<TResource> : Dictionary<string, Func<IQueryable<TResource>, StringValues, IQueryable<TResource>>>;
diff --git a/src/JsonApiDotNetCore/Serialization/Objects/SingleOrManyData.cs b/src/JsonApiDotNetCore/Serialization/Objects/SingleOrManyData.cs
index 1126f84f26..99884d61e6 100644
--- a/src/JsonApiDotNetCore/Serialization/Objects/SingleOrManyData.cs
+++ b/src/JsonApiDotNetCore/Serialization/Objects/SingleOrManyData.cs
@@ -9,6 +9,9 @@ namespace JsonApiDotNetCore.Serialization.Objects;
 /// Represents the value of the "data" element, which is either null, a single object or an array of objects. Add
 /// <see cref="SingleOrManyDataConverterFactory" /> to <see cref="JsonSerializerOptions.Converters" /> to properly roundtrip.
 /// </summary>
+/// <typeparam name="T">
+/// The type of elements being wrapped, typically <see cref="ResourceIdentifierObject" /> or <see cref="ResourceObject" />.
+/// </typeparam>
 [PublicAPI]
 public readonly struct SingleOrManyData<T>
     // The "new()" constraint exists for parity with SingleOrManyDataConverterFactory, which creates empty instances