diff --git a/src/HealthChecks/Abstractions/src/HealthCheckContext.cs b/src/HealthChecks/Abstractions/src/HealthCheckContext.cs index afb0e282a0..fd5b77e5be 100644 --- a/src/HealthChecks/Abstractions/src/HealthCheckContext.cs +++ b/src/HealthChecks/Abstractions/src/HealthCheckContext.cs @@ -3,6 +3,9 @@ namespace Microsoft.Extensions.Diagnostics.HealthChecks { + /// + /// Health check context. Provides health check registrations to . + /// public sealed class HealthCheckContext { /// diff --git a/src/HealthChecks/Abstractions/src/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj b/src/HealthChecks/Abstractions/src/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj index aa4c8c0098..f3fdc9424c 100644 --- a/src/HealthChecks/Abstractions/src/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj +++ b/src/HealthChecks/Abstractions/src/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj @@ -9,7 +9,7 @@ Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck Microsoft.Extensions.Diagnostics.HealthChecks $(DefaultNetFxTargetFramework);netstandard2.0;$(DefaultNetCoreTargetFramework) $(DefaultNetCoreTargetFramework) - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true diagnostics;healthchecks true diff --git a/src/HealthChecks/HealthChecks/src/HealthCheckPublisherOptions.cs b/src/HealthChecks/HealthChecks/src/HealthCheckPublisherOptions.cs index 312ff14ca9..19021810cc 100644 --- a/src/HealthChecks/HealthChecks/src/HealthCheckPublisherOptions.cs +++ b/src/HealthChecks/HealthChecks/src/HealthCheckPublisherOptions.cs @@ -13,6 +13,9 @@ namespace Microsoft.Extensions.Diagnostics.HealthChecks private TimeSpan _delay; private TimeSpan _period; + /// + /// Creates a new instance of . + /// public HealthCheckPublisherOptions() { _delay = TimeSpan.FromSeconds(5); diff --git a/src/HealthChecks/HealthChecks/src/Microsoft.Extensions.Diagnostics.HealthChecks.csproj b/src/HealthChecks/HealthChecks/src/Microsoft.Extensions.Diagnostics.HealthChecks.csproj index dfcd59db0e..8d8450ddea 100644 --- a/src/HealthChecks/HealthChecks/src/Microsoft.Extensions.Diagnostics.HealthChecks.csproj +++ b/src/HealthChecks/HealthChecks/src/Microsoft.Extensions.Diagnostics.HealthChecks.csproj @@ -8,7 +8,7 @@ Microsoft.Extensions.Diagnostics.HealthChecks.IHealthChecksBuilder $(DefaultNetFxTargetFramework);netstandard2.0;$(DefaultNetCoreTargetFramework) $(DefaultNetCoreTargetFramework) - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true diagnostics;healthchecks true diff --git a/src/Middleware/CORS/src/CorsPolicyMetadata.cs b/src/Middleware/CORS/src/CorsPolicyMetadata.cs index 365ff45dbd..19fa14751c 100644 --- a/src/Middleware/CORS/src/CorsPolicyMetadata.cs +++ b/src/Middleware/CORS/src/CorsPolicyMetadata.cs @@ -10,6 +10,10 @@ namespace Microsoft.AspNetCore.Cors /// public class CorsPolicyMetadata : ICorsPolicyMetadata { + /// + /// Creates a new instance of using the specified policy. + /// + /// The policy which needs to be applied. public CorsPolicyMetadata(CorsPolicy policy) { Policy = policy; diff --git a/src/Middleware/CORS/src/Infrastructure/CorsOptions.cs b/src/Middleware/CORS/src/Infrastructure/CorsOptions.cs index df32568b07..00fc6b5aad 100644 --- a/src/Middleware/CORS/src/Infrastructure/CorsOptions.cs +++ b/src/Middleware/CORS/src/Infrastructure/CorsOptions.cs @@ -19,6 +19,9 @@ namespace Microsoft.AspNetCore.Cors.Infrastructure internal IDictionary policyTask)> PolicyMap { get; } = new Dictionary)>(StringComparer.Ordinal); + /// + /// Gets or sets the default policy name. + /// public string DefaultPolicyName { get => _defaultPolicyName; diff --git a/src/Middleware/CORS/src/Infrastructure/CorsService.cs b/src/Middleware/CORS/src/Infrastructure/CorsService.cs index 8ed5ca318c..6dca477a30 100644 --- a/src/Middleware/CORS/src/Infrastructure/CorsService.cs +++ b/src/Middleware/CORS/src/Infrastructure/CorsService.cs @@ -139,11 +139,23 @@ namespace Microsoft.AspNetCore.Cors.Infrastructure AddHeaderValues(result.AllowedHeaders, allowedHeaders); } + /// + /// Evaluate a request using the specified policy. The result is set on the specified instance. + /// + /// The current HTTP context. + /// The to evaluate. + /// The to set the result on. public virtual void EvaluateRequest(HttpContext context, CorsPolicy policy, CorsResult result) { PopulateResult(context, policy, result); } + /// + /// Evaluate a preflight request using the specified policy. The result is set on the specified instance. + /// + /// The current HTTP context. + /// The to evaluate. + /// The to set the result on. public virtual void EvaluatePreflightRequest(HttpContext context, CorsPolicy policy, CorsResult result) { PopulateResult(context, policy, result); diff --git a/src/Middleware/CORS/src/Microsoft.AspNetCore.Cors.csproj b/src/Middleware/CORS/src/Microsoft.AspNetCore.Cors.csproj index 656043ab16..faf5548ee6 100644 --- a/src/Middleware/CORS/src/Microsoft.AspNetCore.Cors.csproj +++ b/src/Middleware/CORS/src/Microsoft.AspNetCore.Cors.csproj @@ -7,7 +7,7 @@ Microsoft.AspNetCore.Cors.DisableCorsAttribute Microsoft.AspNetCore.Cors.EnableCorsAttribute $(DefaultNetCoreTargetFramework) true - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true aspnetcore;cors false diff --git a/src/Middleware/HealthChecks.EntityFrameworkCore/src/DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.cs b/src/Middleware/HealthChecks.EntityFrameworkCore/src/DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.cs index 007eeaa586..523a9e5aaa 100644 --- a/src/Middleware/HealthChecks.EntityFrameworkCore/src/DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.cs +++ b/src/Middleware/HealthChecks.EntityFrameworkCore/src/DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.cs @@ -1,7 +1,6 @@ -// Copyright (c) .NET Foundation. All rights reserved. +// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. - using System; using System.Collections.Generic; using System.Threading; @@ -13,6 +12,9 @@ using Microsoft.Extensions.Diagnostics.HealthChecks; namespace Microsoft.Extensions.DependencyInjection { + /// + /// extension methods for Entity Framework Core. + /// public static class EntityFrameworkCoreHealthChecksBuilderExtensions { /// diff --git a/src/Middleware/HealthChecks.EntityFrameworkCore/src/Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.csproj b/src/Middleware/HealthChecks.EntityFrameworkCore/src/Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.csproj index 156acda39c..4359108bec 100644 --- a/src/Middleware/HealthChecks.EntityFrameworkCore/src/Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.csproj +++ b/src/Middleware/HealthChecks.EntityFrameworkCore/src/Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore.csproj @@ -5,7 +5,7 @@ Components for performing health checks using EntityFrameworkCore. netstandard2.1 - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true diagnostics;healthchecks;entityframeworkcore Microsoft.Extensions.Diagnostics.HealthChecks diff --git a/src/Middleware/HealthChecks/src/HealthCheckMiddleware.cs b/src/Middleware/HealthChecks/src/HealthCheckMiddleware.cs index 53726257b0..83375433a5 100644 --- a/src/Middleware/HealthChecks/src/HealthCheckMiddleware.cs +++ b/src/Middleware/HealthChecks/src/HealthCheckMiddleware.cs @@ -12,12 +12,18 @@ using Microsoft.Net.Http.Headers; namespace Microsoft.AspNetCore.Diagnostics.HealthChecks { + /// + /// Middleware that exposes a health checks response with a URL endpoint. + /// public class HealthCheckMiddleware { private readonly RequestDelegate _next; private readonly HealthCheckOptions _healthCheckOptions; private readonly HealthCheckService _healthCheckService; + /// + /// Creates a new instance of . + /// public HealthCheckMiddleware( RequestDelegate next, IOptions healthCheckOptions, diff --git a/src/Middleware/HealthChecks/src/Microsoft.AspNetCore.Diagnostics.HealthChecks.csproj b/src/Middleware/HealthChecks/src/Microsoft.AspNetCore.Diagnostics.HealthChecks.csproj index 99c01627f6..3fa81c56ae 100644 --- a/src/Middleware/HealthChecks/src/Microsoft.AspNetCore.Diagnostics.HealthChecks.csproj +++ b/src/Middleware/HealthChecks/src/Microsoft.AspNetCore.Diagnostics.HealthChecks.csproj @@ -1,10 +1,10 @@ - + ASP.NET Core middleware for returning the results of Health Checks in the application $(DefaultNetCoreTargetFramework) true - $(NoWarn);CS1591 + $(NoWarn.Replace('1591', '')) true diagnostics;healthchecks false