From 4870a2bdd33891a8edcb55d038ee99d24f5ea8b6 Mon Sep 17 00:00:00 2001
From: David Wake <6890281+daviddotcs@users.noreply.github.com>
Date: Thu, 13 Jun 2024 20:03:02 +0800
Subject: [PATCH] Update doc comments to use langword appropriately

---
 src/SafeRouting.Common/Extensions.cs | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/SafeRouting.Common/Extensions.cs b/src/SafeRouting.Common/Extensions.cs
index 3996f3b..2b44d7a 100644
--- a/src/SafeRouting.Common/Extensions.cs
+++ b/src/SafeRouting.Common/Extensions.cs
@@ -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);
 
@@ -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);
 
@@ -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
@@ -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
@@ -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);
 
@@ -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);
 
@@ -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
@@ -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
@@ -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
     {
@@ -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
     {
@@ -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
@@ -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