diff --git a/.editorconfig b/.editorconfig index cdd9d86eb84..fe571bfed3d 100644 --- a/.editorconfig +++ b/.editorconfig @@ -313,6 +313,8 @@ dotnet_diagnostic.RCS1205.severity = warning dotnet_diagnostic.RCS1214.severity = warning # Convert interpolated string to concatenation. dotnet_diagnostic.RCS1217.severity = warning +# Unused element in a documentation comment. +dotnet_diagnostic.RCS1228.severity = warning # Unnecessary null-forgiving operator. dotnet_diagnostic.RCS1249.severity = warning # Remove unnecessary braces. diff --git a/src/GreenDonut/src/GreenDonut.Abstractions/Attributes/DataLoaderModuleAttribute.cs b/src/GreenDonut/src/GreenDonut.Abstractions/Attributes/DataLoaderModuleAttribute.cs index b64386da01e..43d35dbb553 100644 --- a/src/GreenDonut/src/GreenDonut.Abstractions/Attributes/DataLoaderModuleAttribute.cs +++ b/src/GreenDonut/src/GreenDonut.Abstractions/Attributes/DataLoaderModuleAttribute.cs @@ -21,7 +21,6 @@ public DataLoaderModuleAttribute(string name) /// /// Gets the module name. /// - /// public string Name { get; } /// diff --git a/src/GreenDonut/src/GreenDonut.Abstractions/IPromise.cs b/src/GreenDonut/src/GreenDonut.Abstractions/IPromise.cs index d08a7c79685..b5eb1463e43 100644 --- a/src/GreenDonut/src/GreenDonut.Abstractions/IPromise.cs +++ b/src/GreenDonut/src/GreenDonut.Abstractions/IPromise.cs @@ -23,13 +23,13 @@ public interface IPromise /// /// Tries to set the result of the async work for this promise. /// - /// + /// The result of the async work. void TrySetResult(object? result); /// /// Tries to set an exception for the async work for this promise. /// - /// + /// The exception to set. void TrySetError(Exception exception); /// diff --git a/src/GreenDonut/src/GreenDonut.Abstractions/Promise.cs b/src/GreenDonut/src/GreenDonut.Abstractions/Promise.cs index 7616f59802c..7759087cc4d 100644 --- a/src/GreenDonut/src/GreenDonut.Abstractions/Promise.cs +++ b/src/GreenDonut/src/GreenDonut.Abstractions/Promise.cs @@ -6,7 +6,7 @@ namespace GreenDonut; /// a , /// or a . /// -/// +/// The type of the value that the promise will produce. public readonly struct Promise : IPromise { private readonly TaskCompletionSource? _completionSource; diff --git a/src/GreenDonut/src/GreenDonut.Data.EntityFramework/Extensions/PagingQueryableExtensions.cs b/src/GreenDonut/src/GreenDonut.Data.EntityFramework/Extensions/PagingQueryableExtensions.cs index efa5c31327a..679731798f2 100644 --- a/src/GreenDonut/src/GreenDonut.Data.EntityFramework/Extensions/PagingQueryableExtensions.cs +++ b/src/GreenDonut/src/GreenDonut.Data.EntityFramework/Extensions/PagingQueryableExtensions.cs @@ -295,7 +295,9 @@ public static async ValueTask> ToPageAsync( /// /// The type of the items in the queryable. /// - /// + /// + /// A dictionary mapping each parent key to its page of results. + /// /// /// If the queryable does not have any keys specified. /// @@ -337,7 +339,9 @@ public static ValueTask>> ToBatchPageAsync /// The type of the items in the queryable. /// - /// + /// + /// A dictionary mapping each parent key to its page of results. + /// /// /// If the queryable does not have any keys specified. /// @@ -383,7 +387,9 @@ public static ValueTask>> ToBatchPageAsync /// The type of the source elements from which keys and values are projected. /// - /// + /// + /// A dictionary mapping each parent key to its page of results. + /// /// /// If the queryable does not have any keys specified. /// @@ -432,7 +438,9 @@ public static ValueTask>> ToBatchPageAsync /// The type of the source elements from which keys and values are projected. /// - /// + /// + /// A dictionary mapping each parent key to its page of results. + /// /// /// If the queryable does not have any keys specified. /// diff --git a/src/GreenDonut/src/GreenDonut.Data/Cursors/CursorKey.cs b/src/GreenDonut/src/GreenDonut.Data/Cursors/CursorKey.cs index 522aaa939c9..4e0552c48fe 100644 --- a/src/GreenDonut/src/GreenDonut.Data/Cursors/CursorKey.cs +++ b/src/GreenDonut/src/GreenDonut.Data/Cursors/CursorKey.cs @@ -44,7 +44,7 @@ public sealed class CursorKey( /// /// The span within the overall cursor that represents the key value. /// - /// + /// The parsed key value. public object? Parse(ReadOnlySpan cursorValue) => CursorKeySerializerHelper.Parse(cursorValue, serializer); diff --git a/src/GreenDonut/src/GreenDonut/PromiseCacheObserver.cs b/src/GreenDonut/src/GreenDonut/PromiseCacheObserver.cs index b396f569da3..c6e62938cef 100644 --- a/src/GreenDonut/src/GreenDonut/PromiseCacheObserver.cs +++ b/src/GreenDonut/src/GreenDonut/PromiseCacheObserver.cs @@ -96,8 +96,8 @@ public virtual void Accept(IPromiseCache cache, string? skipCacheKeyType) /// /// The method is called when a new task is added to the cache. /// - /// - /// + /// The promise cache that the new entry was added to. + /// The promise that was added to the cache. public abstract void OnNext(IPromiseCache cache, Promise promise); public void Dispose() diff --git a/src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs b/src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs index e121d8aa452..a90dcb14b03 100644 --- a/src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs +++ b/src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs @@ -52,7 +52,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -76,7 +78,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/ApolloFederation/src/ApolloFederation/Representation.cs b/src/HotChocolate/ApolloFederation/src/ApolloFederation/Representation.cs index fe8ae7cef56..397fa27dfe5 100644 --- a/src/HotChocolate/ApolloFederation/src/ApolloFederation/Representation.cs +++ b/src/HotChocolate/ApolloFederation/src/ApolloFederation/Representation.cs @@ -28,7 +28,6 @@ public Representation(string typeName, ObjectValueNode data) /// /// Gets the type name of the entity. /// - /// public string TypeName { get; } /// diff --git a/src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Directives/KeyDescriptorExtensions.cs b/src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Directives/KeyDescriptorExtensions.cs index d2f6034b406..f2f7724f49a 100644 --- a/src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Directives/KeyDescriptorExtensions.cs +++ b/src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Directives/KeyDescriptorExtensions.cs @@ -33,7 +33,7 @@ public static class KeyDescriptorExtensions /// /// Boolean flag to indicate whether this entity is resolvable locally. /// - /// + /// The entity resolver descriptor. /// /// is null. /// @@ -74,7 +74,7 @@ public static IEntityResolverDescriptor Key( /// /// Boolean flag to indicate whether this entity is resolvable locally. /// - /// + /// The entity resolver descriptor. /// /// is null. /// @@ -125,7 +125,7 @@ public static IEntityResolverDescriptor Key( /// /// Boolean flag to indicate whether this entity is resolvable locally. /// - /// + /// The entity resolver descriptor. /// /// is null. /// @@ -166,7 +166,7 @@ public static IEntityResolverDescriptor Key( /// /// Boolean flag to indicate whether this entity is resolvable locally. /// - /// + /// The entity resolver descriptor. /// /// is null. /// diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore.Authorization.Opa/IOpaService.cs b/src/HotChocolate/AspNetCore/src/AspNetCore.Authorization.Opa/IOpaService.cs index 9840c7af544..c7bd909176f 100644 --- a/src/HotChocolate/AspNetCore/src/AspNetCore.Authorization.Opa/IOpaService.cs +++ b/src/HotChocolate/AspNetCore/src/AspNetCore.Authorization.Opa/IOpaService.cs @@ -11,7 +11,7 @@ public interface IOpaService /// The string parameter representing path of the evaluating policy. /// The instance . /// Cancellation token. - /// + /// The OPA policy decision response. Task QueryAsync( string policyPath, OpaQueryRequest request, diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreHostingBuilderExtensions.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreHostingBuilderExtensions.cs index e2534a8d9dc..0040b5c3108 100644 --- a/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreHostingBuilderExtensions.cs +++ b/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreHostingBuilderExtensions.cs @@ -24,7 +24,9 @@ public static class HotChocolateAspNetCoreHostingBuilderExtensions /// /// Defines if the default security policy should be disabled. /// - /// + /// + /// The for configuration chaining. + /// public static IRequestExecutorBuilder AddGraphQL( this IHostApplicationBuilder builder, string? schemaName = null, diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs index 28079dd2b4f..00ade90a40a 100644 --- a/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs +++ b/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs @@ -84,7 +84,9 @@ public static IRequestExecutorBuilder AddHttpRequestInterceptor( /// /// A delegate that allows to configure the GraphQL request. /// - /// + /// + /// The for configuration chaining. + /// public static IRequestExecutorBuilder AddHttpRequestInterceptor( this IRequestExecutorBuilder builder, Func handler) diff --git a/src/HotChocolate/AspNetCore/src/Transport.Abstractions/OperationBatchRequest.cs b/src/HotChocolate/AspNetCore/src/Transport.Abstractions/OperationBatchRequest.cs index d0c90cd9ca5..c0c48134cb8 100644 --- a/src/HotChocolate/AspNetCore/src/Transport.Abstractions/OperationBatchRequest.cs +++ b/src/HotChocolate/AspNetCore/src/Transport.Abstractions/OperationBatchRequest.cs @@ -173,7 +173,10 @@ public override int GetHashCode() /// /// The second to compare. /// - /// + /// + /// true if the two objects are equal; + /// otherwise, false. + /// public static bool operator ==(OperationBatchRequest left, OperationBatchRequest right) => left.Equals(right); @@ -186,7 +189,10 @@ public override int GetHashCode() /// /// The second to compare. /// - /// + /// + /// true if the two objects are not equal; + /// otherwise, false. + /// public static bool operator !=(OperationBatchRequest left, OperationBatchRequest right) => !left.Equals(right); } diff --git a/src/HotChocolate/AspNetCore/src/Transport.Http/DefaultGraphQLHttpClient.cs b/src/HotChocolate/AspNetCore/src/Transport.Http/DefaultGraphQLHttpClient.cs index 171926e6439..088782085bf 100644 --- a/src/HotChocolate/AspNetCore/src/Transport.Http/DefaultGraphQLHttpClient.cs +++ b/src/HotChocolate/AspNetCore/src/Transport.Http/DefaultGraphQLHttpClient.cs @@ -76,7 +76,7 @@ public DefaultGraphQLHttpClient(HttpClient httpClient) /// /// A cancellation token that can be used to cancel the HTTP request. /// - /// + /// The GraphQL HTTP response. /// /// is . /// diff --git a/src/HotChocolate/AspNetCore/src/Transport.Sockets/MessagePipeline.cs b/src/HotChocolate/AspNetCore/src/Transport.Sockets/MessagePipeline.cs index 076d980e54e..333a79b3413 100644 --- a/src/HotChocolate/AspNetCore/src/Transport.Sockets/MessagePipeline.cs +++ b/src/HotChocolate/AspNetCore/src/Transport.Sockets/MessagePipeline.cs @@ -55,8 +55,8 @@ public void OnCompleted(Action completed, T state) where T : class /// /// Run the pipeline and process messages. /// - /// - /// + /// The token to monitor for cancellation requests. + /// A task that represents the asynchronous operation. public async Task RunAsync(CancellationToken cancellationToken) { await Task.WhenAll( diff --git a/src/HotChocolate/Caching/src/Caching.Memory/Cache.cs b/src/HotChocolate/Caching/src/Caching.Memory/Cache.cs index 74ab4573b79..76cf309d02a 100644 --- a/src/HotChocolate/Caching/src/Caching.Memory/Cache.cs +++ b/src/HotChocolate/Caching/src/Caching.Memory/Cache.cs @@ -263,7 +263,7 @@ private CacheEntry InsertNew(string key, TValue value) /// /// Returns all keys in the cache. This method is for testing only. /// - /// + /// All keys currently in the cache. internal IEnumerable GetKeys() { foreach (var entry in _ring) diff --git a/src/HotChocolate/Core/src/Abstractions/IExecutable.cs b/src/HotChocolate/Core/src/Abstractions/IExecutable.cs index 1acf03b4159..94752e5daeb 100644 --- a/src/HotChocolate/Core/src/Abstractions/IExecutable.cs +++ b/src/HotChocolate/Core/src/Abstractions/IExecutable.cs @@ -44,8 +44,8 @@ public interface IExecutable /// Returns the only element of a default value if no such element exists. This method /// throws an exception if more than one element satisfies the condition. /// - /// - /// + /// A cancellation token that can be used to cancel the execution. + /// Returns the result, or a default value if no such element exists. ValueTask SingleOrDefaultAsync(CancellationToken cancellationToken = default); /// diff --git a/src/HotChocolate/Core/src/Abstractions/IQueryableExecutable.cs b/src/HotChocolate/Core/src/Abstractions/IQueryableExecutable.cs index 850a06bfb18..9c8ba2136f6 100644 --- a/src/HotChocolate/Core/src/Abstractions/IQueryableExecutable.cs +++ b/src/HotChocolate/Core/src/Abstractions/IQueryableExecutable.cs @@ -3,7 +3,7 @@ namespace HotChocolate; /// /// Represents an executable that has a queryable as its source. /// -/// +/// The element type. public interface IQueryableExecutable : IExecutable { /// diff --git a/src/HotChocolate/Core/src/Abstractions/ModuleAttribute.cs b/src/HotChocolate/Core/src/Abstractions/ModuleAttribute.cs index a9211805210..ae21f281151 100644 --- a/src/HotChocolate/Core/src/Abstractions/ModuleAttribute.cs +++ b/src/HotChocolate/Core/src/Abstractions/ModuleAttribute.cs @@ -25,7 +25,6 @@ public ModuleAttribute(string name, ModuleOptions options = ModuleOptions.Defaul /// /// Gets the module name. /// - /// public string Name { get; } /// diff --git a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/IRequestExecutorManager.cs b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/IRequestExecutorManager.cs index 4fb58074b76..a69fca0b231 100644 --- a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/IRequestExecutorManager.cs +++ b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/IRequestExecutorManager.cs @@ -8,6 +8,6 @@ public interface IRequestExecutorManager : IRequestExecutorProvider /// /// Evict the request executor and schema with the given name. /// - /// + /// The name of the schema whose executor shall be evicted. void EvictExecutor(string? schemaName = null); } diff --git a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationDocumentSourceText.cs b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationDocumentSourceText.cs index ff94f34045b..77b5de97401 100644 --- a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationDocumentSourceText.cs +++ b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationDocumentSourceText.cs @@ -5,7 +5,7 @@ namespace HotChocolate.Execution; /// /// Represents a GraphQL operation document source texts that needs parsing before it can be executed. /// -/// +/// The GraphQL operation document source text. public sealed class OperationDocumentSourceText(string sourceText) : IOperationDocument { /// diff --git a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationRequestBuilder.cs b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationRequestBuilder.cs index 3aa51005e04..e008689045e 100644 --- a/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationRequestBuilder.cs +++ b/src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationRequestBuilder.cs @@ -571,7 +571,9 @@ public IOperationRequest Build() /// /// Creates a new instance of . /// - /// + /// + /// A new . + /// public static OperationRequestBuilder New() => new(); /// @@ -580,7 +582,10 @@ public IOperationRequest Build() /// /// The existing request from which the new builder is created. /// - /// + /// + /// A new initialized from + /// the request. + /// /// /// The request type is not supported. /// diff --git a/src/HotChocolate/Core/src/Execution.Abstractions/IVariableValueCollection.cs b/src/HotChocolate/Core/src/Execution.Abstractions/IVariableValueCollection.cs index 8e86f45b12a..4b1ad9854e1 100644 --- a/src/HotChocolate/Core/src/Execution.Abstractions/IVariableValueCollection.cs +++ b/src/HotChocolate/Core/src/Execution.Abstractions/IVariableValueCollection.cs @@ -17,7 +17,7 @@ public interface IVariableValueCollection : IEnumerable /// Gets a coerced variable value from the collection. /// /// The variable name. - /// + /// The coerced variable value. /// /// A GraphQL execution error is thrown when the /// requested variable cannot be found or cannot diff --git a/src/HotChocolate/Core/src/Features/IFeatureCollection.cs b/src/HotChocolate/Core/src/Features/IFeatureCollection.cs index ee319b7b841..c61d244d525 100644 --- a/src/HotChocolate/Core/src/Features/IFeatureCollection.cs +++ b/src/HotChocolate/Core/src/Features/IFeatureCollection.cs @@ -27,7 +27,7 @@ public interface IFeatureCollection : IEnumerable> /// /// Gets or sets a given feature. Setting a null value removes the feature. /// - /// + /// The type of the feature to get or set. /// The requested feature, or null if it is not present. object? this[Type key] { get; set; } diff --git a/src/HotChocolate/Core/src/Types.Abstractions/Types/ArgumentAssignment.cs b/src/HotChocolate/Core/src/Types.Abstractions/Types/ArgumentAssignment.cs index 2f894fd9703..04a9e2d052c 100644 --- a/src/HotChocolate/Core/src/Types.Abstractions/Types/ArgumentAssignment.cs +++ b/src/HotChocolate/Core/src/Types.Abstractions/Types/ArgumentAssignment.cs @@ -101,7 +101,9 @@ public ArgumentAssignment(string name, IValueNode value) /// /// Returns a string representation of the current argument assignment. /// - /// + /// + /// A string representation of this argument assignment. + /// public override string ToString() => ToSyntaxNode().ToString(indented: true); diff --git a/src/HotChocolate/Core/src/Types.CursorPagination/ConnectionPageInfo.cs b/src/HotChocolate/Core/src/Types.CursorPagination/ConnectionPageInfo.cs index 9a16a87c74a..715cafd2b27 100644 --- a/src/HotChocolate/Core/src/Types.CursorPagination/ConnectionPageInfo.cs +++ b/src/HotChocolate/Core/src/Types.CursorPagination/ConnectionPageInfo.cs @@ -9,10 +9,10 @@ public class ConnectionPageInfo : IPageInfo /// /// Initializes . /// - /// - /// - /// - /// + /// Indicates whether more items exist after the current page. + /// Indicates whether more items exist before the current page. + /// The cursor of the first item in the current page. + /// The cursor of the last item in the current page. public ConnectionPageInfo( bool hasNextPage, bool hasPreviousPage, diff --git a/src/HotChocolate/Core/src/Types.CursorPagination/CursorPaginationAlgorithm.cs b/src/HotChocolate/Core/src/Types.CursorPagination/CursorPaginationAlgorithm.cs index 52fb725494e..15a9c0a6d97 100644 --- a/src/HotChocolate/Core/src/Types.CursorPagination/CursorPaginationAlgorithm.cs +++ b/src/HotChocolate/Core/src/Types.CursorPagination/CursorPaginationAlgorithm.cs @@ -19,7 +19,7 @@ public abstract class CursorPaginationAlgorithm where TQuery : /// /// The query builder. /// The paging arguments. - /// + /// The total number of items in the data set, or null if unknown. /// /// Returns the connection. /// diff --git a/src/HotChocolate/Core/src/Types.CursorPagination/Edge.cs b/src/HotChocolate/Core/src/Types.CursorPagination/Edge.cs index 7287f6ada57..39d7d2de72a 100644 --- a/src/HotChocolate/Core/src/Types.CursorPagination/Edge.cs +++ b/src/HotChocolate/Core/src/Types.CursorPagination/Edge.cs @@ -6,7 +6,7 @@ namespace HotChocolate.Types.Pagination; /// /// Represents an edge in a connection. /// -/// +/// The type of the node. public class Edge : IEdge { private readonly Func, string>? _resolveCursor; diff --git a/src/HotChocolate/Core/src/Types.OffsetPagination/Extensions/OffsetPaginationResolverContextExtensions.cs b/src/HotChocolate/Core/src/Types.OffsetPagination/Extensions/OffsetPaginationResolverContextExtensions.cs index 089dccdd442..d1125d115c4 100644 --- a/src/HotChocolate/Core/src/Types.OffsetPagination/Extensions/OffsetPaginationResolverContextExtensions.cs +++ b/src/HotChocolate/Core/src/Types.OffsetPagination/Extensions/OffsetPaginationResolverContextExtensions.cs @@ -12,8 +12,10 @@ internal static class OffsetPaginationResolverContextExtensions /// /// This method checks if the total count is selected /// - /// - /// + /// The resolver context to inspect. + /// + /// true if the total count field is included in the selection set; otherwise, false. + /// public static bool IsTotalCountSelected(this IResolverContext context) { // TotalCount is one of the heaviest operations. It is only necessary to load totalCount diff --git a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPaginationAlgorithm.cs b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPaginationAlgorithm.cs index 19c9114136f..94999c2ba93 100644 --- a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPaginationAlgorithm.cs +++ b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPaginationAlgorithm.cs @@ -21,7 +21,7 @@ public abstract class OffsetPaginationAlgorithm /// The paging arguments. /// Specifies if the total count is needed. /// The cancellation token. - /// + /// The paginated collection segment. public ValueTask> ApplyPaginationAsync( TQuery query, OffsetPagingArguments arguments, @@ -37,7 +37,7 @@ public ValueTask> ApplyPaginationAsync( /// Specify the total amount of elements. /// Specifies if the total count is needed. /// The cancellation token. - /// + /// The paginated collection segment. public async ValueTask> ApplyPaginationAsync( TQuery query, OffsetPagingArguments arguments, diff --git a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingArguments.cs b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingArguments.cs index c67312fd003..5670f5c2e64 100644 --- a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingArguments.cs +++ b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingArguments.cs @@ -23,12 +23,10 @@ public OffsetPagingArguments(int? skip, int? take) /// /// The items that shall be skipped. /// - /// public int? Skip { get; } /// /// The count of items that shall be included into the page. /// - /// public int? Take { get; } } diff --git a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs index 926a8757035..f82c66220c9 100644 --- a/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs +++ b/src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs @@ -32,7 +32,6 @@ protected OffsetPagingHandler(PagingOptions options) /// /// The maximum allowed page size configured for this handler. /// - /// protected int MaxPageSize { get; } /// diff --git a/src/HotChocolate/Core/src/Types.Validation/SchemaValidator.cs b/src/HotChocolate/Core/src/Types.Validation/SchemaValidator.cs index 78cee9437b0..e9da4f7ac0e 100644 --- a/src/HotChocolate/Core/src/Types.Validation/SchemaValidator.cs +++ b/src/HotChocolate/Core/src/Types.Validation/SchemaValidator.cs @@ -60,7 +60,9 @@ public void AddDefaultRules() /// /// The schema to validate. /// The log to which validation issues will be reported. - /// + /// + /// true if the schema is valid; otherwise, false. + /// public bool Validate(ISchemaDefinition schema, IValidationLog log) { ArgumentNullException.ThrowIfNull(schema); diff --git a/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeCompletionContext.cs b/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeCompletionContext.cs index 27204e37600..95a794b8cec 100644 --- a/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeCompletionContext.cs +++ b/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeCompletionContext.cs @@ -64,7 +64,10 @@ public interface ITypeCompletionContext : ITypeSystemObjectContext /// /// The resolved directive type. /// - /// + /// + /// true if the directive type was found; + /// otherwise, false. + /// bool TryGetDirectiveType( TypeReference directiveRef, [NotNullWhen(true)] out DirectiveType? directiveType); diff --git a/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeSystemObjectContext.cs b/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeSystemObjectContext.cs index 9fb005c9774..8d1d9929aec 100644 --- a/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeSystemObjectContext.cs +++ b/src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeSystemObjectContext.cs @@ -17,7 +17,6 @@ public interface ITypeSystemObjectContext : IHasScope, IFeatureProvider /// /// A type reference that points to . /// - /// TypeReference TypeReference { get; } /// @@ -28,7 +27,6 @@ public interface ITypeSystemObjectContext : IHasScope, IFeatureProvider /// /// Defines if is an introspection type. /// - /// bool IsIntrospectionType { get; } /// @@ -81,7 +79,12 @@ public interface ITypeSystemObjectContext : IHasScope, IFeatureProvider /// /// The type reference. /// - /// - /// + /// + /// The predicted type kind. + /// + /// + /// true if the type kind could be predicted; + /// otherwise, false. + /// bool TryPredictTypeKind(TypeReference typeRef, out TypeKind kind); } diff --git a/src/HotChocolate/Core/src/Types/Configuration/OnCompleteType~1.cs b/src/HotChocolate/Core/src/Types/Configuration/OnCompleteType~1.cs index cb717e0d8ab..d9bcae5b7c3 100644 --- a/src/HotChocolate/Core/src/Types/Configuration/OnCompleteType~1.cs +++ b/src/HotChocolate/Core/src/Types/Configuration/OnCompleteType~1.cs @@ -5,7 +5,9 @@ namespace HotChocolate.Configuration; /// /// Represents a callback that is invoked when a type has been completed. /// -/// +/// +/// The type system configuration type. +/// public delegate void OnCompleteType( ITypeCompletionContext context, T? definition, diff --git a/src/HotChocolate/Core/src/Types/Configuration/OnInitializeType~1.cs b/src/HotChocolate/Core/src/Types/Configuration/OnInitializeType~1.cs index 7bd2885b374..9f95e17ac7b 100644 --- a/src/HotChocolate/Core/src/Types/Configuration/OnInitializeType~1.cs +++ b/src/HotChocolate/Core/src/Types/Configuration/OnInitializeType~1.cs @@ -5,7 +5,9 @@ namespace HotChocolate.Configuration; /// /// Represents a callback that is invoked when a type has been completed. /// -/// +/// +/// The type system configuration type. +/// public delegate void OnInitializeType( ITypeDiscoveryContext context, T? definition, diff --git a/src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs b/src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs index 03705cf9d1a..992dcb26069 100644 --- a/src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs +++ b/src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs @@ -435,7 +435,7 @@ public virtual void OnCreateSchemaError(IDescriptorContext context, Exception er /// The type discovery context. /// /// - /// + /// The type dependencies that define the scope. /// public virtual bool TryCreateScope( ITypeDiscoveryContext context, diff --git a/src/HotChocolate/Core/src/Types/Execution/DependencyInjection/RequestExecutorBuilderExtensions.Services.cs b/src/HotChocolate/Core/src/Types/Execution/DependencyInjection/RequestExecutorBuilderExtensions.Services.cs index 309dd46d478..d6e100e8e0e 100644 --- a/src/HotChocolate/Core/src/Types/Execution/DependencyInjection/RequestExecutorBuilderExtensions.Services.cs +++ b/src/HotChocolate/Core/src/Types/Execution/DependencyInjection/RequestExecutorBuilderExtensions.Services.cs @@ -19,7 +19,9 @@ public static partial class RequestExecutorBuilderExtensions /// /// The type of the service that shall be initialized. /// - /// + /// + /// The for configuration chaining. + /// /// /// The is null. /// diff --git a/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionObjectFieldDescriptorExtensions.cs b/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionObjectFieldDescriptorExtensions.cs index 8e0d3afc737..d9c6b3b339f 100644 --- a/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionObjectFieldDescriptorExtensions.cs +++ b/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionObjectFieldDescriptorExtensions.cs @@ -21,7 +21,9 @@ public static class ExecutionObjectFieldDescriptorExtensions /// /// The selection set optimizer. /// - /// + /// + /// The for configuration chaining. + /// /// public static IObjectFieldDescriptor UseOptimizer( this IObjectFieldDescriptor descriptor, diff --git a/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionResultExtensions.cs b/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionResultExtensions.cs index 5086de1e7d2..240fa338b01 100644 --- a/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionResultExtensions.cs +++ b/src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionResultExtensions.cs @@ -40,7 +40,9 @@ public static void WriteTo( /// /// Defines if the JSON should be formatted with indentations. /// - /// + /// + /// The JSON string representation of the execution result. + /// /// /// is null. /// diff --git a/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Operation.cs b/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Operation.cs index 59fcdf97e96..029d9b17ced 100644 --- a/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Operation.cs +++ b/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Operation.cs @@ -74,7 +74,9 @@ public object? RootValue /// /// The type context. /// - /// + /// + /// The compiled selection set for the given selection and type. + /// public SelectionSet CollectFields(Selection selection, ObjectType typeContext) { AssertInitialized(); diff --git a/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Utilities.cs b/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Utilities.cs index 19e4d85e98b..6a0ad8813c4 100644 --- a/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Utilities.cs +++ b/src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Utilities.cs @@ -33,6 +33,5 @@ public IExecutionDiagnosticEvents DiagnosticEvents /// /// Gets the type converter service. /// - /// public ITypeConverter Converter { get; } } diff --git a/src/HotChocolate/Core/src/Types/Execution/Processing/Tasks/ResolverTask.Pooling.cs b/src/HotChocolate/Core/src/Types/Execution/Processing/Tasks/ResolverTask.Pooling.cs index 9366b429b92..a3bd0dffebd 100644 --- a/src/HotChocolate/Core/src/Types/Execution/Processing/Tasks/ResolverTask.Pooling.cs +++ b/src/HotChocolate/Core/src/Types/Execution/Processing/Tasks/ResolverTask.Pooling.cs @@ -29,7 +29,7 @@ public void Initialize( /// /// Resets the resolver task before returning it to the pool. /// - /// + /// Always true. internal bool Reset() { _completionStatus = ExecutionTaskStatus.Completed; diff --git a/src/HotChocolate/Core/src/Types/InvalidSchemaCoordinateException.cs b/src/HotChocolate/Core/src/Types/InvalidSchemaCoordinateException.cs index 29476b815b1..e8d76fb55b8 100644 --- a/src/HotChocolate/Core/src/Types/InvalidSchemaCoordinateException.cs +++ b/src/HotChocolate/Core/src/Types/InvalidSchemaCoordinateException.cs @@ -21,6 +21,5 @@ public InvalidSchemaCoordinateException(string message, SchemaCoordinate coordin /// /// The invalid schema coordinate. /// - /// public SchemaCoordinate Coordinate { get; } } diff --git a/src/HotChocolate/Core/src/Types/Resolvers/IMiddlewareContext.cs b/src/HotChocolate/Core/src/Types/Resolvers/IMiddlewareContext.cs index 3ad1043b3b4..2f9b31ea250 100644 --- a/src/HotChocolate/Core/src/Types/Resolvers/IMiddlewareContext.cs +++ b/src/HotChocolate/Core/src/Types/Resolvers/IMiddlewareContext.cs @@ -21,7 +21,6 @@ public interface IMiddlewareContext : IResolverContext /// /// Defines if at least one middleware has modified the result. /// - /// bool IsResultModified { get; } /// diff --git a/src/HotChocolate/Core/src/Types/Resolvers/IResolverContext.cs b/src/HotChocolate/Core/src/Types/Resolvers/IResolverContext.cs index 7a055e474f2..838678d732c 100644 --- a/src/HotChocolate/Core/src/Types/Resolvers/IResolverContext.cs +++ b/src/HotChocolate/Core/src/Types/Resolvers/IResolverContext.cs @@ -162,7 +162,6 @@ public interface IResolverContext : IHasContextData, IFeatureProvider /// /// Gets the name that the field will have in the response map. /// - /// string ResponseName { get; } /// diff --git a/src/HotChocolate/Core/src/Types/Schema.cs b/src/HotChocolate/Core/src/Types/Schema.cs index 61e1df3dc01..621750373ca 100644 --- a/src/HotChocolate/Core/src/Types/Schema.cs +++ b/src/HotChocolate/Core/src/Types/Schema.cs @@ -56,7 +56,6 @@ IReadOnlyDirectiveDefinitionCollection ISchemaDefinition.DirectiveDefinitions /// /// Gets the schema directives. /// - /// public DirectiveCollection Directives { get; private set; } = null!; IReadOnlyDirectiveCollection IDirectivesProvider.Directives diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/IConfigurationFactory~1.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/IConfigurationFactory~1.cs index b75928f45f9..aaef95f22b1 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/IConfigurationFactory~1.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/IConfigurationFactory~1.cs @@ -11,6 +11,6 @@ public interface IConfigurationFactory : IConfigurationFactory where T : /// /// Creates a new type system configuration. /// - /// + /// The created type system configuration. new T CreateConfiguration(); } diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ITypeSystemConfigurationTask.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ITypeSystemConfigurationTask.cs index ca9d86b314c..64a9efdb003 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ITypeSystemConfigurationTask.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ITypeSystemConfigurationTask.cs @@ -9,7 +9,6 @@ public interface ITypeSystemConfigurationTask /// /// The definition of the type system member that shall be configured. /// - /// ITypeSystemConfiguration Owner { get; } /// diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ObjectFieldBinding.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ObjectFieldBinding.cs index 754f0f17347..9901d8324e7 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ObjectFieldBinding.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ObjectFieldBinding.cs @@ -42,6 +42,5 @@ public ObjectFieldBinding( /// /// Defines if the bound property shall be replaced. /// - /// public bool Replace { get; } } diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IArgumentDescriptor.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IArgumentDescriptor.cs index e2a7a64a814..40fead4fac8 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IArgumentDescriptor.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IArgumentDescriptor.cs @@ -79,7 +79,7 @@ public interface IArgumentDescriptor /// /// /// - /// + /// The input type. IArgumentDescriptor Type() where TInputType : IInputType; @@ -146,7 +146,9 @@ IArgumentDescriptor Type(TInputType inputType) /// /// /// - /// + /// + /// The GraphQL value literal representing the default value. + /// IArgumentDescriptor DefaultValue(IValueNode? value); /// @@ -163,7 +165,9 @@ IArgumentDescriptor Type(TInputType inputType) /// /// /// - /// + /// + /// The runtime default value. + /// IArgumentDescriptor DefaultValue(object? value); /// diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IInputFieldDescriptor.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IInputFieldDescriptor.cs index e7942158df4..cedb487695d 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IInputFieldDescriptor.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IInputFieldDescriptor.cs @@ -97,7 +97,7 @@ public interface IInputFieldDescriptor /// /// /// - /// + /// The input type. IInputFieldDescriptor Type() where TInputType : IInputType; @@ -115,7 +115,7 @@ IInputFieldDescriptor Type() /// /// /// - /// + /// The input type. IInputFieldDescriptor Type(TInputType inputType) where TInputType : class, IInputType; @@ -171,7 +171,9 @@ IInputFieldDescriptor Type(TInputType inputType) /// /// /// - /// + /// + /// The GraphQL value literal representing the default value. + /// IInputFieldDescriptor DefaultValue(IValueNode value); /// @@ -188,7 +190,9 @@ IInputFieldDescriptor Type(TInputType inputType) /// /// /// - /// + /// + /// The runtime default value. + /// IInputFieldDescriptor DefaultValue(object value); /// diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IObjectFieldDescriptor.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IObjectFieldDescriptor.cs index 301ee20057d..570f7e61c69 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IObjectFieldDescriptor.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IObjectFieldDescriptor.cs @@ -141,7 +141,9 @@ IObjectFieldDescriptor Argument( /// ]]> /// /// - /// + /// + /// The for configuration chaining. + /// IObjectFieldDescriptor Resolve(FieldResolverDelegate fieldResolver); /// @@ -161,7 +163,9 @@ IObjectFieldDescriptor Argument( /// ]]> /// /// - /// + /// + /// The for configuration chaining. + /// IObjectFieldDescriptor Resolve( FieldResolverDelegate fieldResolver, Type? resultType); @@ -195,7 +199,9 @@ IObjectFieldDescriptor Resolve( /// ]]> /// /// - /// + /// + /// The for configuration chaining. + /// IObjectFieldDescriptor ResolveWith( Expression> propertyOrMethod); @@ -228,7 +234,9 @@ IObjectFieldDescriptor ResolveWith( /// ]]> /// /// - /// + /// + /// The for configuration chaining. + /// IObjectFieldDescriptor ResolveWith(MemberInfo propertyOrMethod); /// @@ -266,7 +274,9 @@ IObjectFieldDescriptor ResolveWith( /// Adds a subscription resolver to to the field /// /// The subscription resolver - /// + /// + /// The for configuration chaining. + /// IObjectFieldDescriptor Subscribe(SubscribeResolverDelegate subscribeResolver); /// diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ConventionContext.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ConventionContext.cs index 95aabb11c9d..51326a563cf 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ConventionContext.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ConventionContext.cs @@ -44,7 +44,7 @@ internal sealed class ConventionContext( /// /// The descriptor context. /// - /// + /// A new . public static ConventionContext Create( string? scope, IServiceProvider services, diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ITypeInspector.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ITypeInspector.cs index 2df7b88e23d..a37690f0d12 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ITypeInspector.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ITypeInspector.cs @@ -143,7 +143,7 @@ IExtendedType GetArgumentType( /// /// The type scope. /// - /// + /// The extended type reference. ExtendedTypeReference GetTypeRef( Type type, TypeContext context = TypeContext.None, diff --git a/src/HotChocolate/Core/src/Types/Types/Descriptors/ObjectFieldDescriptor.cs b/src/HotChocolate/Core/src/Types/Types/Descriptors/ObjectFieldDescriptor.cs index e40555dc051..465b1dc46a9 100644 --- a/src/HotChocolate/Core/src/Types/Types/Descriptors/ObjectFieldDescriptor.cs +++ b/src/HotChocolate/Core/src/Types/Types/Descriptors/ObjectFieldDescriptor.cs @@ -639,7 +639,7 @@ public static ObjectFieldDescriptor New( /// The member this field represents /// The type of the member /// The resolved type - /// + /// A new . public static ObjectFieldDescriptor New( IDescriptorContext context, MemberInfo member, @@ -654,7 +654,7 @@ public static ObjectFieldDescriptor New( /// The expression this field is based on /// The type of the member /// The resolved type - /// + /// A new . public static ObjectFieldDescriptor New( IDescriptorContext context, LambdaExpression expression, @@ -667,7 +667,7 @@ public static ObjectFieldDescriptor New( /// /// The descriptor context /// The definition of the field - /// + /// A new . public static ObjectFieldDescriptor From( IDescriptorContext context, ObjectFieldConfiguration definition) diff --git a/src/HotChocolate/Core/src/Types/Types/Directives/DeprecatedDirective.cs b/src/HotChocolate/Core/src/Types/Types/Directives/DeprecatedDirective.cs index c6f4a417725..d1baea2428a 100644 --- a/src/HotChocolate/Core/src/Types/Types/Directives/DeprecatedDirective.cs +++ b/src/HotChocolate/Core/src/Types/Types/Directives/DeprecatedDirective.cs @@ -40,7 +40,7 @@ public DeprecatedDirective(string? reason) /// /// Returns a deprecation directive syntax node representation. /// - /// + /// The directive syntax node representation. public DirectiveNode ToNode() => CreateNode(Reason); /// diff --git a/src/HotChocolate/Core/src/Types/Types/Extensions/ResolveWithObjectFieldDescriptorExtensions.cs b/src/HotChocolate/Core/src/Types/Types/Extensions/ResolveWithObjectFieldDescriptorExtensions.cs index 6c18cd3e6ce..8fffd1184e1 100644 --- a/src/HotChocolate/Core/src/Types/Types/Extensions/ResolveWithObjectFieldDescriptorExtensions.cs +++ b/src/HotChocolate/Core/src/Types/Types/Extensions/ResolveWithObjectFieldDescriptorExtensions.cs @@ -20,7 +20,9 @@ public static class ResolveWithObjectFieldDescriptorExtensions /// /// The result type. /// - /// + /// + /// The for configuration chaining. + /// public static IObjectFieldDescriptor ResolveWith( this IObjectFieldDescriptor descriptor, Expression> propertyOrMethod) @@ -51,7 +53,9 @@ public static IObjectFieldDescriptor ResolveWith( /// /// The result type. /// - /// + /// + /// The for configuration chaining. + /// public static IObjectFieldDescriptor ResolveWith( this IObjectFieldDescriptor descriptor, Expression>> propertyOrMethod) diff --git a/src/HotChocolate/Core/src/Types/Types/NamedTypeBase.cs b/src/HotChocolate/Core/src/Types/Types/NamedTypeBase.cs index 5e33c77bc76..549ba589998 100644 --- a/src/HotChocolate/Core/src/Types/Types/NamedTypeBase.cs +++ b/src/HotChocolate/Core/src/Types/Types/NamedTypeBase.cs @@ -148,7 +148,7 @@ public sealed override string ToString() /// /// Returns a from the named type. /// - /// + /// The type definition syntax node. public ITypeDefinitionNode ToSyntaxNode() => FormatType(); ISyntaxNode ISyntaxNodeProvider.ToSyntaxNode() => FormatType(); diff --git a/src/HotChocolate/Core/src/Types/Types/Relay/NodeResolverInfo.cs b/src/HotChocolate/Core/src/Types/Types/Relay/NodeResolverInfo.cs index ab48df5e4b7..3e8f51b9821 100644 --- a/src/HotChocolate/Core/src/Types/Types/Relay/NodeResolverInfo.cs +++ b/src/HotChocolate/Core/src/Types/Types/Relay/NodeResolverInfo.cs @@ -30,7 +30,6 @@ internal sealed class NodeResolverInfo( /// /// Defines if the node resolver was inferred from a query field. /// - /// [MemberNotNullWhen(true, nameof(QueryField), nameof(Id))] public bool IsQueryFieldResolver { get; } = resolverField is not null; } diff --git a/src/HotChocolate/Core/test/Execution.Tests/Integration/StarWarsCodeFirst/StarWarsCodeFirstTests.cs b/src/HotChocolate/Core/test/Execution.Tests/Integration/StarWarsCodeFirst/StarWarsCodeFirstTests.cs index 07b64a243d6..0bd5f511671 100644 --- a/src/HotChocolate/Core/test/Execution.Tests/Integration/StarWarsCodeFirst/StarWarsCodeFirstTests.cs +++ b/src/HotChocolate/Core/test/Execution.Tests/Integration/StarWarsCodeFirst/StarWarsCodeFirstTests.cs @@ -1011,7 +1011,6 @@ await executor.ExecuteAsync( /// not lead to partial results. /// The result should consist of a single error stating the allowed depth. /// - /// [Fact] public async Task ExecutionDepthShouldNotLeadToEmptyObjects() { diff --git a/src/HotChocolate/Core/test/Types.Tests.Documentation/QueryWithDocumentation.cs b/src/HotChocolate/Core/test/Types.Tests.Documentation/QueryWithDocumentation.cs index 2f0adeb1c29..ef042d9f936 100644 --- a/src/HotChocolate/Core/test/Types.Tests.Documentation/QueryWithDocumentation.cs +++ b/src/HotChocolate/Core/test/Types.Tests.Documentation/QueryWithDocumentation.cs @@ -16,6 +16,7 @@ public class QueryWithDocumentation /// public string? Foo(string? bar) => bar; +#pragma warning disable RCS1228 /// /// This is a /// multiline summary @@ -24,6 +25,7 @@ public class QueryWithDocumentation /// /// Note: The returns is left intentionally empty /// +#pragma warning restore RCS1228 public string? Baz() => string.Empty; /// diff --git a/src/HotChocolate/Core/test/Types.Tests.Documentation/WithDictionaryArgs.cs b/src/HotChocolate/Core/test/Types.Tests.Documentation/WithDictionaryArgs.cs index 31b24e49656..0075bcb3859 100644 --- a/src/HotChocolate/Core/test/Types.Tests.Documentation/WithDictionaryArgs.cs +++ b/src/HotChocolate/Core/test/Types.Tests.Documentation/WithDictionaryArgs.cs @@ -2,10 +2,12 @@ namespace HotChocolate.Types.Descriptors; public class WithDictionaryArgs { +#pragma warning disable RCS1228 /// /// This is a method description /// /// Args description /// +#pragma warning restore RCS1228 public string Method(Dictionary? args = null) => string.Empty; } diff --git a/src/HotChocolate/Data/src/Data/Filters/Expressions/Handlers/List/QueryableListOperationHandlerBase.cs b/src/HotChocolate/Data/src/Data/Filters/Expressions/Handlers/List/QueryableListOperationHandlerBase.cs index 34a2e2976dc..0b043f3a8b8 100644 --- a/src/HotChocolate/Data/src/Data/Filters/Expressions/Handlers/List/QueryableListOperationHandlerBase.cs +++ b/src/HotChocolate/Data/src/Data/Filters/Expressions/Handlers/List/QueryableListOperationHandlerBase.cs @@ -112,7 +112,7 @@ public override bool TryHandleLeave( /// The object field node /// The runtime type of the scope /// The expression of the nested operations - /// + /// The filter expression for the list operation. protected abstract Expression HandleListOperation( QueryableFilterContext context, IFilterField field, diff --git a/src/HotChocolate/Data/src/Data/Filters/Visitor/IFilterProviderDescriptor.cs b/src/HotChocolate/Data/src/Data/Filters/Visitor/IFilterProviderDescriptor.cs index b784d38a09f..f6f913b195c 100644 --- a/src/HotChocolate/Data/src/Data/Filters/Visitor/IFilterProviderDescriptor.cs +++ b/src/HotChocolate/Data/src/Data/Filters/Visitor/IFilterProviderDescriptor.cs @@ -18,7 +18,9 @@ IFilterProviderDescriptor AddFieldHandler( /// Adds an instance of a to the provider /// This instance is directly used by the visitor for executing filters /// - /// + /// + /// The field handler instance. + /// /// The type of the field handler /// The descriptor that this methods was called on IFilterProviderDescriptor AddFieldHandler( diff --git a/src/HotChocolate/Data/src/Data/Projections/Convention/IProjectionProviderDescriptor.cs b/src/HotChocolate/Data/src/Data/Projections/Convention/IProjectionProviderDescriptor.cs index 973ecac6ab0..a0fac1945fb 100644 --- a/src/HotChocolate/Data/src/Data/Projections/Convention/IProjectionProviderDescriptor.cs +++ b/src/HotChocolate/Data/src/Data/Projections/Convention/IProjectionProviderDescriptor.cs @@ -64,9 +64,13 @@ IProjectionProviderDescriptor RegisterOptimizer( /// set. This can also be used to rewrite the resolver pipeline. /// This instance is directly used by the visitor for projection the selection set /// - /// - /// - /// + /// + /// The optimizer instance. + /// + /// + /// The type of the optimizer. + /// + /// The descriptor for configuration chaining. IProjectionProviderDescriptor RegisterOptimizer(THandler handler) where THandler : IProjectionOptimizer; } diff --git a/src/HotChocolate/Data/src/Data/Projections/Expressions/QueryableProjectionScopeExtensions.cs b/src/HotChocolate/Data/src/Data/Projections/Expressions/QueryableProjectionScopeExtensions.cs index 9f71416f121..0acca1b7a79 100644 --- a/src/HotChocolate/Data/src/Data/Projections/Expressions/QueryableProjectionScopeExtensions.cs +++ b/src/HotChocolate/Data/src/Data/Projections/Expressions/QueryableProjectionScopeExtensions.cs @@ -22,7 +22,7 @@ public static Expression> Project(this QueryableProjectionScope sc /// The scope that contains the projection information /// The target type /// The target result type of the expression - /// + /// The projection expression. public static Expression> Project( this QueryableProjectionScope scope) where T : TTarget diff --git a/src/HotChocolate/Data/src/Data/Projections/SelectionVisitor.cs b/src/HotChocolate/Data/src/Data/Projections/SelectionVisitor.cs index 3b8520b7461..e9ad141f48f 100644 --- a/src/HotChocolate/Data/src/Data/Projections/SelectionVisitor.cs +++ b/src/HotChocolate/Data/src/Data/Projections/SelectionVisitor.cs @@ -5,7 +5,6 @@ public abstract class SelectionVisitor /// /// The visitor default action. /// - /// protected ISelectionVisitorAction DefaultAction => Continue; /// diff --git a/src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs b/src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs index 8c6ccfc890b..f069f18c7be 100644 --- a/src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs +++ b/src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs @@ -52,7 +52,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -76,7 +78,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs b/src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs index 8c6ccfc890b..f069f18c7be 100644 --- a/src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs +++ b/src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs @@ -52,7 +52,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -76,7 +78,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs b/src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs index 8c6ccfc890b..f069f18c7be 100644 --- a/src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs +++ b/src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs @@ -52,7 +52,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -76,7 +78,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Data/test/Data.PostgreSQL.Tests/Models/Product.cs b/src/HotChocolate/Data/test/Data.PostgreSQL.Tests/Models/Product.cs index 03039a590c7..6b7eadce729 100644 --- a/src/HotChocolate/Data/test/Data.PostgreSQL.Tests/Models/Product.cs +++ b/src/HotChocolate/Data/test/Data.PostgreSQL.Tests/Models/Product.cs @@ -50,7 +50,9 @@ public sealed class Product /// It is invalid to pass in a negative number. /// /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -74,7 +76,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Data/test/Data.Tests/TestContext1/Product.cs b/src/HotChocolate/Data/test/Data.Tests/TestContext1/Product.cs index a471b0f1297..c3a727c8c1d 100644 --- a/src/HotChocolate/Data/test/Data.Tests/TestContext1/Product.cs +++ b/src/HotChocolate/Data/test/Data.Tests/TestContext1/Product.cs @@ -48,7 +48,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -72,7 +74,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs b/src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs index db0ee0a6d3c..761ac0c2ce5 100644 --- a/src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs +++ b/src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs @@ -52,7 +52,9 @@ public class Product /// In this case, it is the responsibility of the client to determine if the amount that is returned is the same as quantityDesired. /// It is invalid to pass in a negative number. /// - /// + /// + /// The desired number of units to remove from stock. + /// /// int: Returns the number actually removed from stock. /// public int RemoveStock(int quantityDesired) @@ -76,7 +78,9 @@ public int RemoveStock(int quantityDesired) /// /// Increments the quantity of a particular item in inventory. - /// + /// + /// The number of units to add to stock. + /// /// int: Returns the quantity that has been added to stock /// public int AddStock(int quantity) diff --git a/src/HotChocolate/Fusion/src/Fusion.AspNetCore/DependencyInjection/FusionServerAspNetCoreHostingBuilderExtensions.cs b/src/HotChocolate/Fusion/src/Fusion.AspNetCore/DependencyInjection/FusionServerAspNetCoreHostingBuilderExtensions.cs index 1f0270e0611..ded109b5736 100644 --- a/src/HotChocolate/Fusion/src/Fusion.AspNetCore/DependencyInjection/FusionServerAspNetCoreHostingBuilderExtensions.cs +++ b/src/HotChocolate/Fusion/src/Fusion.AspNetCore/DependencyInjection/FusionServerAspNetCoreHostingBuilderExtensions.cs @@ -21,7 +21,9 @@ public static class FusionServerAspNetCoreHostingBuilderExtensions /// /// The max allowed GraphQL request size. /// - /// + /// + /// The for configuration chaining. + /// public static IFusionGatewayBuilder AddGraphQLGateway( this IHostApplicationBuilder builder, string? name = null, diff --git a/src/HotChocolate/Fusion/src/Fusion.Execution/Planning/ISelectionSetIndex.cs b/src/HotChocolate/Fusion/src/Fusion.Execution/Planning/ISelectionSetIndex.cs index c5cd2ba3cc5..2218e1c44c5 100644 --- a/src/HotChocolate/Fusion/src/Fusion.Execution/Planning/ISelectionSetIndex.cs +++ b/src/HotChocolate/Fusion/src/Fusion.Execution/Planning/ISelectionSetIndex.cs @@ -11,8 +11,8 @@ public interface ISelectionSetIndex /// /// Gets the ident /// - /// - /// + /// The selection set node to resolve the identifier for. + /// The unique identifier of the selection set. uint GetId(SelectionSetNode selectionSet); bool TryGetOriginalIdFromCloned(uint clonedId, out uint originalId); diff --git a/src/HotChocolate/Json/src/Json/JsonWriter.WriteValues.String.cs b/src/HotChocolate/Json/src/Json/JsonWriter.WriteValues.String.cs index 10e3b187a62..d75bf0a24e8 100644 --- a/src/HotChocolate/Json/src/Json/JsonWriter.WriteValues.String.cs +++ b/src/HotChocolate/Json/src/Json/JsonWriter.WriteValues.String.cs @@ -393,7 +393,7 @@ private void WriteStringEscapeValue(ReadOnlySpan utf8Value, int firstEscap /// /// Writes a number as a JSON string. The string value is not escaped. /// - /// + /// The UTF-8 encoded number value to write as a string. internal void WriteNumberValueAsStringUnescaped(ReadOnlySpan utf8Value) { FlushDeferredPropertyName(); diff --git a/src/HotChocolate/Language/src/Language.SyntaxTree/ScalarTypeDefinitionNode.cs b/src/HotChocolate/Language/src/Language.SyntaxTree/ScalarTypeDefinitionNode.cs index 1e227364f11..939d885b9ff 100644 --- a/src/HotChocolate/Language/src/Language.SyntaxTree/ScalarTypeDefinitionNode.cs +++ b/src/HotChocolate/Language/src/Language.SyntaxTree/ScalarTypeDefinitionNode.cs @@ -65,7 +65,6 @@ public ScalarTypeDefinitionNode( /// /// Gets the scalar description. /// - /// public StringValueNode? Description { get; } /// diff --git a/src/HotChocolate/Language/src/Language.Visitors/Contracts/ISyntaxNavigator.cs b/src/HotChocolate/Language/src/Language.Visitors/Contracts/ISyntaxNavigator.cs index 76e763201fc..2e85e50470a 100644 --- a/src/HotChocolate/Language/src/Language.Visitors/Contracts/ISyntaxNavigator.cs +++ b/src/HotChocolate/Language/src/Language.Visitors/Contracts/ISyntaxNavigator.cs @@ -86,7 +86,7 @@ IEnumerable GetAncestors() /// /// Creates a Schema Coordinate from the current path. /// - /// + /// The schema coordinate for the current path. /// /// If the path does not allow to create a Schema Coordinate. /// For instance, if traversing an executable document it is not possible to create a diff --git a/src/HotChocolate/Language/src/Language.Visitors/SyntaxVisitor~1.cs b/src/HotChocolate/Language/src/Language.Visitors/SyntaxVisitor~1.cs index a9bb3b4bc2e..e0ec1446eef 100644 --- a/src/HotChocolate/Language/src/Language.Visitors/SyntaxVisitor~1.cs +++ b/src/HotChocolate/Language/src/Language.Visitors/SyntaxVisitor~1.cs @@ -26,7 +26,6 @@ protected SyntaxVisitor( /// /// The visitor default action. /// - /// protected virtual ISyntaxVisitorAction DefaultAction { get; } /// diff --git a/src/HotChocolate/MongoDb/src/Data/Extensions/MongoDbDataRequestBuilderExtensions.cs b/src/HotChocolate/MongoDb/src/Data/Extensions/MongoDbDataRequestBuilderExtensions.cs index 31cd25d87b4..56ce49ee86f 100644 --- a/src/HotChocolate/MongoDb/src/Data/Extensions/MongoDbDataRequestBuilderExtensions.cs +++ b/src/HotChocolate/MongoDb/src/Data/Extensions/MongoDbDataRequestBuilderExtensions.cs @@ -18,7 +18,9 @@ public static class MongoDbDataRequestBuilderExtensions /// /// The . /// - /// + /// + /// The name of the filtering convention. + /// /// Uses the old behavior of naming the filters /// /// Returns the . @@ -35,7 +37,9 @@ public static IRequestExecutorBuilder AddMongoDbFiltering( /// /// The . /// - /// + /// + /// The name of the sorting convention. + /// /// /// Returns the . /// @@ -50,7 +54,9 @@ public static IRequestExecutorBuilder AddMongoDbSorting( /// /// The . /// - /// + /// + /// The name of the projections convention. + /// /// /// Returns the . /// diff --git a/src/HotChocolate/MongoDb/src/Data/Extensions/SchemaBuilderExtensions.cs b/src/HotChocolate/MongoDb/src/Data/Extensions/SchemaBuilderExtensions.cs index 9b00ac6a8f9..2d17c3a8314 100644 --- a/src/HotChocolate/MongoDb/src/Data/Extensions/SchemaBuilderExtensions.cs +++ b/src/HotChocolate/MongoDb/src/Data/Extensions/SchemaBuilderExtensions.cs @@ -13,7 +13,9 @@ public static class MongoDbSchemaBuilderExtensions /// /// The . /// - /// + /// + /// The name of the filtering convention. + /// /// Uses the old behavior of naming the filters /// /// Returns the . @@ -30,7 +32,9 @@ public static ISchemaBuilder AddMongoDbFiltering( /// /// The . /// - /// + /// + /// The name of the sorting convention. + /// /// /// Returns the . /// @@ -45,7 +49,9 @@ public static ISchemaBuilder AddMongoDbSorting( /// /// The . /// - /// + /// + /// The name of the projections convention. + /// /// /// Returns the . /// diff --git a/src/HotChocolate/MongoDb/src/Data/Filters/Handlers/List/MongoDbListOperationHandlerBase.cs b/src/HotChocolate/MongoDb/src/Data/Filters/Handlers/List/MongoDbListOperationHandlerBase.cs index d43cdfeb59f..b91e8d0fa92 100644 --- a/src/HotChocolate/MongoDb/src/Data/Filters/Handlers/List/MongoDbListOperationHandlerBase.cs +++ b/src/HotChocolate/MongoDb/src/Data/Filters/Handlers/List/MongoDbListOperationHandlerBase.cs @@ -98,7 +98,9 @@ public override bool TryHandleLeave( /// The currently visited filter field /// The current scope of the visitor /// The path that leads to this visitor - /// + /// + /// The MongoDB filter definition for the list operation. + /// protected abstract MongoDbFilterDefinition HandleListOperation( MongoDbFilterVisitorContext context, IFilterField field, diff --git a/src/HotChocolate/Mutable/src/Types.Mutable/Contracts/IMutableFieldDefinition.cs b/src/HotChocolate/Mutable/src/Types.Mutable/Contracts/IMutableFieldDefinition.cs index be06cf70dd2..b91180aa63d 100644 --- a/src/HotChocolate/Mutable/src/Types.Mutable/Contracts/IMutableFieldDefinition.cs +++ b/src/HotChocolate/Mutable/src/Types.Mutable/Contracts/IMutableFieldDefinition.cs @@ -24,7 +24,6 @@ public interface IMutableFieldDefinition : IFieldDefinition /// /// Gets or sets the type of the field. /// - /// new IType Type { get; set; } /// diff --git a/src/HotChocolate/Mutable/src/Types.Mutable/MutableInputFieldDefinition.cs b/src/HotChocolate/Mutable/src/Types.Mutable/MutableInputFieldDefinition.cs index 2300b85bbbd..bf145b86b94 100644 --- a/src/HotChocolate/Mutable/src/Types.Mutable/MutableInputFieldDefinition.cs +++ b/src/HotChocolate/Mutable/src/Types.Mutable/MutableInputFieldDefinition.cs @@ -96,7 +96,6 @@ public SchemaCoordinate Coordinate /// /// Gets or sets the default value for this input field. /// - /// public IValueNode? DefaultValue { get; set; } /// diff --git a/src/HotChocolate/Mutable/src/Types.Mutable/MutableSchemaDefinition.cs b/src/HotChocolate/Mutable/src/Types.Mutable/MutableSchemaDefinition.cs index cd7f1b7c0c5..9e7bcc2582d 100644 --- a/src/HotChocolate/Mutable/src/Types.Mutable/MutableSchemaDefinition.cs +++ b/src/HotChocolate/Mutable/src/Types.Mutable/MutableSchemaDefinition.cs @@ -324,7 +324,9 @@ IEnumerable ISchemaDefinition.GetPossibleTypes(ITypeDefin /// /// Gets the type and directive definitions that are defined in this schema in insert order. /// - /// + /// + /// The type and directive definitions in insert order. + /// public IEnumerable GetAllDefinitions() { foreach (var definition in _allDefinitionCoordinates) diff --git a/src/HotChocolate/Spatial/src/Types/Configuration/SpatialConventionDescriptor.cs b/src/HotChocolate/Spatial/src/Types/Configuration/SpatialConventionDescriptor.cs index 73f791db9fd..ea5903e5b7d 100644 --- a/src/HotChocolate/Spatial/src/Types/Configuration/SpatialConventionDescriptor.cs +++ b/src/HotChocolate/Spatial/src/Types/Configuration/SpatialConventionDescriptor.cs @@ -15,7 +15,7 @@ public class SpatialConventionDescriptor : ISpatialConventionDescriptor /// /// Creates the definition of this descriptor /// - /// + /// The spatial convention configuration. public SpatialConventionConfiguration CreateConfiguration() => Configuration; /// diff --git a/src/Mocha/src/Mocha.Abstractions/IFeatureCollection.cs b/src/Mocha/src/Mocha.Abstractions/IFeatureCollection.cs index 698a2862b21..7a168f8ee4c 100644 --- a/src/Mocha/src/Mocha.Abstractions/IFeatureCollection.cs +++ b/src/Mocha/src/Mocha.Abstractions/IFeatureCollection.cs @@ -25,7 +25,7 @@ public interface IFeatureCollection : IEnumerable> /// /// Gets or sets a given feature. Setting a null value removes the feature. /// - /// + /// The type of the feature to get or set. /// The requested feature, or null if it is not present. object? this[Type key] { get; set; } diff --git a/src/Nitro/CommandLine/src/CommandLine.FusionCompatibility/FusionGraphPackage.cs b/src/Nitro/CommandLine/src/CommandLine.FusionCompatibility/FusionGraphPackage.cs index b801c6a442f..fb22285763b 100644 --- a/src/Nitro/CommandLine/src/CommandLine.FusionCompatibility/FusionGraphPackage.cs +++ b/src/Nitro/CommandLine/src/CommandLine.FusionCompatibility/FusionGraphPackage.cs @@ -46,7 +46,7 @@ private FusionGraphPackage(Package package) /// /// The access mode for the Fusion graph package. /// - /// + /// The opened Fusion graph package. /// /// is null. /// @@ -78,7 +78,7 @@ public static FusionGraphPackage Open( /// /// The access mode for the Fusion graph package. /// - /// + /// The opened Fusion graph package. /// /// is null. /// diff --git a/src/StrawberryShake/Client/src/Core/IConnection.cs b/src/StrawberryShake/Client/src/Core/IConnection.cs index 462e088e30b..68ebabe3662 100644 --- a/src/StrawberryShake/Client/src/Core/IConnection.cs +++ b/src/StrawberryShake/Client/src/Core/IConnection.cs @@ -4,7 +4,9 @@ namespace StrawberryShake; /// A connection represents a transport connection to a GraphQL server and allows to execute /// requests against it. /// -/// +/// +/// The type of the response body. +/// public interface IConnection where TResponseBody : class { /// diff --git a/src/StrawberryShake/Client/src/Core/IEntityStoreSnapshot.cs b/src/StrawberryShake/Client/src/Core/IEntityStoreSnapshot.cs index 10c0ad50e4c..1014c0ac0c2 100644 --- a/src/StrawberryShake/Client/src/Core/IEntityStoreSnapshot.cs +++ b/src/StrawberryShake/Client/src/Core/IEntityStoreSnapshot.cs @@ -54,7 +54,9 @@ bool TryGetEntity(EntityId id, [NotNullWhen(true)] out TEntity? entity) /// /// The entity type. /// - /// + /// + /// The list of tracked entities matching the provided IDs. + /// IReadOnlyList GetEntities(IEnumerable ids) where TEntity : class; diff --git a/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs b/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs index 39ba3a84c30..cd6a943019c 100644 --- a/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs +++ b/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs @@ -137,7 +137,9 @@ public Span GetSpan(int sizeHint = 0) /// /// Gets the buffer as an /// - /// + /// + /// The written data as an . + /// public ArraySegment ToArraySegment() => new(_buffer, 0, _start); /// diff --git a/src/StrawberryShake/Client/src/Core/OperationResult.cs b/src/StrawberryShake/Client/src/Core/OperationResult.cs index 06f8f4e1761..ca86ce58dc0 100644 --- a/src/StrawberryShake/Client/src/Core/OperationResult.cs +++ b/src/StrawberryShake/Client/src/Core/OperationResult.cs @@ -78,7 +78,7 @@ public OperationResult( /// /// The data info. /// - /// + /// A new result with the updated data. public IOperationResult WithData(T data, IOperationResultDataInfo dataInfo) => new OperationResult(data, dataInfo, DataFactory, Errors, Extensions, ContextData); } diff --git a/src/StrawberryShake/Client/src/Core/Serialization/UploadSerializer.cs b/src/StrawberryShake/Client/src/Core/Serialization/UploadSerializer.cs index c7569459f96..1d538853fa9 100644 --- a/src/StrawberryShake/Client/src/Core/Serialization/UploadSerializer.cs +++ b/src/StrawberryShake/Client/src/Core/Serialization/UploadSerializer.cs @@ -8,7 +8,7 @@ public class UploadSerializer : ScalarSerializer /// /// Creates a new instance of /// - /// + /// The name of the scalar type. public UploadSerializer(string typeName = BuiltInScalarNames.Upload) : base(typeName) { diff --git a/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketClient.cs b/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketClient.cs index a6ce36177fc..06d92f6a4d0 100644 --- a/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketClient.cs +++ b/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketClient.cs @@ -67,7 +67,7 @@ Task OpenAsync( /// A message why the connection was closes /// The close status on how the socket was closes /// The cancellation token to cancel the operation - /// + /// A task representing the asynchronous close operation. Task CloseAsync( string message, SocketCloseStatus closeStatus, diff --git a/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketProtocol.cs b/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketProtocol.cs index a0df8ec21f1..f4ac2f75089 100644 --- a/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketProtocol.cs +++ b/src/StrawberryShake/Client/src/Transport.WebSockets/ISocketProtocol.cs @@ -83,7 +83,7 @@ Task StopOperationAsync( /// /// Unsubscribes a listener from the protocol.. /// - /// + /// The listener to remove from the protocol. void Unsubscribe(OnReceiveAsync listener); /// diff --git a/src/StrawberryShake/Client/src/Transport.WebSockets/Protocols/GraphQLWebSocket/GraphQLWebSocketMessageParser.cs b/src/StrawberryShake/Client/src/Transport.WebSockets/Protocols/GraphQLWebSocket/GraphQLWebSocketMessageParser.cs index 3729fec52af..69ed5f449e5 100644 --- a/src/StrawberryShake/Client/src/Transport.WebSockets/Protocols/GraphQLWebSocket/GraphQLWebSocketMessageParser.cs +++ b/src/StrawberryShake/Client/src/Transport.WebSockets/Protocols/GraphQLWebSocket/GraphQLWebSocketMessageParser.cs @@ -43,7 +43,7 @@ private GraphQLWebSocketMessageParser(ReadOnlySequence messageData) /// /// Parses the message out of the sequence /// - /// + /// The parsed message. /// /// Thrown when an invalid token, an unknown field or the type is not specified /// diff --git a/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketConnection.cs b/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketConnection.cs index b39782523e9..316fb21ea6b 100644 --- a/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketConnection.cs +++ b/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketConnection.cs @@ -15,7 +15,9 @@ public class WebSocketConnection : IWebSocketConnection /// /// Creates a new instance of a /// - /// + /// + /// A factory delegate that creates a new for the WebSocket connection. + /// public WebSocketConnection(Func> sessionFactory) { _sessionFactory = sessionFactory ?? diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Analyzers/Models/InputFieldModel.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Analyzers/Models/InputFieldModel.cs index f24d7a23efa..d7ab35feaad 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Analyzers/Models/InputFieldModel.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Analyzers/Models/InputFieldModel.cs @@ -13,8 +13,8 @@ public class InputFieldModel : IFieldModel /// /// The property name. /// The property xml documentation summary. - /// - /// + /// The GraphQL input value definition. + /// The GraphQL input type of the field. public InputFieldModel( string name, string? description, diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ClientDescriptor.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ClientDescriptor.cs index 0d985069623..366bee2f991 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ClientDescriptor.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ClientDescriptor.cs @@ -22,7 +22,6 @@ public ClientDescriptor( /// /// Gets the client name /// - /// public string Name => RuntimeType.Name; /// diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/DataTypeDescriptor.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/DataTypeDescriptor.cs index 5ba4651a5b9..2760482cc80 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/DataTypeDescriptor.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/DataTypeDescriptor.cs @@ -8,17 +8,23 @@ public sealed class DataTypeDescriptor : ICodeDescriptor /// Describes the DataType /// /// - /// + /// The name of the data type. /// /// - /// + /// The namespace of the data type. /// /// /// The types that are subsets of the DataType represented by this descriptor. /// - /// - /// - /// + /// + /// The interfaces that the data type implements. + /// + /// + /// The XML documentation of the data type. + /// + /// + /// Indicates whether the data type is an interface. + /// public DataTypeDescriptor( string name, string @namespace, diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityIdDescriptor.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityIdDescriptor.cs index a0d722e37ec..0c9ad991a5f 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityIdDescriptor.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityIdDescriptor.cs @@ -30,7 +30,6 @@ public EntityIdDescriptor( /// /// Gets the name of the field or entity. /// - /// public string Name { get; } /// diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityTypeDescriptor.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityTypeDescriptor.cs index 9323b03ad9d..54e6ad3c0d3 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityTypeDescriptor.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityTypeDescriptor.cs @@ -10,7 +10,7 @@ public sealed class EntityTypeDescriptor : ICodeDescriptor /// /// The name of the GraphQL type /// - /// + /// The runtime type information of the entity. /// /// The properties of this entity. /// diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ScalarEntityIdDescriptor.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ScalarEntityIdDescriptor.cs index e316a781dda..a51728821ac 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ScalarEntityIdDescriptor.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ScalarEntityIdDescriptor.cs @@ -30,7 +30,6 @@ public ScalarEntityIdDescriptor( /// /// Gets the name of the field or entity. /// - /// public string Name { get; } /// diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/ICSharpSyntaxGenerator.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/ICSharpSyntaxGenerator.cs index fb472e18797..340e8c668d5 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/ICSharpSyntaxGenerator.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/ICSharpSyntaxGenerator.cs @@ -13,7 +13,10 @@ public interface ICSharpSyntaxGenerator /// /// Settings for the code generation /// - /// + /// + /// true if this generator can handle the descriptor; + /// otherwise, false. + /// bool CanHandle( ICodeDescriptor descriptor, CSharpSyntaxGeneratorSettings settings); diff --git a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Utilities/OperationDocumentHelper.cs b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Utilities/OperationDocumentHelper.cs index e07d8bd063d..6b61f955392 100644 --- a/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Utilities/OperationDocumentHelper.cs +++ b/src/StrawberryShake/CodeGeneration/src/CodeGeneration/Utilities/OperationDocumentHelper.cs @@ -21,7 +21,7 @@ internal static class OperationDocumentHelper /// /// The schema to validate queries against. /// - /// + /// The merged operation documents. /// public static OperationDocuments CreateOperationDocuments( IEnumerable documents,