|
| 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 | + |
1 | 4 | using System;
|
2 | 5 | using Microsoft.AspNetCore.Hosting;
|
3 | 6 | using Microsoft.AspNetCore;
|
4 | 7 |
|
5 | 8 | namespace Microsoft.Extensions.Hosting
|
6 | 9 | {
|
7 | 10 | /// <summary>
|
8 |
| - /// Extension methods for configuring the IWebHostBuilder. |
| 11 | + /// Extension methods for configuring the <see cref="IHostBuilder" />. |
9 | 12 | /// </summary>
|
10 | 13 | public static class GenericHostBuilderExtensions
|
11 | 14 | {
|
12 | 15 | /// <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. |
14 | 17 | /// </summary>
|
15 | 18 | /// <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> |
22 | 27 | /// </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> |
24 | 29 | /// <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> |
26 | 31 | public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure)
|
27 | 32 | {
|
28 | 33 | if (configure is null)
|
|
0 commit comments