Skip to content

Commit 8a7fcf1

Browse files
committed
Add missing documentation for type parameters
1 parent 72bd6f8 commit 8a7fcf1

File tree

6 files changed

+24
-0
lines changed

6 files changed

+24
-0
lines changed

src/JsonApiDotNetCore/Queries/Expressions/QueryExpressionVisitor.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ namespace JsonApiDotNetCore.Queries.Expressions;
55
/// <summary>
66
/// Implements the visitor design pattern that enables traversing a <see cref="QueryExpression" /> tree.
77
/// </summary>
8+
/// <typeparam name="TArgument">
9+
/// The type to use for passing custom state between visit methods.
10+
/// </typeparam>
11+
/// <typeparam name="TResult">
12+
/// The type that is returned from visit methods.
13+
/// </typeparam>
814
[PublicAPI]
915
public abstract class QueryExpressionVisitor<TArgument, TResult>
1016
{

src/JsonApiDotNetCore/Repositories/DbContextResolver.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
namespace JsonApiDotNetCore.Repositories;
55

66
/// <inheritdoc cref="IDbContextResolver" />
7+
/// <typeparam name="TDbContext">
8+
/// The type of the <see cref="DbContext" /> to resolve.
9+
/// </typeparam>
710
[PublicAPI]
811
public sealed class DbContextResolver<TDbContext> : IDbContextResolver
912
where TDbContext : DbContext

src/JsonApiDotNetCore/Repositories/EntityFrameworkCoreRepository.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ namespace JsonApiDotNetCore.Repositories;
2121
/// <summary>
2222
/// Implements the foundational Repository layer in the JsonApiDotNetCore architecture that uses Entity Framework Core.
2323
/// </summary>
24+
/// <typeparam name="TResource">
25+
/// The resource type.
26+
/// </typeparam>
27+
/// <typeparam name="TId">
28+
/// The resource identifier type.
29+
/// </typeparam>
2430
[PublicAPI]
2531
public class EntityFrameworkCoreRepository<TResource, TId> : IResourceRepository<TResource, TId>, IRepositorySupportsTransaction
2632
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/Resources/IResourceChangeTracker.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ namespace JsonApiDotNetCore.Resources;
33
/// <summary>
44
/// Used to determine whether additional changes to a resource (side effects), not specified in a POST or PATCH request, have been applied.
55
/// </summary>
6+
/// <typeparam name="TResource">
7+
/// The resource type.
8+
/// </typeparam>
69
public interface IResourceChangeTracker<in TResource>
710
where TResource : class, IIdentifiable
811
{

src/JsonApiDotNetCore/Resources/QueryStringParameterHandlers.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@ namespace JsonApiDotNetCore.Resources;
66
/// This is an alias type intended to simplify the implementation's method signature. See
77
/// <see cref="IResourceDefinition{TResource, TId}.OnRegisterQueryableHandlersForQueryStringParameters" /> for usage details.
88
/// </summary>
9+
/// <typeparam name="TResource">
10+
/// The resource type.
11+
/// </typeparam>
912
public sealed class QueryStringParameterHandlers<TResource> : Dictionary<string, Func<IQueryable<TResource>, StringValues, IQueryable<TResource>>>;

src/JsonApiDotNetCore/Serialization/Objects/SingleOrManyData.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ namespace JsonApiDotNetCore.Serialization.Objects;
99
/// Represents the value of the "data" element, which is either null, a single object or an array of objects. Add
1010
/// <see cref="SingleOrManyDataConverterFactory" /> to <see cref="JsonSerializerOptions.Converters" /> to properly roundtrip.
1111
/// </summary>
12+
/// <typeparam name="T">
13+
/// The type of elements being wrapped, typically <see cref="ResourceIdentifierObject" /> or <see cref="ResourceObject" />.
14+
/// </typeparam>
1215
[PublicAPI]
1316
public readonly struct SingleOrManyData<T>
1417
// The "new()" constraint exists for parity with SingleOrManyDataConverterFactory, which creates empty instances

0 commit comments

Comments
 (0)