Put examples docs in remark to be visible in Visual Studio #6378
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.
Description
This pull request involves adding
<remarks>
tags to the XML documentation comments in multiple builder extension classes to improve clarity and consistency. The most important changes include updates to theElasticsearchBuilderExtensions
,GarnetBuilderExtensions
,KeycloakResourceBuilderExtensions
,MilvusBuilderExtensions
, andPostgresBuilderExtensions
classes.Updates to XML Documentation Comments:
src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs
:<remarks>
tags to provide additional context and examples for methods in theElasticsearchBuilderExtensions
class. [1] [2] [3] [4] [5] [6]src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs
:<remarks>
tags to provide additional context and examples for methods in theGarnetBuilderExtensions
class. [1] [2] [3] [4] [5] [6] [7] [8]src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs
:<remarks>
tags to provide additional context and examples for methods in theKeycloakResourceBuilderExtensions
class. [1] [2] [3] [4] [5]src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs
:<remarks>
tags to provide additional context and examples for methods in theMilvusBuilderExtensions
class. [1] [2] [3] [4] [5] [6]src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs
:<remarks>
tags to provide additional context and examples for methods in thePostgresBuilderExtensions
class. [1] [2]Before change:
after change:
Fixes # (issue)
Checklist
<remarks />
and<code />
elements on your triple slash comments?Microsoft Reviewers: Open in CodeFlow