From 761eec97e6c8a7c9e4f5f84d80d39f480dfb6cef Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 3 Nov 2022 20:10:18 -0700
Subject: [PATCH] [release/7.0] Fixing XML documentation (#44523)
* Update IHttpRequestFeature.cs
* Update ApiParameterDescription.cs
* Update IProblemDetailsService.cs
* Update ApiConventionApplicationModelConvention.cs
* Update CircuitHandler.cs
* Update CorsPolicyBuilder.cs
* Update TypedResults.cs
Co-authored-by: Bruno Oliveira <brunolins16@users.noreply.github.com>
---
.../Server/src/Circuits/CircuitHandler.cs | 12 +++++------
.../ProblemDetails/IProblemDetailsService.cs | 6 ++++--
.../Http.Features/src/IHttpRequestFeature.cs | 4 ++--
src/Http/Http.Results/src/TypedResults.cs | 20 +++++++++----------
.../src/Infrastructure/CorsPolicyBuilder.cs | 6 +++---
.../ApiExplorer/ApiParameterDescription.cs | 6 +++---
...ApiConventionApplicationModelConvention.cs | 4 ++--
7 files changed, 30 insertions(+), 28 deletions(-)
diff --git a/src/Components/Server/src/Circuits/CircuitHandler.cs b/src/Components/Server/src/Circuits/CircuitHandler.cs
index 5dfcd4860b6..61045dbf587 100644
--- a/src/Components/Server/src/Circuits/CircuitHandler.cs
+++ b/src/Components/Server/src/Circuits/CircuitHandler.cs
@@ -6,20 +6,20 @@ namespace Microsoft.AspNetCore.Components.Server.Circuits;
/// <summary>
/// A <see cref="CircuitHandler"/> allows running code during specific lifetime events of a <see cref="Circuit"/>.
/// <list type="bullet">
-/// <item>
+/// <item><description>
/// <see cref="OnCircuitOpenedAsync(Circuit, CancellationToken)"/> is invoked after an initial circuit to the client
/// has been established.
-/// </item>
-/// <item>
+/// </description></item>
+/// <item><description>
/// <see cref="OnConnectionUpAsync(Circuit, CancellationToken)"/> is invoked immediately after the completion of
/// <see cref="OnCircuitOpenedAsync(Circuit, CancellationToken)"/>. In addition, the method is invoked each time a connection is re-established
/// with a client after it's been dropped. <see cref="OnConnectionDownAsync(Circuit, CancellationToken)"/> is invoked each time a connection
/// is dropped.
-/// </item>
-/// <item>
+/// </description></item>
+/// <item><description>
/// <see cref="OnCircuitClosedAsync(Circuit, CancellationToken)"/> is invoked prior to the server evicting the circuit to the client.
/// Application users may use this event to save state for a client that can be later rehydrated.
-/// </item>
+/// </description></item>
/// </list>
/// </summary>
public abstract class CircuitHandler
diff --git a/src/Http/Http.Abstractions/src/ProblemDetails/IProblemDetailsService.cs b/src/Http/Http.Abstractions/src/ProblemDetails/IProblemDetailsService.cs
index 564ee29403a..038049680bd 100644
--- a/src/Http/Http.Abstractions/src/ProblemDetails/IProblemDetailsService.cs
+++ b/src/Http/Http.Abstractions/src/ProblemDetails/IProblemDetailsService.cs
@@ -16,8 +16,10 @@ public interface IProblemDetailsService
/// <param name="context">The <see cref="ProblemDetailsContext"/> associated with the current request/response.</param>
/// <remarks>The <see cref="IProblemDetailsWriter"/> registered services
/// are processed in sequence and the processing is completed when:
- /// <list type="bullet">One of them reports that the response was written successfully, or.</list>
- /// <list type="bullet">All <see cref="IProblemDetailsWriter"/> were executed and none of them was able to write the response successfully.</list>
+ /// <list type="bullet">
+ /// <item><description>One of them reports that the response was written successfully, or.</description></item>
+ /// <item><description>All <see cref="IProblemDetailsWriter"/> were executed and none of them was able to write the response successfully.</description></item>
+ /// </list>
/// </remarks>
ValueTask WriteAsync(ProblemDetailsContext context);
}
diff --git a/src/Http/Http.Features/src/IHttpRequestFeature.cs b/src/Http/Http.Features/src/IHttpRequestFeature.cs
index 3f8f23a9848..d5cdfef4b2e 100644
--- a/src/Http/Http.Features/src/IHttpRequestFeature.cs
+++ b/src/Http/Http.Features/src/IHttpRequestFeature.cs
@@ -71,8 +71,8 @@ public interface IHttpRequestFeature
/// <para>
/// The values are not split or merged across header lines. E.g. The following headers:
/// <list type="bullet">
- /// <item>HeaderA: value1, value2</item>
- /// <item>HeaderA: value3</item>
+ /// <item><description>HeaderA: value1, value2</description></item>
+ /// <item><description>HeaderA: value3</description></item>
/// </list>
/// Result in Headers["HeaderA"] = { "value1, value2", "value3" }
/// </para>
diff --git a/src/Http/Http.Results/src/TypedResults.cs b/src/Http/Http.Results/src/TypedResults.cs
index 31821d062a7..592973f3218 100644
--- a/src/Http/Http.Results/src/TypedResults.cs
+++ b/src/Http/Http.Results/src/TypedResults.cs
@@ -543,9 +543,9 @@ public static class TypedResults
/// <summary>
/// Redirects to the specified <paramref name="url"/>.
/// <list type="bullet">
- /// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</item>
- /// <item>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item>
- /// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</item>
+ /// <item><description>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</description></item>
/// <item>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</item>
/// </list>
/// </summary>
@@ -566,9 +566,9 @@ public static class TypedResults
/// <summary>
/// Redirects to the specified <paramref name="localUrl"/>.
/// <list type="bullet">
- /// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</item>
- /// <item>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item>
- /// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</item>
+ /// <item><description>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</description></item>
/// <item>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</item>
/// </list>
/// </summary>
@@ -589,10 +589,10 @@ public static class TypedResults
/// <summary>
/// Redirects to the specified route.
/// <list type="bullet">
- /// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</item>
- /// <item>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item>
- /// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</item>
- /// <item>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</item>
+ /// <item><description>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
+ /// <item><description>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</description></item>
+ /// <item><description>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</description></item>
/// </list>
/// </summary>
/// <param name="routeName">The name of the route.</param>
diff --git a/src/Middleware/CORS/src/Infrastructure/CorsPolicyBuilder.cs b/src/Middleware/CORS/src/Infrastructure/CorsPolicyBuilder.cs
index efd777ae763..68291bbfe11 100644
--- a/src/Middleware/CORS/src/Infrastructure/CorsPolicyBuilder.cs
+++ b/src/Middleware/CORS/src/Infrastructure/CorsPolicyBuilder.cs
@@ -41,13 +41,13 @@ public class CorsPolicyBuilder
/// the normalization performed by the browser on the value sent in the <c>ORIGIN</c> header.
/// <list type="bullet">
/// <item>
- /// If the specified origin has an internationalized domain name (IDN), the punycoded value is used. If the origin
+ /// <description>If the specified origin has an internationalized domain name (IDN), the punycoded value is used. If the origin
/// specifies a default port (e.g. 443 for HTTPS or 80 for HTTP), this will be dropped as part of normalization.
/// Finally, the scheme and punycoded host name are culture invariant lower cased before being added to the <see cref="CorsPolicy.Origins"/>
- /// collection.
+ /// collection.</description>
/// </item>
/// <item>
- /// For all other origins, normalization involves performing a culture invariant lower casing of the host name.
+ /// <description>For all other origins, normalization involves performing a culture invariant lower casing of the host name.</description>
/// </item>
/// </list>
/// </remarks>
diff --git a/src/Mvc/Mvc.Abstractions/src/ApiExplorer/ApiParameterDescription.cs b/src/Mvc/Mvc.Abstractions/src/ApiExplorer/ApiParameterDescription.cs
index a06e7e5f18c..449a5636ee6 100644
--- a/src/Mvc/Mvc.Abstractions/src/ApiExplorer/ApiParameterDescription.cs
+++ b/src/Mvc/Mvc.Abstractions/src/ApiExplorer/ApiParameterDescription.cs
@@ -52,9 +52,9 @@ public class ApiParameterDescription
/// <remarks>
/// A parameter is considered required if
/// <list type="bullet">
- /// <item>it's bound from the request body (<see cref="BindingSource.Body"/>).</item>
- /// <item>it's a required route value.</item>
- /// <item>it has annotations (e.g. BindRequiredAttribute) that indicate it's required.</item>
+ /// <item><description>it's bound from the request body (<see cref="BindingSource.Body"/>).</description></item>
+ /// <item><description>it's a required route value.</description></item>
+ /// <item><description>it has annotations (e.g. BindRequiredAttribute) that indicate it's required.</description></item>
/// </list>
/// </remarks>
public bool IsRequired { get; set; }
diff --git a/src/Mvc/Mvc.Core/src/ApplicationModels/ApiConventionApplicationModelConvention.cs b/src/Mvc/Mvc.Core/src/ApplicationModels/ApiConventionApplicationModelConvention.cs
index cba692149f2..164683ebd34 100644
--- a/src/Mvc/Mvc.Core/src/ApplicationModels/ApiConventionApplicationModelConvention.cs
+++ b/src/Mvc/Mvc.Core/src/ApplicationModels/ApiConventionApplicationModelConvention.cs
@@ -10,8 +10,8 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels;
/// <summary>
/// An <see cref="IActionModelConvention"/> that discovers
/// <list type="bullet">
-/// <item><see cref="ApiConventionResult"/> from applied <see cref="ApiConventionTypeAttribute"/> or <see cref="ApiConventionMethodAttribute"/>.</item>
-/// <item><see cref="ProducesErrorResponseTypeAttribute"/> that applies to the action.</item>
+/// <item><description><see cref="ApiConventionResult"/> from applied <see cref="ApiConventionTypeAttribute"/> or <see cref="ApiConventionMethodAttribute"/>.</description></item>
+/// <item><description><see cref="ProducesErrorResponseTypeAttribute"/> that applies to the action.</description></item>
/// </list>
/// </summary>
public class ApiConventionApplicationModelConvention : IActionModelConvention
--
GitLab