Fix cref doc so that using is pulled in even if method is suppressed #50373
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
JoshLove-msft
requested review from
m-nash,
jorgerangel-msft,
live1206,
ArcturusZhang and
jsquire
as code owners
github-actions
bot
added
Client
There was a problem hiding this comment.
Pull Request Overview
This PR ensures that XML documentation references to IAzureClientBuilder are fully qualified so that the appropriate namespace is brought in even when methods are suppressed.
- Updated
<see cref>in test sample files to useglobal::Azure.Core.Extensions.IAzureClientBuilder{TClient, TOptions} - Modified the generator to emit the fully qualified type in
methodDescriptionviaStatic(typeof(IAzureClientBuilder<,>))
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| AddsClientExtensionForOAuth.cs | Changed <see cref> to fully qualified global::Azure.Core.Extensions.IAzureClientBuilder{TClient,TOptions} |
| AddsClientExtensionForEachAuthMethodMultipleClients.cs | Same update for multiple client extension tests |
| AddsClientExtensionForEachAuthMethod.cs | Fully qualified <see cref> in doc comments |
| AddsClientExtensionForApiKeyAuth.cs | Fully qualified <see cref> in doc comments |
| ClientBuilderExtensionsDefinition.cs | Updated generator’s methodDescription to use Static(typeof(IAzureClientBuilder<,>)) |
...erExtensionsDefinitions/TestData/ClientBuilderExtensionsTests/AddsClientExtensionForOAuth.cs
Show resolved
Hide resolved
jorgerangel-msft
approved these changes
Jun 2, 2025
jsquire
approved these changes
Jun 3, 2025
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.