diff --git a/src/Components/Analyzers/src/Microsoft.AspNetCore.Components.Analyzers.csproj b/src/Components/Analyzers/src/Microsoft.AspNetCore.Components.Analyzers.csproj index 4030f62767..d779046cab 100644 --- a/src/Components/Analyzers/src/Microsoft.AspNetCore.Components.Analyzers.csproj +++ b/src/Components/Analyzers/src/Microsoft.AspNetCore.Components.Analyzers.csproj @@ -6,6 +6,7 @@ true false Roslyn analyzers for ASP.NET Core Components. + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/Authorization/src/AuthorizeRouteView.cs b/src/Components/Authorization/src/AuthorizeRouteView.cs index b236dfd158..95d80a53b3 100644 --- a/src/Components/Authorization/src/AuthorizeRouteView.cs +++ b/src/Components/Authorization/src/AuthorizeRouteView.cs @@ -30,6 +30,9 @@ namespace Microsoft.AspNetCore.Components.Authorization private readonly RenderFragment _renderNotAuthorizedDelegate; private readonly RenderFragment _renderAuthorizingDelegate; + /// + /// Initialize a new instance of a . + /// public AuthorizeRouteView() { // Cache the rendering delegates so that we only construct new closure instances diff --git a/src/Components/Authorization/src/Microsoft.AspNetCore.Components.Authorization.csproj b/src/Components/Authorization/src/Microsoft.AspNetCore.Components.Authorization.csproj index 9cf597d035..ee8cb562ec 100644 --- a/src/Components/Authorization/src/Microsoft.AspNetCore.Components.Authorization.csproj +++ b/src/Components/Authorization/src/Microsoft.AspNetCore.Components.Authorization.csproj @@ -5,6 +5,7 @@ true Authentication and authorization support for Blazor applications. true + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj b/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj index 110ed5f7ae..23f816726b 100644 --- a/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj +++ b/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj @@ -6,6 +6,7 @@ true true enable + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/Components/src/RouteView.cs b/src/Components/Components/src/RouteView.cs index 4fbf3b9cfd..d94ca10833 100644 --- a/src/Components/Components/src/RouteView.cs +++ b/src/Components/Components/src/RouteView.cs @@ -35,6 +35,9 @@ namespace Microsoft.AspNetCore.Components [Parameter] public Type DefaultLayout { get; set; } + /// + /// Initializes a new instance of . + /// public RouteView() { // Cache the delegate instances diff --git a/src/Components/Components/src/Routing/NavigationContext.cs b/src/Components/Components/src/Routing/NavigationContext.cs index 5416b2b454..b2d0f47031 100644 --- a/src/Components/Components/src/Routing/NavigationContext.cs +++ b/src/Components/Components/src/Routing/NavigationContext.cs @@ -17,8 +17,14 @@ namespace Microsoft.AspNetCore.Components.Routing CancellationToken = cancellationToken; } + /// + /// The target path for the navigation. + /// public string Path { get; } + /// + /// The to use to cancel navigation. + /// public CancellationToken CancellationToken { get; } } } diff --git a/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj b/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj index 05b13e543b..667ee190f1 100644 --- a/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj +++ b/src/Components/Forms/src/Microsoft.AspNetCore.Components.Forms.csproj @@ -6,6 +6,7 @@ Forms and validation support for Blazor applications. true enable + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/Server/src/Microsoft.AspNetCore.Components.Server.csproj b/src/Components/Server/src/Microsoft.AspNetCore.Components.Server.csproj index a2c37793e2..56d4e08d3f 100644 --- a/src/Components/Server/src/Microsoft.AspNetCore.Components.Server.csproj +++ b/src/Components/Server/src/Microsoft.AspNetCore.Components.Server.csproj @@ -6,7 +6,7 @@ true true true - CS0436;$(NoWarn) + CS0436;$(NoWarn.Replace('1591', '')) $(DefineConstants);ENABLE_UNSAFE_MSGPACK;SPAN_BUILTIN;MESSAGEPACK_INTERNAL;COMPONENTS_SERVER false Microsoft.Extensions.FileProviders.Embedded.Manifest.xml diff --git a/src/Components/Web/src/ElementReferenceExtensions.cs b/src/Components/Web/src/ElementReferenceExtensions.cs index 67b4705503..bc1da83cd6 100644 --- a/src/Components/Web/src/ElementReferenceExtensions.cs +++ b/src/Components/Web/src/ElementReferenceExtensions.cs @@ -7,6 +7,9 @@ using Microsoft.JSInterop; namespace Microsoft.AspNetCore.Components { + /// + /// Static class that adds extension methods to . + /// public static class ElementReferenceExtensions { /// diff --git a/src/Components/Web/src/Forms/InputBase.cs b/src/Components/Web/src/Forms/InputBase.cs index d7793583d2..cd0c790457 100644 --- a/src/Components/Web/src/Forms/InputBase.cs +++ b/src/Components/Web/src/Forms/InputBase.cs @@ -287,6 +287,7 @@ namespace Microsoft.AspNetCore.Components.Forms return newDictionaryCreated; } + /// protected virtual void Dispose(bool disposing) { } diff --git a/src/Components/Web/src/Forms/InputFile.cs b/src/Components/Web/src/Forms/InputFile.cs index 7eb6546d4a..c0e3659638 100644 --- a/src/Components/Web/src/Forms/InputFile.cs +++ b/src/Components/Web/src/Forms/InputFile.cs @@ -41,11 +41,13 @@ namespace Microsoft.AspNetCore.Components.Forms [Parameter(CaptureUnmatchedValues = true)] public IDictionary? AdditionalAttributes { get; set; } + /// protected override void OnInitialized() { _jsUnmarshalledRuntime = JSRuntime as IJSUnmarshalledRuntime; } + /// protected override async Task OnAfterRenderAsync(bool firstRender) { if (firstRender) @@ -55,6 +57,7 @@ namespace Microsoft.AspNetCore.Components.Forms } } + /// protected override void BuildRenderTree(RenderTreeBuilder builder) { builder.OpenElement(0, "input"); diff --git a/src/Components/Web/src/Forms/ValidationMessage.cs b/src/Components/Web/src/Forms/ValidationMessage.cs index 6651f5da64..f7131aee09 100644 --- a/src/Components/Web/src/Forms/ValidationMessage.cs +++ b/src/Components/Web/src/Forms/ValidationMessage.cs @@ -80,6 +80,10 @@ namespace Microsoft.AspNetCore.Components.Forms } } + /// + /// Called to dispose this instance. + /// + /// if called within . protected virtual void Dispose(bool disposing) { } diff --git a/src/Components/Web/src/Forms/ValidationSummary.cs b/src/Components/Web/src/Forms/ValidationSummary.cs index c24536f0ad..8c2e2172c2 100644 --- a/src/Components/Web/src/Forms/ValidationSummary.cs +++ b/src/Components/Web/src/Forms/ValidationSummary.cs @@ -92,6 +92,7 @@ namespace Microsoft.AspNetCore.Components.Forms } } + /// protected virtual void Dispose(bool disposing) { } diff --git a/src/Components/Web/src/Microsoft.AspNetCore.Components.Web.csproj b/src/Components/Web/src/Microsoft.AspNetCore.Components.Web.csproj index 6c1eaeb1ff..7a8e4d166d 100644 --- a/src/Components/Web/src/Microsoft.AspNetCore.Components.Web.csproj +++ b/src/Components/Web/src/Microsoft.AspNetCore.Components.Web.csproj @@ -7,6 +7,7 @@ true Microsoft.AspNetCore.Components enable + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/Web/src/Routing/NavLink.cs b/src/Components/Web/src/Routing/NavLink.cs index bfd20b8271..05f831a89b 100644 --- a/src/Components/Web/src/Routing/NavLink.cs +++ b/src/Components/Web/src/Routing/NavLink.cs @@ -157,6 +157,7 @@ namespace Microsoft.AspNetCore.Components.Routing return false; } + /// protected override void BuildRenderTree(RenderTreeBuilder builder) { builder.OpenElement(0, "a"); diff --git a/src/Components/Web/src/WebElementReferenceContext.cs b/src/Components/Web/src/WebElementReferenceContext.cs index ec81d075f8..56afc09059 100644 --- a/src/Components/Web/src/WebElementReferenceContext.cs +++ b/src/Components/Web/src/WebElementReferenceContext.cs @@ -6,10 +6,17 @@ using Microsoft.JSInterop; namespace Microsoft.AspNetCore.Components { + /// + /// A for a web element. + /// public class WebElementReferenceContext : ElementReferenceContext { internal IJSRuntime JSRuntime { get; } + /// + /// Initialize a new instance of . + /// + /// The . public WebElementReferenceContext(IJSRuntime jsRuntime) { JSRuntime = jsRuntime ?? throw new ArgumentNullException(nameof(jsRuntime)); diff --git a/src/Components/WebAssembly/Authentication.Msal/src/Microsoft.Authentication.WebAssembly.Msal.csproj b/src/Components/WebAssembly/Authentication.Msal/src/Microsoft.Authentication.WebAssembly.Msal.csproj index 4b27caa77b..939ba16f88 100644 --- a/src/Components/WebAssembly/Authentication.Msal/src/Microsoft.Authentication.WebAssembly.Msal.csproj +++ b/src/Components/WebAssembly/Authentication.Msal/src/Microsoft.Authentication.WebAssembly.Msal.csproj @@ -6,6 +6,7 @@ $(DefaultNetCoreTargetFramework) Authenticate your Blazor webassembly applications with Azure Active Directory and Azure Active Directory B2C true + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/WebAssembly/DevServer/src/Microsoft.AspNetCore.Components.WebAssembly.DevServer.csproj b/src/Components/WebAssembly/DevServer/src/Microsoft.AspNetCore.Components.WebAssembly.DevServer.csproj index a1a012b76e..2003284646 100644 --- a/src/Components/WebAssembly/DevServer/src/Microsoft.AspNetCore.Components.WebAssembly.DevServer.csproj +++ b/src/Components/WebAssembly/DevServer/src/Microsoft.AspNetCore.Components.WebAssembly.DevServer.csproj @@ -9,6 +9,7 @@ Microsoft.AspNetCore.Components.WebAssembly.DevServer.Program Development server for use when building Blazor applications. true + $(NoWarn.Replace('1591', '')) false diff --git a/src/Components/WebAssembly/JSInterop/src/Microsoft.JSInterop.WebAssembly.csproj b/src/Components/WebAssembly/JSInterop/src/Microsoft.JSInterop.WebAssembly.csproj index 2d7aabeee7..0d9b118282 100644 --- a/src/Components/WebAssembly/JSInterop/src/Microsoft.JSInterop.WebAssembly.csproj +++ b/src/Components/WebAssembly/JSInterop/src/Microsoft.JSInterop.WebAssembly.csproj @@ -6,6 +6,7 @@ wasm;javascript;interop true true + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/WebAssembly/JSInterop/src/WebAssemblyJSRuntime.cs b/src/Components/WebAssembly/JSInterop/src/WebAssemblyJSRuntime.cs index 86ffec0ad5..2966110729 100644 --- a/src/Components/WebAssembly/JSInterop/src/WebAssemblyJSRuntime.cs +++ b/src/Components/WebAssembly/JSInterop/src/WebAssemblyJSRuntime.cs @@ -48,6 +48,7 @@ namespace Microsoft.JSInterop.WebAssembly InternalCalls.InvokeJS(out _, ref callInfo, null, null, null); } + /// protected override void EndInvokeDotNet(DotNetInvocationInfo callInfo, in DotNetInvocationResult dispatchResult) { // For failures, the common case is to call EndInvokeDotNet with the Exception object. diff --git a/src/Components/WebAssembly/Sdk/src/Microsoft.NET.Sdk.BlazorWebAssembly.csproj b/src/Components/WebAssembly/Sdk/src/Microsoft.NET.Sdk.BlazorWebAssembly.csproj index ca1baca263..aefefb1796 100644 --- a/src/Components/WebAssembly/Sdk/src/Microsoft.NET.Sdk.BlazorWebAssembly.csproj +++ b/src/Components/WebAssembly/Sdk/src/Microsoft.NET.Sdk.BlazorWebAssembly.csproj @@ -1,4 +1,4 @@ - + MSBuild support for building Blazor WebAssembly apps. $(DefaultNetCoreTargetFramework);net46 @@ -9,7 +9,7 @@ $(ArtifactsBinDir)Microsoft.NET.Sdk.BlazorWebAssembly\$(Configuration)\sdk-output\ - $(NoWarn);NU5100 + $(NoWarn.Replace('1591', ''));NU5100 false diff --git a/src/Components/WebAssembly/Server/src/Microsoft.AspNetCore.Components.WebAssembly.Server.csproj b/src/Components/WebAssembly/Server/src/Microsoft.AspNetCore.Components.WebAssembly.Server.csproj index f332792a19..c245452370 100644 --- a/src/Components/WebAssembly/Server/src/Microsoft.AspNetCore.Components.WebAssembly.Server.csproj +++ b/src/Components/WebAssembly/Server/src/Microsoft.AspNetCore.Components.WebAssembly.Server.csproj @@ -6,7 +6,7 @@ true - $(NoWarn);NU5100 + $(NoWarn.Replace('1591', ''));NU5100 true diff --git a/src/Components/WebAssembly/Server/src/TargetPickerUi.cs b/src/Components/WebAssembly/Server/src/TargetPickerUi.cs index 538086f29c..fda22452d2 100644 --- a/src/Components/WebAssembly/Server/src/TargetPickerUi.cs +++ b/src/Components/WebAssembly/Server/src/TargetPickerUi.cs @@ -14,6 +14,9 @@ using Microsoft.AspNetCore.Http; namespace Microsoft.AspNetCore.Components.WebAssembly.Server { + /// + /// Class for the target picker ui. + /// public class TargetPickerUi { private static readonly JsonSerializerOptions JsonOptions = new JsonSerializerOptions @@ -26,12 +29,22 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Server private string _browserHost; private string _debugProxyUrl; + /// + /// Initialize a new instance of . + /// + /// The debug proxy url. + /// The dev tools host. public TargetPickerUi(string debugProxyUrl, string devToolsHost) { _debugProxyUrl = debugProxyUrl; _browserHost = devToolsHost; } + /// + /// Display the ui. + /// + /// The . + /// The . public async Task Display(HttpContext context) { context.Response.ContentType = "text/html"; diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/IRemoteAuthenticationBuilder.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/IRemoteAuthenticationBuilder.cs index 56fd2777ee..0006f5e2e9 100644 --- a/src/Components/WebAssembly/WebAssembly.Authentication/src/IRemoteAuthenticationBuilder.cs +++ b/src/Components/WebAssembly/WebAssembly.Authentication/src/IRemoteAuthenticationBuilder.cs @@ -14,6 +14,9 @@ namespace Microsoft.Extensions.DependencyInjection where TRemoteAuthenticationState : RemoteAuthenticationState where TAccount : RemoteUserAccount { + /// + /// The . + /// IServiceCollection Services { get; } } } diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Microsoft.AspNetCore.Components.WebAssembly.Authentication.csproj b/src/Components/WebAssembly/WebAssembly.Authentication/src/Microsoft.AspNetCore.Components.WebAssembly.Authentication.csproj index dbc2d3a1a8..21a2efba4e 100644 --- a/src/Components/WebAssembly/WebAssembly.Authentication/src/Microsoft.AspNetCore.Components.WebAssembly.Authentication.csproj +++ b/src/Components/WebAssembly/WebAssembly.Authentication/src/Microsoft.AspNetCore.Components.WebAssembly.Authentication.csproj @@ -7,6 +7,7 @@ Build client-side authentication for single-page applications (SPAs). true true + $(NoWarn.Replace('1591', '')) diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccountClaimsPrincipalFactory.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccountClaimsPrincipalFactory.cs index d81a802fa0..008834ffa0 100644 --- a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccountClaimsPrincipalFactory.cs +++ b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/AccountClaimsPrincipalFactory.cs @@ -17,6 +17,10 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication private readonly IAccessTokenProviderAccessor _accessor; #pragma warning disable PUB0001 // Pubternal type in public API + /// + /// Initialize a new instance of . + /// + /// public AccountClaimsPrincipalFactory(IAccessTokenProviderAccessor accessor) => _accessor = accessor; /// diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/ExpiredTokenException.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/ExpiredTokenException.cs index 762d4de429..1f619e6ebd 100644 --- a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/ExpiredTokenException.cs +++ b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/ExpiredTokenException.cs @@ -17,6 +17,12 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication private readonly NavigationManager _navigation; private readonly AccessTokenResult _tokenResult; + /// + /// Initialize a new instance of . + /// + /// The . + /// The . + /// The scopes. public AccessTokenNotAvailableException( NavigationManager navigation, AccessTokenResult tokenResult, @@ -28,6 +34,9 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication _navigation = navigation; } + /// + /// Navigates to to allow refreshing the access token. + /// public void Redirect() => _navigation.NavigateTo(_tokenResult.RedirectUrl); } } diff --git a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/SignOutSessionStateManager.cs b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/SignOutSessionStateManager.cs index 2867f2639e..f48ae2c994 100644 --- a/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/SignOutSessionStateManager.cs +++ b/src/Components/WebAssembly/WebAssembly.Authentication/src/Services/SignOutSessionStateManager.cs @@ -19,6 +19,10 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Authentication PropertyNameCaseInsensitive = true, }; + /// + /// Initialize a new instance of . + /// + /// The . public SignOutSessionStateManager(IJSRuntime jsRuntime) => _jsRuntime = jsRuntime; /// diff --git a/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHostEnvironmentExtensions.cs b/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHostEnvironmentExtensions.cs index 2aaeb94a93..dd719245ed 100644 --- a/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHostEnvironmentExtensions.cs +++ b/src/Components/WebAssembly/WebAssembly/src/Hosting/WebAssemblyHostEnvironmentExtensions.cs @@ -4,6 +4,9 @@ using System.Text; namespace Microsoft.AspNetCore.Components.WebAssembly.Hosting { + /// + /// Static class that adds extension methods to . + /// public static class WebAssemblyHostEnvironmentExtensions { /// diff --git a/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj b/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj index cf30c9c9e2..f19c039dd6 100644 --- a/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj +++ b/src/Components/WebAssembly/WebAssembly/src/Microsoft.AspNetCore.Components.WebAssembly.csproj @@ -1,10 +1,10 @@ - + $(DefaultNetCoreTargetFramework) Build client-side single-page applications (SPAs) with Blazor running under WebAssembly. true - $(NoWarn);BL0006 + $(NoWarn.Replace('1591', ''));BL0006 true diff --git a/src/Components/WebAssembly/WebAssembly/src/Services/LazyAssemblyLoader.cs b/src/Components/WebAssembly/WebAssembly/src/Services/LazyAssemblyLoader.cs index 73010104f3..49c94e651a 100644 --- a/src/Components/WebAssembly/WebAssembly/src/Services/LazyAssemblyLoader.cs +++ b/src/Components/WebAssembly/WebAssembly/src/Services/LazyAssemblyLoader.cs @@ -28,6 +28,10 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.Services private readonly IJSRuntime _jsRuntime; private readonly HashSet _loadedAssemblyCache; + /// + /// Initializes a new instance of . + /// + /// The . public LazyAssemblyLoader(IJSRuntime jsRuntime) { _jsRuntime = jsRuntime;