Skip to content
代码片段 群组 项目
未验证 提交 761eec97 编辑于 作者: github-actions[bot]'s avatar github-actions[bot] 提交者: GitHub
浏览文件

[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: default avatarBruno Oliveira <brunolins16@users.noreply.github.com>
上级 a79ce193
No related branches found
No related tags found
无相关合并请求
...@@ -6,20 +6,20 @@ namespace Microsoft.AspNetCore.Components.Server.Circuits; ...@@ -6,20 +6,20 @@ namespace Microsoft.AspNetCore.Components.Server.Circuits;
/// <summary> /// <summary>
/// A <see cref="CircuitHandler"/> allows running code during specific lifetime events of a <see cref="Circuit"/>. /// A <see cref="CircuitHandler"/> allows running code during specific lifetime events of a <see cref="Circuit"/>.
/// <list type="bullet"> /// <list type="bullet">
/// <item> /// <item><description>
/// <see cref="OnCircuitOpenedAsync(Circuit, CancellationToken)"/> is invoked after an initial circuit to the client /// <see cref="OnCircuitOpenedAsync(Circuit, CancellationToken)"/> is invoked after an initial circuit to the client
/// has been established. /// has been established.
/// </item> /// </description></item>
/// <item> /// <item><description>
/// <see cref="OnConnectionUpAsync(Circuit, CancellationToken)"/> is invoked immediately after the completion of /// <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 /// <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 /// with a client after it's been dropped. <see cref="OnConnectionDownAsync(Circuit, CancellationToken)"/> is invoked each time a connection
/// is dropped. /// is dropped.
/// </item> /// </description></item>
/// <item> /// <item><description>
/// <see cref="OnCircuitClosedAsync(Circuit, CancellationToken)"/> is invoked prior to the server evicting the circuit to the client. /// <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. /// Application users may use this event to save state for a client that can be later rehydrated.
/// </item> /// </description></item>
/// </list> /// </list>
/// </summary> /// </summary>
public abstract class CircuitHandler public abstract class CircuitHandler
......
...@@ -16,8 +16,10 @@ public interface IProblemDetailsService ...@@ -16,8 +16,10 @@ public interface IProblemDetailsService
/// <param name="context">The <see cref="ProblemDetailsContext"/> associated with the current request/response.</param> /// <param name="context">The <see cref="ProblemDetailsContext"/> associated with the current request/response.</param>
/// <remarks>The <see cref="IProblemDetailsWriter"/> registered services /// <remarks>The <see cref="IProblemDetailsWriter"/> registered services
/// are processed in sequence and the processing is completed when: /// 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">
/// <list type="bullet">All <see cref="IProblemDetailsWriter"/> were executed and none of them was able to write the response successfully.</list> /// <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> /// </remarks>
ValueTask WriteAsync(ProblemDetailsContext context); ValueTask WriteAsync(ProblemDetailsContext context);
} }
...@@ -71,8 +71,8 @@ public interface IHttpRequestFeature ...@@ -71,8 +71,8 @@ public interface IHttpRequestFeature
/// <para> /// <para>
/// The values are not split or merged across header lines. E.g. The following headers: /// The values are not split or merged across header lines. E.g. The following headers:
/// <list type="bullet"> /// <list type="bullet">
/// <item>HeaderA: value1, value2</item> /// <item><description>HeaderA: value1, value2</description></item>
/// <item>HeaderA: value3</item> /// <item><description>HeaderA: value3</description></item>
/// </list> /// </list>
/// Result in Headers["HeaderA"] = { "value1, value2", "value3" } /// Result in Headers["HeaderA"] = { "value1, value2", "value3" }
/// </para> /// </para>
......
...@@ -543,9 +543,9 @@ public static class TypedResults ...@@ -543,9 +543,9 @@ public static class TypedResults
/// <summary> /// <summary>
/// Redirects to the specified <paramref name="url"/>. /// Redirects to the specified <paramref name="url"/>.
/// <list type="bullet"> /// <list type="bullet">
/// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> 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>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item> /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
/// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</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> /// <item>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</item>
/// </list> /// </list>
/// </summary> /// </summary>
...@@ -566,9 +566,9 @@ public static class TypedResults ...@@ -566,9 +566,9 @@ public static class TypedResults
/// <summary> /// <summary>
/// Redirects to the specified <paramref name="localUrl"/>. /// Redirects to the specified <paramref name="localUrl"/>.
/// <list type="bullet"> /// <list type="bullet">
/// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> 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>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item> /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
/// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</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> /// <item>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</item>
/// </list> /// </list>
/// </summary> /// </summary>
...@@ -589,10 +589,10 @@ public static class TypedResults ...@@ -589,10 +589,10 @@ public static class TypedResults
/// <summary> /// <summary>
/// Redirects to the specified route. /// Redirects to the specified route.
/// <list type="bullet"> /// <list type="bullet">
/// <item>When <paramref name="permanent"/> and <paramref name="preserveMethod"/> are set, sets the <see cref="StatusCodes.Status308PermanentRedirect"/> 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>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</item> /// <item><description>When <paramref name="preserveMethod"/> is set, sets the <see cref="StatusCodes.Status307TemporaryRedirect"/> status code.</description></item>
/// <item>When <paramref name="permanent"/> is set, sets the <see cref="StatusCodes.Status301MovedPermanently"/> status code.</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> /// <item><description>Otherwise, configures <see cref="StatusCodes.Status302Found"/>.</description></item>
/// </list> /// </list>
/// </summary> /// </summary>
/// <param name="routeName">The name of the route.</param> /// <param name="routeName">The name of the route.</param>
......
...@@ -41,13 +41,13 @@ public class CorsPolicyBuilder ...@@ -41,13 +41,13 @@ public class CorsPolicyBuilder
/// the normalization performed by the browser on the value sent in the <c>ORIGIN</c> header. /// the normalization performed by the browser on the value sent in the <c>ORIGIN</c> header.
/// <list type="bullet"> /// <list type="bullet">
/// <item> /// <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. /// 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"/> /// 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>
/// <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> /// </item>
/// </list> /// </list>
/// </remarks> /// </remarks>
......
...@@ -52,9 +52,9 @@ public class ApiParameterDescription ...@@ -52,9 +52,9 @@ public class ApiParameterDescription
/// <remarks> /// <remarks>
/// A parameter is considered required if /// A parameter is considered required if
/// <list type="bullet"> /// <list type="bullet">
/// <item>it's bound from the request body (<see cref="BindingSource.Body"/>).</item> /// <item><description>it's bound from the request body (<see cref="BindingSource.Body"/>).</description></item>
/// <item>it's a required route value.</item> /// <item><description>it's a required route value.</description></item>
/// <item>it has annotations (e.g. BindRequiredAttribute) that indicate it's required.</item> /// <item><description>it has annotations (e.g. BindRequiredAttribute) that indicate it's required.</description></item>
/// </list> /// </list>
/// </remarks> /// </remarks>
public bool IsRequired { get; set; } public bool IsRequired { get; set; }
......
...@@ -10,8 +10,8 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels; ...@@ -10,8 +10,8 @@ namespace Microsoft.AspNetCore.Mvc.ApplicationModels;
/// <summary> /// <summary>
/// An <see cref="IActionModelConvention"/> that discovers /// An <see cref="IActionModelConvention"/> that discovers
/// <list type="bullet"> /// <list type="bullet">
/// <item><see cref="ApiConventionResult"/> from applied <see cref="ApiConventionTypeAttribute"/> or <see cref="ApiConventionMethodAttribute"/>.</item> /// <item><description><see cref="ApiConventionResult"/> from applied <see cref="ApiConventionTypeAttribute"/> or <see cref="ApiConventionMethodAttribute"/>.</description></item>
/// <item><see cref="ProducesErrorResponseTypeAttribute"/> that applies to the action.</item> /// <item><description><see cref="ProducesErrorResponseTypeAttribute"/> that applies to the action.</description></item>
/// </list> /// </list>
/// </summary> /// </summary>
public class ApiConventionApplicationModelConvention : IActionModelConvention public class ApiConventionApplicationModelConvention : IActionModelConvention
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册