Skip to content

Commit de59a61

Browse files
authored
Update GenericHostBuilderExtensions.cs (#26386)
1 parent 9df997c commit de59a61

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

src/DefaultBuilder/src/GenericHostBuilderExtensions.cs

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
1+
// Copyright (c) .NET Foundation. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
14
using System;
25
using Microsoft.AspNetCore.Hosting;
36
using Microsoft.AspNetCore;
47

58
namespace Microsoft.Extensions.Hosting
69
{
710
/// <summary>
8-
/// Extension methods for configuring the IWebHostBuilder.
11+
/// Extension methods for configuring the <see cref="IHostBuilder" />.
912
/// </summary>
1013
public static class GenericHostBuilderExtensions
1114
{
1215
/// <summary>
13-
/// Initializes a new instance of the <see cref="IWebHostBuilder"/> class with pre-configured defaults.
16+
/// Configures a <see cref="IHostBuilder" /> with defaults for hosting a web app.
1417
/// </summary>
1518
/// <remarks>
16-
/// The following defaults are applied to the <see cref="IWebHostBuilder"/>:
17-
/// use Kestrel as the web server and configure it using the application's configuration providers,
18-
/// configure the <see cref="IWebHostEnvironment.WebRootFileProvider"/> to map static web assets when <see cref="IHostEnvironment.EnvironmentName"/> is 'Development' using the entry assembly,
19-
/// adds the HostFiltering middleware,
20-
/// adds the ForwardedHeaders middleware if ASPNETCORE_FORWARDEDHEADERS_ENABLED=true,
21-
/// and enable IIS integration.
19+
/// The following defaults are applied to the <see cref="IHostBuilder"/>:
20+
/// <list type="bullet">
21+
/// <item><description>use Kestrel as the web server and configure it using the application's configuration providers</description></item>
22+
/// <item><description>configure <see cref="IWebHostEnvironment.WebRootFileProvider"/> to include static web assets from projects referenced by the entry assembly during development</description></item>
23+
/// <item><description>adds the HostFiltering middleware</description></item>
24+
/// <item><description>adds the ForwardedHeaders middleware if ASPNETCORE_FORWARDEDHEADERS_ENABLED=true,</description></item>
25+
/// <item><description>enable IIS integration</description></item>
26+
/// </list>
2227
/// </remarks>
23-
/// <param name="builder">The <see cref="IHostBuilder" /> instance to configure</param>
28+
/// <param name="builder">The <see cref="IHostBuilder" /> instance to configure.</param>
2429
/// <param name="configure">The configure callback</param>
25-
/// <returns>The <see cref="IHostBuilder"/> for chaining.</returns>
30+
/// <returns>A reference to the <paramref name="builder"/> after the operation has completed.</returns>
2631
public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure)
2732
{
2833
if (configure is null)

0 commit comments

Comments
 (0)