Skip to content

Commit

Permalink
Update doc comments to use langword appropriately
Browse files Browse the repository at this point in the history
  • Loading branch information
@daviddotcs
daviddotcs committed Jun 13, 2024
1 parent f2c80ab commit 4870a2b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/SafeRouting.Common/Extensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public static ActionResult Redirect(this IRouteValues route, ControllerBase cont
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IPageRouteValues route, LinkGenerator generator, PathString pathBase = default, FragmentString fragment = default, LinkOptions? options = null)
=> generator.GetPathByPage(route.PageName, route.HandlerName, route.RouteValues, pathBase, fragment, options);

Expand All @@ -160,7 +160,7 @@ public static string Path(this IPageRouteValues route, LinkGenerator generator,
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IPageRouteValues route, LinkGenerator generator, HttpContext httpContext, PathString? pathBase = null, FragmentString fragment = default, LinkOptions? options = null)
=> generator.GetPathByPage(httpContext, route.PageName, route.HandlerName, route.RouteValues, pathBase, fragment, options);

Expand All @@ -174,7 +174,7 @@ public static string Path(this IPageRouteValues route, LinkGenerator generator,
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand All @@ -197,7 +197,7 @@ public static string Url(this IPageRouteValues route, LinkGenerator generator, s
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand All @@ -217,7 +217,7 @@ public static string Url(this IPageRouteValues route, LinkGenerator generator, H
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IControllerRouteValues route, LinkGenerator generator, PathString pathBase = default, FragmentString fragment = default, LinkOptions? options = null)
=> generator.GetPathByAction(route.ActionName, route.ControllerName, route.RouteValues, pathBase, fragment, options);

Expand All @@ -230,7 +230,7 @@ public static string Path(this IControllerRouteValues route, LinkGenerator gener
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IControllerRouteValues route, LinkGenerator generator, HttpContext httpContext, PathString? pathBase = null, FragmentString fragment = default, LinkOptions? options = null)
=> generator.GetPathByAction(httpContext, route.ActionName, route.ControllerName, route.RouteValues, pathBase, fragment, options);

Expand All @@ -244,7 +244,7 @@ public static string Path(this IControllerRouteValues route, LinkGenerator gener
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand All @@ -267,7 +267,7 @@ public static string Url(this IControllerRouteValues route, LinkGenerator genera
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand All @@ -287,7 +287,7 @@ public static string Url(this IControllerRouteValues route, LinkGenerator genera
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IRouteValues route, LinkGenerator generator, PathString pathBase = default, FragmentString fragment = default, LinkOptions? options = null)
=> route switch
{
Expand All @@ -305,7 +305,7 @@ public static string Path(this IRouteValues route, LinkGenerator generator, Path
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A URI with an absolute path, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A URI with an absolute path, or <see langword="null" /> if a URI cannot be created.</returns>
public static string Path(this IRouteValues route, LinkGenerator generator, HttpContext httpContext, PathString? pathBase = null, FragmentString fragment = default, LinkOptions? options = null)
=> route switch
{
Expand All @@ -324,7 +324,7 @@ public static string Path(this IRouteValues route, LinkGenerator generator, Http
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand Down Expand Up @@ -352,7 +352,7 @@ public static string Url(this IRouteValues route, LinkGenerator generator, strin
/// <param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="HttpRequest.PathBase"/> will be used.</param>
/// <param name="fragment">A URI fragment. Optional. Appended to the resulting URI.</param>
/// <param name="options">An optional <see cref="LinkOptions"/>. Settings on provided object override the settings with matching names from <c>RouteOptions</c>.</param>
/// <returns>A absolute URI, or <c>null</c> if a URI cannot be created.</returns>
/// <returns>A absolute URI, or <see langword="null" /> if a URI cannot be created.</returns>
/// <remarks>
/// <para>
/// The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
Expand Down

0 comments on commit 4870a2b

Please sign in to comment.