Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix triple slash usage of inheritdoc. #6718

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix triple slash usage of inheritdoc. #6718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public static class ElasticsearchBuilderExtensions
/// Adds an Elasticsearch container resource to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="ElasticsearchContainerImageTags.Tag"/> tag of the <inheritdoc cref="ElasticsearchContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="ElasticsearchContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="ElasticsearchContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public static class GarnetBuilderExtensions
/// Adds a Garnet container to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="GarnetContainerImageTags.Tag"/> tag of the <inheritdoc cref="GarnetContainerImageTags.Registry"/>/<inheritdoc cref="GarnetContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="GarnetContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="GarnetContainerImageTags.Registry" path="/summary"/>/<inheritdoc cref="GarnetContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <example>
/// Use in application host
Expand Down
5 changes: 2 additions & 3 deletions src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public static class KafkaBuilderExtensions
/// Adds a Kafka resource to the application. A container is used for local development.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="KafkaContainerImageTags.Tag"/> tag of the <inheritdoc cref="KafkaContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="KafkaContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="KafkaContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency</param>
Expand Down Expand Up @@ -83,7 +83,7 @@ public static IResourceBuilder<KafkaServerResource> AddKafka(this IDistributedAp
/// Adds a Kafka UI container to the application.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="KafkaContainerImageTags.KafkaUiTag"/> tag of the <inheritdoc cref="KafkaContainerImageTags.KafkaUiImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="KafkaContainerImageTags.KafkaUiTag" path="/summary"/> tag of the <inheritdoc cref="KafkaContainerImageTags.KafkaUiImage" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The Kafka server resource builder.</param>
/// <param name="configureContainer">Configuration callback for KafkaUI container resource.</param>
Expand Down Expand Up @@ -228,7 +228,6 @@ private static void ConfigureKafkaContainer(EnvironmentCallbackContext context,
/// <summary>
/// Only need to call this if we want to persistent kafka data
/// </summary>
/// <param name="context"></param>
private static void ConfigureLogDirs(EnvironmentCallbackContext context)
{
context.EnvironmentVariables["KAFKA_LOG_DIRS"] = Target;
Expand Down
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static class KeycloakResourceBuilderExtensions
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
/// <remarks>
/// The container exposes port 8080 by default.
/// This version of the package defaults to the <inheritdoc cref="KeycloakContainerImageTags.Tag"/> tag of the <inheritdoc cref="KeycloakContainerImageTags.Registry"/>/<inheritdoc cref="KeycloakContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="KeycloakContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="KeycloakContainerImageTags.Registry" path="/summary"/>/<inheritdoc cref="KeycloakContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <example>
/// Use in application host
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public static class MilvusBuilderExtensions
/// <remarks>
/// The .NET client library uses the gRPC port by default to communicate and this resource exposes that endpoint.
/// A web-based administration tool for Milvus can also be added using <see cref="WithAttu"/>.
/// This version of the package defaults to the <inheritdoc cref="MilvusContainerImageTags.Tag"/> tag of the <inheritdoc cref="MilvusContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MilvusContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="MilvusContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency</param>
Expand Down Expand Up @@ -108,7 +108,7 @@ public static IResourceBuilder<MilvusDatabaseResource> AddDatabase(this IResourc
/// Adds an administration and development platform for Milvus to the application model using Attu.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MilvusContainerImageTags.AttuTag"/> tag of the <inheritdoc cref="MilvusContainerImageTags.AttuImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MilvusContainerImageTags.AttuTag" path="/summary"/> tag of the <inheritdoc cref="MilvusContainerImageTags.AttuImage" path="/summary"/> container image.
/// </remarks>
/// <example>
/// Use in application host with a Milvus resource
Expand Down
7 changes: 5 additions & 2 deletions src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public static class MongoDBBuilderExtensions
/// Adds a MongoDB resource to the application model. A container is used for local development.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MongoDBContainerImageTags.Tag"/> tag of the <inheritdoc cref="MongoDBContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MongoDBContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="MongoDBContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand All @@ -39,6 +39,9 @@ public static IResourceBuilder<MongoDBServerResource> AddMongoDB(this IDistribut
/// <summary>
/// <inheritdoc cref="AddMongoDB(IDistributedApplicationBuilder, string, int?)"/>
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MongoDBContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="MongoDBContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
/// <param name="port">The host port for MongoDB.</param>
Expand Down Expand Up @@ -127,7 +130,7 @@ public static IResourceBuilder<MongoDBDatabaseResource> AddDatabase(this IResour
/// Adds a MongoExpress administration and development platform for MongoDB to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MongoDBContainerImageTags.MongoExpressTag"/> tag of the <inheritdoc cref="MongoDBContainerImageTags.MongoExpressImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MongoDBContainerImageTags.MongoExpressTag" path="/summary"/> tag of the <inheritdoc cref="MongoDBContainerImageTags.MongoExpressImage" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The MongoDB server resource builder.</param>
/// <param name="configureContainer">Configuration callback for Mongo Express container resource.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public static class MySqlBuilderExtensions
/// Adds a MySQL server resource to the application model. For local development a container is used.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MySqlContainerImageTags.Tag"/> tag of the <inheritdoc cref="MySqlContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MySqlContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="MySqlContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand Down Expand Up @@ -85,7 +85,7 @@ public static IResourceBuilder<MySqlDatabaseResource> AddDatabase(this IResource
/// Adds a phpMyAdmin administration and development platform for MySql to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="MySqlContainerImageTags.PhpMyAdminTag"/> tag of the <inheritdoc cref="MySqlContainerImageTags.PhpMyAdminImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="MySqlContainerImageTags.PhpMyAdminTag" path="/summary"/> tag of the <inheritdoc cref="MySqlContainerImageTags.PhpMyAdminImage" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The MySql server resource builder.</param>
/// <param name="configureContainer">Callback to configure PhpMyAdmin container resource.</param>
Expand Down
5 changes: 4 additions & 1 deletion src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static class NatsBuilderExtensions
/// This configures a default user name and password for the NATS server.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="NatsContainerImageTags.Tag"/> tag of the <inheritdoc cref="NatsContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="NatsContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="NatsContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand All @@ -36,6 +36,9 @@ public static IResourceBuilder<NatsServerResource> AddNats(this IDistributedAppl
/// <summary>
/// Adds a NATS server resource to the application model. A container is used for local development.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="NatsContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="NatsContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
/// <param name="port">The host port for NATS server.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public static class OracleDatabaseBuilderExtensions
/// Adds a Oracle Server resource to the application model. A container is used for local development.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="OracleContainerImageTags.Tag"/> tag of the <inheritdoc cref="OracleContainerImageTags.Registry"/>/<inheritdoc cref="OracleContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="OracleContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="OracleContainerImageTags.Registry" path="/summary"/>/<inheritdoc cref="OracleContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand Down
8 changes: 4 additions & 4 deletions src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public static class PostgresBuilderExtensions
/// extension method then the dependent resource will wait until the Postgres resource is able to service
/// requests.
/// </para>
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.Tag"/> tag of the <inheritdoc cref="PostgresContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="PostgresContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
public static IResourceBuilder<PostgresServerResource> AddPostgres(this IDistributedApplicationBuilder builder,
[ResourceName] string name,
Expand Down Expand Up @@ -125,7 +125,7 @@ public static IResourceBuilder<PostgresDatabaseResource> AddDatabase(this IResou
/// Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.PgAdminTag"/> tag of the <inheritdoc cref="PostgresContainerImageTags.PgAdminImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.PgAdminTag" path="/summary"/> tag of the <inheritdoc cref="PostgresContainerImageTags.PgAdminImage" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The PostgreSQL server resource builder.</param>
/// <param name="configureContainer">Callback to configure PgAdmin container resource.</param>
Expand Down Expand Up @@ -244,7 +244,7 @@ public static IResourceBuilder<PgWebContainerResource> WithHostPort(this IResour
/// Adds an administration and development platform for PostgreSQL to the application model using pgweb.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.PgWebTag"/> tag of the <inheritdoc cref="PostgresContainerImageTags.PgWebImage"/> container image.
/// This version of the package defaults to the <inheritdoc cref="PostgresContainerImageTags.PgWebTag" path="/summary"/> tag of the <inheritdoc cref="PostgresContainerImageTags.PgWebImage" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The Postgres server resource builder.</param>
/// <param name="configureContainer">Configuration callback for pgweb container resource.</param>
Expand Down Expand Up @@ -336,7 +336,7 @@ private static void SetPgAdminEnvironmentVariables(EnvironmentCallbackContext co
context.EnvironmentVariables.Add("PGADMIN_DEFAULT_PASSWORD", "admin");

// When running in the context of Codespaces we need to set some additional environment
// varialbes so that PGAdmin will trust the forwarded headers that Codespaces port
// variables so that PGAdmin will trust the forwarded headers that Codespaces port
// forwarding will send.
var config = context.ExecutionContext.ServiceProvider.GetRequiredService<IConfiguration>();
if (context.ExecutionContext.IsRunMode && config.GetValue<bool>("CODESPACES", false))
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public static class QdrantBuilderExtensions
/// </summary>
/// <remarks>
/// The .NET client library uses the gRPC port by default to communicate and this resource exposes that endpoint.
/// This version of the package defaults to the <inheritdoc cref="QdrantContainerImageTags.Tag"/> tag of the <inheritdoc cref="QdrantContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="QdrantContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="QdrantContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency</param>
Expand Down Expand Up @@ -125,7 +125,7 @@ public static IResourceBuilder<QdrantServerResource> WithDataBindMount(this IRes
/// </summary>
/// <param name="builder">An <see cref="IResourceBuilder{T}"/> for <see cref="ProjectResource"/></param>
/// <param name="qdrantResource">The Qdrant server resource</param>
/// <returns></returns>
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
public static IResourceBuilder<TDestination> WithReference<TDestination>(this IResourceBuilder<TDestination> builder, IResourceBuilder<QdrantServerResource> qdrantResource)
where TDestination : IResourceWithEnvironment
{
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public static class RabbitMQBuilderExtensions
/// Adds a RabbitMQ container to the application model.
/// </summary>
/// <remarks>
/// This version of the package defaults to the <inheritdoc cref="RabbitMQContainerImageTags.Tag"/> tag of the <inheritdoc cref="RabbitMQContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="RabbitMQContainerImageTags.Tag" path="/summary"/> tag of the <inheritdoc cref="RabbitMQContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
Expand Down Expand Up @@ -111,7 +111,7 @@ public static IResourceBuilder<RabbitMQServerResource> WithDataBindMount(this IR
/// <remarks>
/// This method only supports custom tags matching the default RabbitMQ ones for the corresponding management tag to be inferred automatically, e.g. <c>4</c>, <c>4.0-alpine</c>, <c>4.0.2-management-alpine</c>, etc.<br />
/// Calling this method on a resource configured with an unrecognized image registry, name, or tag will result in a <see cref="DistributedApplicationException"/> being thrown.
/// This version of the package defaults to the <inheritdoc cref="RabbitMQContainerImageTags.ManagementTag"/> tag of the <inheritdoc cref="RabbitMQContainerImageTags.Image"/> container image.
/// This version of the package defaults to the <inheritdoc cref="RabbitMQContainerImageTags.ManagementTag" path="/summary"/> tag of the <inheritdoc cref="RabbitMQContainerImageTags.Image" path="/summary"/> container image.
/// </remarks>
/// <param name="builder">The resource builder.</param>
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
Expand Down
Loading
Loading