Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing XML documentation issues for Microsoft.AspNetCore.Http.Results' methods #44429

Merged
merged 1 commit into from
Oct 12, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 36 additions & 12 deletions src/Http/Http.Results/src/Results.cs
Original file line number Diff line number Diff line change
Expand Up @@ -424,10 +424,18 @@ public static IResult File(
/// <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>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="url">The URL to redirect to.</param>
Expand All @@ -440,10 +448,18 @@ public static IResult Redirect(string url, bool permanent = false, bool preserve
/// <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>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="localUrl">The local URL to redirect to.</param>
Expand All @@ -456,10 +472,18 @@ public static IResult LocalRedirect(string localUrl, bool permanent = false, boo
/// <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>
Expand Down