Skip to content

Commit 6b237c3

Browse files
committed
Fix inheritdoc tags on types: defaults to System.Object when cref omitted
1 parent 8c2b621 commit 6b237c3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+54
-45
lines changed

src/JsonApiDotNetCore/AtomicOperations/LocalIdTracker.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace JsonApiDotNetCore.AtomicOperations;
55

6-
/// <inheritdoc />
6+
/// <inheritdoc cref="ILocalIdTracker" />
77
public sealed class LocalIdTracker : ILocalIdTracker
88
{
99
private readonly IDictionary<string, LocalIdState> _idsTracked = new Dictionary<string, LocalIdState>();

src/JsonApiDotNetCore/AtomicOperations/OperationProcessorAccessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
namespace JsonApiDotNetCore.AtomicOperations;
99

10-
/// <inheritdoc />
10+
/// <inheritdoc cref="IOperationProcessorAccessor" />
1111
[PublicAPI]
1212
public class OperationProcessorAccessor : IOperationProcessorAccessor
1313
{

src/JsonApiDotNetCore/AtomicOperations/OperationsProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace JsonApiDotNetCore.AtomicOperations;
1010

11-
/// <inheritdoc />
11+
/// <inheritdoc cref="IOperationsProcessor" />
1212
[PublicAPI]
1313
public class OperationsProcessor : IOperationsProcessor
1414
{

src/JsonApiDotNetCore/AtomicOperations/Processors/AddToRelationshipProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.AtomicOperations.Processors;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IAddToRelationshipProcessor{TResource,TId}" />
88
[PublicAPI]
99
public class AddToRelationshipProcessor<TResource, TId> : IAddToRelationshipProcessor<TResource, TId>
1010
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/AtomicOperations/Processors/CreateProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.AtomicOperations.Processors;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="ICreateProcessor{TResource,TId}" />
88
[PublicAPI]
99
public class CreateProcessor<TResource, TId> : ICreateProcessor<TResource, TId>
1010
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/AtomicOperations/Processors/DeleteProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.AtomicOperations.Processors;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IDeleteProcessor{TResource,TId}" />
88
[PublicAPI]
99
public class DeleteProcessor<TResource, TId> : IDeleteProcessor<TResource, TId>
1010
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/AtomicOperations/Processors/RemoveFromRelationshipProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.AtomicOperations.Processors;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IRemoveFromRelationshipProcessor{TResource,TId}" />
88
[PublicAPI]
99
public class RemoveFromRelationshipProcessor<TResource, TId> : IRemoveFromRelationshipProcessor<TResource, TId>
1010
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/AtomicOperations/Processors/SetRelationshipProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace JsonApiDotNetCore.AtomicOperations.Processors;
77

8-
/// <inheritdoc />
8+
/// <inheritdoc cref="ISetRelationshipProcessor{TResource,TId}" />
99
[PublicAPI]
1010
public class SetRelationshipProcessor<TResource, TId> : ISetRelationshipProcessor<TResource, TId>
1111
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/AtomicOperations/Processors/UpdateProcessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.AtomicOperations.Processors;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IUpdateProcessor{TResource,TId}" />
88
[PublicAPI]
99
public class UpdateProcessor<TResource, TId> : IUpdateProcessor<TResource, TId>
1010
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/Configuration/InverseNavigationResolver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace JsonApiDotNetCore.Configuration;
88

9-
/// <inheritdoc />
9+
/// <inheritdoc cref="IInverseNavigationResolver" />
1010
[PublicAPI]
1111
public sealed class InverseNavigationResolver : IInverseNavigationResolver
1212
{

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
namespace JsonApiDotNetCore.Configuration;
99

10-
/// <inheritdoc />
10+
/// <inheritdoc cref="IJsonApiOptions" />
1111
[PublicAPI]
1212
public sealed class JsonApiOptions : IJsonApiOptions
1313
{

src/JsonApiDotNetCore/Configuration/ResourceGraph.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace JsonApiDotNetCore.Configuration;
88

9-
/// <inheritdoc />
9+
/// <inheritdoc cref="IResourceGraph" />
1010
[PublicAPI]
1111
public sealed class ResourceGraph : IResourceGraph
1212
{

src/JsonApiDotNetCore/Middleware/AsyncConvertEmptyActionResultFilter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Middleware;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IAsyncConvertEmptyActionResultFilter" />
88
public sealed class AsyncConvertEmptyActionResultFilter : IAsyncConvertEmptyActionResultFilter
99
{
1010
/// <inheritdoc />

src/JsonApiDotNetCore/Middleware/AsyncJsonApiExceptionFilter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace JsonApiDotNetCore.Middleware;
77

8-
/// <inheritdoc />
8+
/// <inheritdoc cref="IAsyncJsonApiExceptionFilter" />
99
[PublicAPI]
1010
public sealed class AsyncJsonApiExceptionFilter : IAsyncJsonApiExceptionFilter
1111
{

src/JsonApiDotNetCore/Middleware/AsyncQueryStringActionFilter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace JsonApiDotNetCore.Middleware;
77

8-
/// <inheritdoc />
8+
/// <inheritdoc cref="IAsyncQueryStringActionFilter" />
99
public sealed class AsyncQueryStringActionFilter : IAsyncQueryStringActionFilter
1010
{
1111
private readonly IQueryStringReader _queryStringReader;

src/JsonApiDotNetCore/Middleware/ExceptionHandler.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace JsonApiDotNetCore.Middleware;
1010

11-
/// <inheritdoc />
11+
/// <inheritdoc cref="IExceptionHandler" />
1212
[PublicAPI]
1313
public class ExceptionHandler : IExceptionHandler
1414
{

src/JsonApiDotNetCore/Middleware/JsonApiInputFormatter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Middleware;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IJsonApiInputFormatter" />
88
public sealed class JsonApiInputFormatter : IJsonApiInputFormatter
99
{
1010
/// <inheritdoc />

src/JsonApiDotNetCore/Middleware/JsonApiOutputFormatter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Middleware;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IJsonApiOutputFormatter" />
88
public sealed class JsonApiOutputFormatter : IJsonApiOutputFormatter
99
{
1010
/// <inheritdoc />

src/JsonApiDotNetCore/Middleware/JsonApiRequest.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Middleware;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IJsonApiRequest" />
88
[PublicAPI]
99
public sealed class JsonApiRequest : IJsonApiRequest
1010
{

src/JsonApiDotNetCore/Queries/EvaluatedIncludeCache.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace JsonApiDotNetCore.Queries;
44

5-
/// <inheritdoc />
5+
/// <inheritdoc cref="IEvaluatedIncludeCache" />
66
internal sealed class EvaluatedIncludeCache : IEvaluatedIncludeCache
77
{
88
private readonly IEnumerable<IQueryConstraintProvider> _constraintProviders;

src/JsonApiDotNetCore/Queries/PaginationContext.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace JsonApiDotNetCore.Queries;
44

5-
/// <inheritdoc />
5+
/// <inheritdoc cref="IPaginationContext" />
66
internal sealed class PaginationContext : IPaginationContext
77
{
88
/// <inheritdoc />

src/JsonApiDotNetCore/Queries/QueryLayerComposer.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace JsonApiDotNetCore.Queries;
1010

11-
/// <inheritdoc />
11+
/// <inheritdoc cref="IQueryLayerComposer" />
1212
[PublicAPI]
1313
public class QueryLayerComposer : IQueryLayerComposer
1414
{

src/JsonApiDotNetCore/Queries/QueryableBuilding/QueryableBuilder.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace JsonApiDotNetCore.Queries.QueryableBuilding;
77

8-
/// <see cref="IQueryableBuilder" />
8+
/// <inheritdoc cref="IQueryableBuilder" />
99
[PublicAPI]
1010
public class QueryableBuilder : IQueryableBuilder
1111
{

src/JsonApiDotNetCore/Queries/SparseFieldSetCache.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
namespace JsonApiDotNetCore.Queries;
99

10-
/// <inheritdoc />
10+
/// <inheritdoc cref="ISparseFieldSetCache" />
1111
public sealed class SparseFieldSetCache : ISparseFieldSetCache
1212
{
1313
private static readonly ConcurrentDictionary<ResourceType, SparseFieldSetExpression> ViewableFieldSetCache = new();

src/JsonApiDotNetCore/QueryStrings/QueryStringReader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
namespace JsonApiDotNetCore.QueryStrings;
99

10-
/// <inheritdoc />
10+
/// <inheritdoc cref="IQueryStringReader" />
1111
public sealed class QueryStringReader : IQueryStringReader
1212
{
1313
private readonly IJsonApiOptions _options;

src/JsonApiDotNetCore/QueryStrings/RequestQueryStringAccessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace JsonApiDotNetCore.QueryStrings;
44

5-
/// <inheritdoc />
5+
/// <inheritdoc cref="IRequestQueryStringAccessor" />
66
internal sealed class RequestQueryStringAccessor : IRequestQueryStringAccessor
77
{
88
private readonly IHttpContextAccessor _httpContextAccessor;

src/JsonApiDotNetCore/QueryStrings/ResourceDefinitionQueryableParameterReader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace JsonApiDotNetCore.QueryStrings;
1111

12-
/// <inheritdoc />
12+
/// <inheritdoc cref="IResourceDefinitionQueryableParameterReader" />
1313
[PublicAPI]
1414
public class ResourceDefinitionQueryableParameterReader : IResourceDefinitionQueryableParameterReader
1515
{

src/JsonApiDotNetCore/Repositories/DbContextResolver.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace JsonApiDotNetCore.Repositories;
55

6-
/// <inheritdoc />
6+
/// <inheritdoc cref="IDbContextResolver" />
77
[PublicAPI]
88
public sealed class DbContextResolver<TDbContext> : IDbContextResolver
99
where TDbContext : DbContext

src/JsonApiDotNetCore/Repositories/ResourceRepositoryAccessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace JsonApiDotNetCore.Repositories;
1111

12-
/// <inheritdoc />
12+
/// <inheritdoc cref="IResourceRepositoryAccessor" />
1313
[PublicAPI]
1414
public class ResourceRepositoryAccessor : IResourceRepositoryAccessor
1515
{

src/JsonApiDotNetCore/Resources/JsonApiResourceDefinition.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
namespace JsonApiDotNetCore.Resources;
1414

15-
/// <inheritdoc />
15+
/// <inheritdoc cref="IResourceDefinition{TResource,TId}" />
1616
[PublicAPI]
1717
public class JsonApiResourceDefinition<TResource, TId> : IResourceDefinition<TResource, TId>
1818
where TResource : class, IIdentifiable<TId>

src/JsonApiDotNetCore/Resources/ResourceChangeTracker.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Resources;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IResourceChangeTracker{TResource}" />
88
[PublicAPI]
99
public sealed class ResourceChangeTracker<TResource> : IResourceChangeTracker<TResource>
1010
where TResource : class, IIdentifiable

src/JsonApiDotNetCore/Resources/ResourceDefinitionAccessor.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace JsonApiDotNetCore.Resources;
1111

12-
/// <inheritdoc />
12+
/// <inheritdoc cref="IResourceDefinitionAccessor" />
1313
[PublicAPI]
1414
public class ResourceDefinitionAccessor : IResourceDefinitionAccessor
1515
{

src/JsonApiDotNetCore/Resources/ResourceFactory.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace JsonApiDotNetCore.Resources;
88

9-
/// <inheritdoc />
9+
/// <inheritdoc cref="IResourceFactory" />
1010
internal sealed class ResourceFactory : IResourceFactory
1111
{
1212
private static readonly TypeLocator TypeLocator = new();

src/JsonApiDotNetCore/Resources/TargetedFields.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace JsonApiDotNetCore.Resources;
55

6-
/// <inheritdoc />
6+
/// <inheritdoc cref="ITargetedFields" />
77
[PublicAPI]
88
public sealed class TargetedFields : ITargetedFields
99
{

src/JsonApiDotNetCore/Serialization/JsonConverters/SingleOrManyDataConverterFactory.cs

+2
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ namespace JsonApiDotNetCore.Serialization.JsonConverters;
1212
[UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
1313
public sealed class SingleOrManyDataConverterFactory : JsonConverterFactory
1414
{
15+
/// <inheritdoc />
1516
public override bool CanConvert(Type typeToConvert)
1617
{
1718
return typeToConvert.IsGenericType && typeToConvert.GetGenericTypeDefinition() == typeof(SingleOrManyData<>);
1819
}
1920

21+
/// <inheritdoc />
2022
public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
2123
{
2224
Type objectType = typeToConvert.GetGenericArguments()[0];

src/JsonApiDotNetCore/Serialization/JsonConverters/WriteOnlyDocumentConverter.cs

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ public sealed class WriteOnlyDocumentConverter : JsonObjectConverter<Document>
1919
private static readonly JsonEncodedText IncludedText = JsonEncodedText.Encode("included");
2020
private static readonly JsonEncodedText MetaText = JsonEncodedText.Encode("meta");
2121

22+
/// <summary>
23+
/// Always throws a <see cref="NotSupportedException" />. This converter is write-only.
24+
/// </summary>
2225
public override Document Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
2326
{
2427
throw new NotSupportedException("This converter cannot be used for reading JSON.");

src/JsonApiDotNetCore/Serialization/JsonConverters/WriteOnlyRelationshipObjectConverter.cs

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ public sealed class WriteOnlyRelationshipObjectConverter : JsonObjectConverter<R
1414
private static readonly JsonEncodedText LinksText = JsonEncodedText.Encode("links");
1515
private static readonly JsonEncodedText MetaText = JsonEncodedText.Encode("meta");
1616

17+
/// <summary>
18+
/// Always throws a <see cref="NotSupportedException" />. This converter is write-only.
19+
/// </summary>
1720
public override RelationshipObject Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
1821
{
1922
throw new NotSupportedException("This converter cannot be used for reading JSON.");

src/JsonApiDotNetCore/Serialization/Request/Adapters/AtomicOperationObjectAdapter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace JsonApiDotNetCore.Serialization.Request.Adapters;
88

9-
/// <inheritdoc />
9+
/// <inheritdoc cref="IAtomicOperationObjectAdapter" />
1010
public sealed class AtomicOperationObjectAdapter : IAtomicOperationObjectAdapter
1111
{
1212
private readonly IResourceDataInOperationsRequestAdapter _resourceDataInOperationsRequestAdapter;

src/JsonApiDotNetCore/Serialization/Request/Adapters/DocumentAdapter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace JsonApiDotNetCore.Serialization.Request.Adapters;
66

7-
/// <inheritdoc />
7+
/// <inheritdoc cref="IDocumentAdapter" />
88
public sealed class DocumentAdapter : IDocumentAdapter
99
{
1010
private readonly IJsonApiRequest _request;

src/JsonApiDotNetCore/Serialization/Request/Adapters/DocumentInResourceOrRelationshipRequestAdapter.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace JsonApiDotNetCore.Serialization.Request.Adapters;
77

8-
/// <inheritdoc />
8+
/// <inheritdoc cref="IDocumentInResourceOrRelationshipRequestAdapter" />
99
public sealed class DocumentInResourceOrRelationshipRequestAdapter : IDocumentInResourceOrRelationshipRequestAdapter
1010
{
1111
private readonly IJsonApiOptions _options;

src/JsonApiDotNetCore/Serialization/Request/JsonApiReader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
namespace JsonApiDotNetCore.Serialization.Request;
1818

19-
/// <inheritdoc />
19+
/// <inheritdoc cref="IJsonApiReader" />
2020
public sealed class JsonApiReader : IJsonApiReader
2121
{
2222
private readonly IJsonApiOptions _options;

src/JsonApiDotNetCore/Serialization/Response/ETagGenerator.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace JsonApiDotNetCore.Serialization.Response;
44

5-
/// <inheritdoc />
5+
/// <inheritdoc cref="IETagGenerator" />
66
internal sealed class ETagGenerator : IETagGenerator
77
{
88
private readonly IFingerprintGenerator _fingerprintGenerator;

src/JsonApiDotNetCore/Serialization/Response/EmptyResponseMeta.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
namespace JsonApiDotNetCore.Serialization.Response;
22

3-
/// <inheritdoc />
3+
/// <inheritdoc cref="IResponseMeta" />
44
public sealed class EmptyResponseMeta : IResponseMeta
55
{
66
/// <inheritdoc />

0 commit comments

Comments
 (0)