Add API descriptions #301
Closed
Add API descriptions #301
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
github-actions
bot
added
ML: Samples
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes XML documentation by fully qualifying exception types in <exception> tags across various libraries.
- Prefixes exception cref attributes with
System.to avoid ambiguity. - Aligns exception documentation formatting consistently.
- Applies changes in REST clients, state management, adapters, and builder components.
Reviewed Changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/libraries/Client/Microsoft.Agents.Connector/RestClients/AttachmentsRestClient.cs | Qualified exception types in doc comments |
| src/libraries/Client/Microsoft.Agents.Client/IAgentHost.cs | Qualified ArgumentException in interface docs |
| src/libraries/Builder/Microsoft.Agents.Builder/UserAuth/TokenService/OAuthFlow.cs | Qualified TimeoutException in method docs |
| src/libraries/Builder/Microsoft.Agents.Builder/RestChannelServiceClientFactory.cs | Qualified multiple exceptions in factory docs |
| src/libraries/Builder/Microsoft.Agents.Builder/LocalArrayBufferWritter.cs | Qualified ArgumentException and InvalidOperationException in class docs |
| @@ -76,7 +76,7 @@ await SendOAuthCardAsync( | |||
| /// active after the turn has been processed. | |||
| /// <para>The prompt generally continues to receive the user's replies until it accepts the | |||
| /// user's reply as valid input for the prompt.</para></remarks> | |||
| /// <exception cref="TimeoutException"/> | |||
| /// <exception cref="System.TimeoutException"/> | |||
There was a problem hiding this comment.
Provide a description for this exception, for example: 'Thrown when the OAuth flow does not complete before the expiration time.'
Suggested change
| /// <exception cref="System.TimeoutException"/> | |
| /// <exception cref="System.TimeoutException">Thrown when the OAuth flow does not complete before the expiration time.</exception> |
Copilot uses AI. Check for mistakes.
Comment on lines
+26
to
+27
| /// <exception cref="System.ArgumentNullException"></exception> | ||
| /// <exception cref="System.ArgumentException"></exception> |
There was a problem hiding this comment.
Add context to this exception tag, e.g., 'Thrown when a required parameter is null.'
Suggested change
| /// <exception cref="System.ArgumentNullException"></exception> | |
| /// <exception cref="System.ArgumentException"></exception> | |
| /// <exception cref="System.ArgumentNullException">Thrown when a required parameter, such as <paramref name="connections"/> or <paramref name="httpClientFactory"/>, is null.</exception> | |
| /// <exception cref="System.ArgumentException">Thrown when an argument provided to the constructor is invalid.</exception> |
Copilot uses AI. Check for mistakes.
| @@ -37,7 +37,7 @@ public LocalArrayBufferWriter() | |||
| /// with an initial capacity specified. | |||
| /// </summary> | |||
| /// <param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param> | |||
| /// <exception cref="ArgumentException"> | |||
| /// <exception cref="System.ArgumentException"> | |||
| /// Thrown when <paramref name="initialCapacity"/> is not positive (i.e. less than or equal to 0). | |||
There was a problem hiding this comment.
Include a description of the invalid condition, e.g., 'Thrown when initialCapacity is less than or equal to zero.'
Suggested change
| /// Thrown when <paramref name="initialCapacity"/> is not positive (i.e. less than or equal to 0). | |
| /// Thrown when <paramref name="initialCapacity"/> is less than or equal to zero. |
Copilot uses AI. Check for mistakes.
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.
For types and members that are missing summary code comment descriptions.