Add xml docs for NetCord.Services #164
Merged
Conversation
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
|
The documentation preview is available at https://preview.netcord.dev/164. |
Updated the XML documentation for the `AddModules` method in the `IService` interface to specify that it scans for **public modules** in the provided assembly. This change improves clarity for developers without altering the method's functionality or behavior.
Added a summary comment to the `IApplicationCommandService` interface, describing it as the base interface for `ApplicationCommandService<TContext>`. This improves code readability and provides better context for developers using documentation tools like IntelliSense.
Updated XML documentation across `ApplicationCommandService.cs`, `ComponentInteractionService.cs`, and `IComponentInteractionService.cs` to improve clarity and maintainability. - Used `<inheritdoc>` for parameter documentation in `ApplicationCommandService`. - Added `<summary>`, `<typeparam>`, `<param>`, and `<returns>` tags to describe class purposes, methods, and properties in `ComponentInteractionService` and `IComponentInteractionService`. - Enhanced developer experience with detailed descriptions of functionality and parameters.
KubaZ2
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive XML documentation comments to the NetCord.Services library, improving API discoverability and IntelliSense support. The changes include documentation for service interfaces, context classes, module base classes, and various command/interaction types.
Key changes:
- Added XML documentation to all public interfaces and classes in the Services namespace
- Changed several base module classes from
publictopublic abstractto better reflect their intended usage - Reorganized property declarations in application command info classes to place
Typeproperty first - Added missing
usingdirectives for referenced types in documentation
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| UserId.cs | Added documentation for user ID class and its properties |
| IService.cs | Added documentation for base service interface and assembly scanning method |
| IBaseModule.cs | Added documentation for Context property in internal module interface |
| Context interfaces | Added documentation for all context interfaces (IContext, IUserContext, IGuildContext, etc.) |
| ComponentInteractions/* | Added documentation for component interaction services, modules, and contexts |
| Commands/* | Added documentation for command services, modules, and contexts |
| ApplicationCommands/* | Added documentation for application command services, modules, contexts, and builders |
| ApplicationCommandInfo.cs | Moved Type property declaration before other properties |
| *CommandInfo.cs | Moved Type property to appear before other properties for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
NetCord.Services/ApplicationCommands/ApplicationCommandBuilder.cs
Outdated
Show resolved
Hide resolved
NetCord.Services/ApplicationCommands/ApplicationCommandBuilder.cs
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 43 out of 43 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
NetCord.Services/ApplicationCommands/IApplicationCommandInfo.cs
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 44 out of 44 changed files in this pull request and generated 9 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated XML documentation in `CommandBuilder.cs` and `ComponentInteractionBuilder.cs` to simplify `<inheritdoc>` tags for parameters. Replaced or adjusted references to summary paths for `aliases` and `customId` parameters to improve clarity and maintain consistency.
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.
No description provided.