Merge branch 'maintenance/XMLDoc-fixes' into develop

Fixed a couple of minor errors in the XML Doc metadata which will cause problems when compiling the XML documentation for use with e.g. DocFx, as proposed in #29.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc/TopicViewResultExecutor.cs

@@ -50,10 +50,10 @@ IModelMetadataProvider modelMetadataProvider
     ///   Loops through potential sources for views to identify the most appropriate <see cref="RazorView"/>.
     /// </summary>
     /// <remarks>
-    ///   Will look for a view, in order, from the query string (<code>?View=</code>), <see cref="HttpRequest.Headers"/>
-    ///   collection (for matches in the <code>accepts</code> header), then the <see cref="Topic.View"/> property, if set, and
-    ///   finally falls back to the <see cref="Topic.ContentType"/>. If none of those yield any results, will default to a
-    ///   content type of "Page", which expects to find <code>~/Views/Page/Page.cshtml</code>.
+    ///   Will look for a view, in order, from the query string (<c>?View=</c>), <see cref="HttpRequest.Headers"/> collection
+    ///   (for matches in the <c>accepts</c> header), then the <see cref="Topic.View"/> property, if set, and finally falls back
+    ///   to the <see cref="Topic.ContentType"/>. If none of those yield any results, will default to a content type of "Page",
+    ///   which expects to find <c>~/Views/Page/Page.cshtml</c>.
     /// </remarks>
     /// <param name="actionContext">The <see cref="ActionContext"/> associated with the current request.</param>
     /// <param name="viewResult">The <see cref="TopicViewResult"/>.</param>

OnTopic.ViewModels/NavigationTopicViewModel.cs

@@ -46,7 +46,7 @@ public sealed record NavigationTopicViewModel : INavigationTopicViewModel<Naviga
     /*==========================================================================================================================
     | WEB PATH
     \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <inheritdoc cref="WebPath"/>
+    /// <inheritdoc/>
     [Required]
     public string WebPath { get; init; } = default!;
 

OnTopic/Associations/ReferenceSetterAttribute.cs

@@ -18,15 +18,15 @@ namespace OnTopic.Associations {
   ///   <para>
   ///     When a call is made to <see cref="TrackedRecordCollection{TItem, TValue, TAttribute}.SetValue(String, TValue,
   ///     Boolean?, DateTime?)"/> the code will check to see if a property with the same name as the reference key exists, and
-  ///     whether that property is decorated with the <see cref="ReferenceSetterAttribute"/> (i.e., <code>[ReferenceSetter]
-  ///     </code>). If is, then the update will be routed through that property. This ensures that business logic is enforced by
-  ///     local properties, instead of allowing business logic to be potentially bypassed by writing directly to the <see cref="
-  ///     Topic.References"/> collection.
+  ///     whether that property is decorated with the <see cref="ReferenceSetterAttribute"/> (i.e., <c>[ReferenceSetter]</c>). 
+  ///     If is, then the update will be routed through that property. This ensures that business logic is enforced by local 
+  ///     properties, instead of allowing business logic to be potentially bypassed by writing directly to the <see cref="Topic.
+  ///     References"/> collection.
   ///   </para>
   ///   <para>
   ///     As an example, the <see cref="Topic.BaseTopic"/> property is adorned with the <see cref="ReferenceSetterAttribute"/>.
-  ///     As a result, if a client calls <code>topic.References.SetValue("BaseTopic", topic)</code>, then that update will be
-  ///     routed through <see cref="Topic.BaseTopic"/>, thus enforcing any validation.
+  ///     As a result, if a client calls <c>topic.References.SetValue("BaseTopic", topic)</c>, then that update will be routed 
+  ///     through <see cref="Topic.BaseTopic"/>, thus enforcing any validation.
   ///   </para>
   ///   <para>
   ///     To ensure this logic, it is critical that implementers of <see cref="ReferenceSetterAttribute"/> ensure that the

OnTopic/Attributes/AttributeSetterAttribute.cs

@@ -19,9 +19,9 @@ namespace OnTopic.Attributes {
   ///   <para>
   ///     When a call is made to <see cref="AttributeCollection.SetValue(String, String, Boolean?, DateTime?, Boolean?)"/>, the
   ///     code will check to see if a property with the same name as the attribute key exists, and whether that property is
-  ///     decorated with the <see cref="AttributeSetterAttribute"/> (i.e., <code>[AttributeSetter]</code>). If it is, then the
-  ///     update will be routed through that property. This ensures that business logic is enforced by local properties, instead
-  ///     of allowing business logic to be potentially bypassed by writing directly to the <see cref="Topic.Attributes"/>
+  ///     decorated with the <see cref="AttributeSetterAttribute"/> (i.e., <c>[AttributeSetter]</c>). If it is, then the update
+  ///     will be routed through that property. This ensures that business logic is enforced by local properties, instead of
+  ///     allowing business logic to be potentially bypassed by writing directly to the <see cref="Topic.Attributes"/>
   ///     collection.
   ///   </para>
   ///   <para>

OnTopic/Internal/Diagnostics/Contract.cs

@@ -24,14 +24,14 @@ namespace OnTopic.Internal.Diagnostics {
   ///   <para>
   ///     <see cref="Contract"/> is not a replacement for Microsoft's Code Contract analysis and rewrite modules. Instead, it
   ///     aims to maintain basic synatactical and functional support for the most basic (and important) features of the rewrite
-  ///     module, such as <code>Contract.Requires()</code>, which is necessary to ensure paramater validation in many methods
+  ///     module, such as <c>Contract.Requires()</c>, which is necessary to ensure paramater validation in many methods
   ///     throughout the OnTopic library. <see cref="Contract"/> does not seek to functionally reproduce Code Contract's
-  ///     <code>Ensures()</code>, <code>Assume()</code>, or <code>Invariant()</code>—those methods are not implemented.
+  ///     <c>Ensures()</c>, <c>Assume()</c>, or <c>Invariant()</c>—those methods are not implemented.
   ///   </para>
   ///   <para>
-  ///     C# 8.0 will introduce nullable reference types. This largely mitigates the need for <code>Contract.Requires()</code>.
-  ///     As such, this library can be seen as a temporary bridge to maintain parameter validation until C# 8.0 is released. At
-  ///     that point, nullable reference types should be used in preference for many of the <code>Contract.Requires()</code>
+  ///     C# 8.0 will introduce nullable reference types. This largely mitigates the need for <c>Contract.Requires()</c>. As
+  ///     such, this library can be seen as a temporary bridge to maintain parameter validation until C# 8.0 is released. At
+  ///     that point, nullable reference types should be used in preference for many of the <c>Contract.Requires()</c>
   ///     calls—though, acknowledging, that there are some conditions that won't be satisfied by that (e.g., range checks).
   ///   </para>
   ///   <para>