Fix empty elements in documentation comments#9562
Merged
Conversation
github-actions
bot
added
🌶️ hot chocolate
🌶️ strawberry shake
🌶️ green donut
🌶️ mocha
labels
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up XML documentation comments by removing empty documentation elements (e.g., empty <returns> / <value>) and adding meaningful text where appropriate, and enables the Roslynator rule that reports unused documentation comment elements.
Changes:
- Replaced empty XML doc elements with descriptive
<returns>,<param>, and<typeparam>text across multiple projects. - Removed empty
<value></value>tags on properties where they add no information. - Enabled Roslynator
RCS1228(unused element in documentation comment) and suppressed it in a couple of tests that intentionally keep empty<returns>elements.
Reviewed changes
Copilot reviewed 108 out of 108 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Utilities/OperationDocumentHelper.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/ICSharpSyntaxGenerator.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ScalarEntityIdDescriptor.cs | Remove empty <value> documentation tag. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityTypeDescriptor.cs | Add missing <param> description. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/EntityIdDescriptor.cs | Remove empty <value> documentation tag. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/DataTypeDescriptor.cs | Add missing <param> descriptions. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Descriptors/ClientDescriptor.cs | Remove empty <value> documentation tag. |
| src/StrawberryShake/CodeGeneration/src/CodeGeneration/Analyzers/Models/InputFieldModel.cs | Add missing <param> descriptions. |
| src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketConnection.cs | Add missing <param> description. |
| src/StrawberryShake/Client/src/Transport.WebSockets/Protocols/GraphQLWebSocket/GraphQLWebSocketMessageParser.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/Client/src/Transport.WebSockets/ISocketProtocol.cs | Add missing <param> description. |
| src/StrawberryShake/Client/src/Transport.WebSockets/ISocketClient.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/Client/src/Core/Serialization/UploadSerializer.cs | Add missing <param> description. |
| src/StrawberryShake/Client/src/Core/OperationResult.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/Client/src/Core/IEntityStoreSnapshot.cs | Fill in missing <returns> documentation. |
| src/StrawberryShake/Client/src/Core/IConnection.cs | Add missing <typeparam> description. |
| src/Nitro/CommandLine/src/CommandLine.FusionCompatibility/FusionGraphPackage.cs | Fill in missing <returns> documentation. |
| src/Mocha/src/Mocha.Abstractions/IFeatureCollection.cs | Add missing <param> description. |
| src/HotChocolate/Spatial/src/Types/Configuration/SpatialConventionDescriptor.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Mutable/src/Types.Mutable/MutableSchemaDefinition.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Mutable/src/Types.Mutable/MutableInputFieldDefinition.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Mutable/src/Types.Mutable/Contracts/IMutableFieldDefinition.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/MongoDb/src/Data/Filters/Handlers/List/MongoDbListOperationHandlerBase.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/MongoDb/src/Data/Extensions/SchemaBuilderExtensions.cs | Add missing <param> descriptions. |
| src/HotChocolate/MongoDb/src/Data/Extensions/MongoDbDataRequestBuilderExtensions.cs | Add missing <param> descriptions. |
| src/HotChocolate/Language/src/Language.Visitors/SyntaxVisitor~1.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Language/src/Language.Visitors/Contracts/ISyntaxNavigator.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Language/src/Language.SyntaxTree/ScalarTypeDefinitionNode.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Json/src/Json/JsonWriter.WriteValues.String.cs | Add missing <param> description. |
| src/HotChocolate/Fusion/src/Fusion.Execution/Planning/ISelectionSetIndex.cs | Add missing <param> / <returns> docs. |
| src/HotChocolate/Fusion/src/Fusion.AspNetCore/DependencyInjection/FusionServerAspNetCoreHostingBuilderExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Data/test/Data.Tests/TestContext2/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/test/Data.Tests/TestContext1/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/test/Data.PostgreSQL.Tests/Models/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/test/Data.Filters.SqlServer.Tests/TestContext/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/test/Data.EntityFramework.Tests/TestContext/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/test/Data.EntityFramework.Pagination.Tests/TestContext/Product.cs | Add missing <param> descriptions. |
| src/HotChocolate/Data/src/Data/Projections/SelectionVisitor.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Data/src/Data/Projections/Expressions/QueryableProjectionScopeExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Data/src/Data/Projections/Convention/IProjectionProviderDescriptor.cs | Add missing <param> / <typeparam> / <returns> docs. |
| src/HotChocolate/Data/src/Data/Filters/Visitor/IFilterProviderDescriptor.cs | Add missing <param> description. |
| src/HotChocolate/Data/src/Data/Filters/Expressions/Handlers/List/QueryableListOperationHandlerBase.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/test/Types.Tests.Documentation/WithDictionaryArgs.cs | Suppress doc analyzer for intentional empty <returns> in test. |
| src/HotChocolate/Core/test/Types.Tests.Documentation/QueryWithDocumentation.cs | Suppress doc analyzer for intentional empty <returns> in test. |
| src/HotChocolate/Core/test/Execution.Tests/Integration/StarWarsCodeFirst/StarWarsCodeFirstTests.cs | Remove empty <returns> documentation tag. |
| src/HotChocolate/Core/src/Types/Types/Relay/NodeResolverInfo.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Types/NamedTypeBase.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Extensions/ResolveWithObjectFieldDescriptorExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Directives/DeprecatedDirective.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/ObjectFieldDescriptor.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ITypeInspector.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Conventions/ConventionContext.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IObjectFieldDescriptor.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IInputFieldDescriptor.cs | Add missing <typeparam> / <param> docs. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Contracts/IArgumentDescriptor.cs | Add missing <typeparam> / <param> docs. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ObjectFieldBinding.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/ITypeSystemConfigurationTask.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Types/Descriptors/Configurations/IConfigurationFactory~1.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Schema.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Resolvers/IResolverContext.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Resolvers/IMiddlewareContext.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/InvalidSchemaCoordinateException.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Execution/Processing/Tasks/ResolverTask.Pooling.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Utilities.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types/Execution/Processing/OperationContext.Operation.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionResultExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Execution/Extensions/ExecutionObjectFieldDescriptorExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Execution/DependencyInjection/RequestExecutorBuilderExtensions.Services.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types/Configuration/TypeInterceptor.cs | Add missing <param> description. |
| src/HotChocolate/Core/src/Types/Configuration/OnInitializeType~1.cs | Add missing <typeparam> description. |
| src/HotChocolate/Core/src/Types/Configuration/OnCompleteType~1.cs | Add missing <typeparam> description. |
| src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeSystemObjectContext.cs | Add missing <param> / <returns> docs and remove empty <value> tags. |
| src/HotChocolate/Core/src/Types/Configuration/Contracts/ITypeCompletionContext.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types.Validation/SchemaValidator.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingHandler.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPagingArguments.cs | Remove empty <value> documentation tags. |
| src/HotChocolate/Core/src/Types.OffsetPagination/OffsetPaginationAlgorithm.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Types.OffsetPagination/Extensions/OffsetPaginationResolverContextExtensions.cs | Add missing <param> / <returns> docs. |
| src/HotChocolate/Core/src/Types.CursorPagination/Edge.cs | Add missing <typeparam> description. |
| src/HotChocolate/Core/src/Types.CursorPagination/CursorPaginationAlgorithm.cs | Add missing <param> description. |
| src/HotChocolate/Core/src/Types.CursorPagination/ConnectionPageInfo.cs | Add missing <param> descriptions. |
| src/HotChocolate/Core/src/Types.Abstractions/Types/ArgumentAssignment.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Features/IFeatureCollection.cs | Add missing <param> description. |
| src/HotChocolate/Core/src/Execution.Abstractions/IVariableValueCollection.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationRequestBuilder.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/Core/src/Execution.Abstractions/Execution/OperationDocumentSourceText.cs | Add missing <param> description. |
| src/HotChocolate/Core/src/Execution.Abstractions/Execution/IRequestExecutorManager.cs | Add missing <param> description. |
| src/HotChocolate/Core/src/Abstractions/ModuleAttribute.cs | Remove empty <value> documentation tag. |
| src/HotChocolate/Core/src/Abstractions/IQueryableExecutable.cs | Add missing <typeparam> description. |
| src/HotChocolate/Core/src/Abstractions/IExecutable.cs | Add missing <param> / <returns> docs. |
| src/HotChocolate/Caching/src/Caching.Memory/Cache.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/AspNetCore/src/Transport.Sockets/MessagePipeline.cs | Fill in missing <param> / <returns> docs. |
| src/HotChocolate/AspNetCore/src/Transport.Http/DefaultGraphQLHttpClient.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/AspNetCore/src/Transport.Abstractions/OperationBatchRequest.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Http.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreHostingBuilderExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/AspNetCore/src/AspNetCore.Authorization.Opa/IOpaService.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/ApolloFederation/src/ApolloFederation/Types/Directives/KeyDescriptorExtensions.cs | Fill in missing <returns> documentation. |
| src/HotChocolate/ApolloFederation/src/ApolloFederation/Representation.cs | Remove empty <value> documentation tag. |
| src/GreenDonut/test/GreenDonut.Data.EntityFramework.Tests/TestContext/Product.cs | Add missing <param> descriptions. |
| src/GreenDonut/src/GreenDonut/PromiseCacheObserver.cs | Add missing <param> descriptions. |
| src/GreenDonut/src/GreenDonut.Data/Cursors/CursorKey.cs | Fill in missing <returns> documentation. |
| src/GreenDonut/src/GreenDonut.Data.EntityFramework/Extensions/PagingQueryableExtensions.cs | Fill in missing <returns> documentation. |
| src/GreenDonut/src/GreenDonut.Abstractions/Promise.cs | Add missing <typeparam> description. |
| src/GreenDonut/src/GreenDonut.Abstractions/IPromise.cs | Add missing <param> descriptions. |
| src/GreenDonut/src/GreenDonut.Abstractions/Attributes/DataLoaderModuleAttribute.cs | Remove empty <value> documentation tag. |
| .editorconfig | Enable Roslynator RCS1228 as warning. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of the changes (Less than 80 chars)