Add/improve xml comments for commands and interactions#124
Merged
KubaZ2 merged 11 commits intoJun 8, 2025
Conversation
…on command attributes
|
The documentation preview is available at https://preview.netcord.dev/124. |
…refactor partially
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the XML documentation for commands and interactions and updates attribute usages to improve clarity.
- Updates XML comments for various command attributes in both REST and Service layers.
- Revises attribute constructor patterns (e.g., for SlashCommandChoiceAttribute) to adopt new syntax.
- Improves value handling in EnumTypeReaders for attribute properties.
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Tests/NetCord.Test/ApplicationCommands/Commands.cs | Updated SlashCommandChoice attribute usage to include the Name parameter. |
| NetCord/Rest/UserCommandProperties.cs | Added descriptive XML comments for user command properties. |
| NetCord/Rest/SlashCommandProperties.cs | Improved XML comments and updated parameter documentation. |
| NetCord/Rest/MessageCommandProperties.cs | Enhanced XML summary and parameter documentation. |
| NetCord/Rest/EntryPointCommandProperties.cs | Added XML comments to explain the Entry Point command's usage. |
| NetCord.Services/EnumTypeReaders/SlashCommandEnumTypeReader.cs | Adjusted attribute value handling to safely handle null values. |
| NetCord.Services/ComponentInteractions/*.cs | Added XML documentation for component interaction attributes and parameters. |
| NetCord.Services/Commands/*.cs | Provided XML comments and improved consistency in command attribute classes. |
| NetCord.Services/ApplicationCommands/*.cs | Introduced or enhanced XML documentation and summary tags for application commands. |
| Documentation/guides/* | Updated documentation examples to align with the new attribute syntax. |
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.
No description provided.