Addressed mismatched parameter documentation

Added documentation for parameters where missing, removed extraneous documentation from since-deleted parameters, and updated documentation—or parameters!—to ensure they shared the same name. This resolves CS1573.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc/Controllers/SitemapController.cs

@@ -168,7 +168,7 @@ public ActionResult Index(bool indent = false, bool includeMetadata = false) {
     /// <summary>
     ///   Given a root topic, generates an XML-formatted sitemap.
     /// </summary>
-    /// <param name="topic">The topic to add to the sitemap.</param>
+    /// <param name="rootTopic">The topic to add to the sitemap.</param>
     /// <param name="includeMetadata">Optionally enables extended metadata associated with each topic.</param>
     /// <returns>A Sitemap.org sitemap.</returns>
     private XDocument GenerateSitemap(Topic rootTopic, bool includeMetadata = false) =>

OnTopic.AspNetCore.Mvc/TopicViewLocationExpander.cs

@@ -88,10 +88,7 @@ public void PopulateValues(ViewLocationExpanderContext context) {
     /*==========================================================================================================================
     | METHOD: EXPAND VIEW LOCATIONS
     \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <summary>
-    ///   Introduces additional routes
-    /// </summary>
-    /// <param name="context">The <see cref="ViewLocationExpanderContext"/> that the request is operating within.</param>
+    /// <inheritdoc/>
     public IEnumerable<string> ExpandViewLocations(ViewLocationExpanderContext context, IEnumerable<string> viewLocations) {
 
       /*------------------------------------------------------------------------------------------------------------------------

OnTopic.AspNetCore.Mvc/TopicViewResultExecutor.cs

@@ -35,7 +35,6 @@ public class TopicViewResultExecutor : ViewExecutor, IActionResultExecutor<Topic
     /// <param name="viewEngine">The <see cref="ICompositeViewEngine"/>.</param>
     /// <param name="tempDataFactory">The <see cref="ITempDataDictionaryFactory"/>.</param>
     /// <param name="diagnosticListener">The <see cref="DiagnosticListener"/>.</param>
-    /// <param name="loggerFactory">The <see cref="ILoggerFactory"/>.</param>
     /// <param name="modelMetadataProvider">The <see cref="IModelMetadataProvider"/>.</param>
     public TopicViewResultExecutor(
       IOptions<MvcViewOptions> viewOptions,

OnTopic.Data.Sql/SqlCommandExtensions.cs

@@ -105,7 +105,6 @@ internal static void AddParameter(this SqlCommand command, string sqlParameter,
     /// <param name="command">The SQL command object.</param>
     /// <param name="sqlParameter">The SQL parameter.</param>
     /// <param name="fieldValue">The SQL field value.</param>
-    /// <param name="sqlDbType">The SQL field data type.</param>
     internal static void AddParameter(this SqlCommand command, string sqlParameter, string? fieldValue)
       => AddParameter(command, sqlParameter, String.IsNullOrEmpty(fieldValue)? null : fieldValue, SqlDbType.VarChar);
 
@@ -117,7 +116,6 @@ internal static void AddParameter(this SqlCommand command, string sqlParameter,
     /// <param name="fieldValue">The SQL field value.</param>
     /// <param name="sqlDbType">The SQL field data type.</param>
     /// <param name="paramDirection">The SQL parameter's directional setting (input-only, output-only, etc.).</param>
-    /// <param name="sqlLength">Length limit for the SQL field.</param>
     /// <requires description="The SQL command object must be specified." exception="T:System.ArgumentNullException">
     ///   command is not null
     /// </requires>

OnTopic.Data.Sql/SqlDataReaderExtensions.cs

@@ -347,7 +347,7 @@ private static void SetExtendedAttributes(this SqlDataReader reader, TopicIndex
     ///   behavior is overwritten to accept whatever value is submitted. This can be used, for instance, to prevent an update
     ///   from being persisted to the data store on <see cref="Repositories.ITopicRepository.Save(Topic, Boolean)"/>.
     /// </param>
-    private static void SetRelationships(this IDataReader reader, TopicIndex topics, bool? isDirty = false) {
+    private static void SetRelationships(this IDataReader reader, TopicIndex topics, bool? markDirty = false) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Identify attributes
@@ -378,7 +378,7 @@ private static void SetRelationships(this IDataReader reader, TopicIndex topics,
       | Set relationship on object
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (!isDeleted) {
-        current.Relationships.SetValue(relationshipKey, related, isDirty);
+        current.Relationships.SetValue(relationshipKey, related, markDirty);
       }
       else if (current.Relationships.Contains(relationshipKey, related)) {
         current.Relationships.Remove(relationshipKey, related);

OnTopic.Data.Sql/SqlTopicRepository.cs

@@ -618,6 +618,7 @@ protected override sealed void DeleteTopic(Topic topic) {
     ///   Internal method that saves topic relationships to the n:n mapping table in SQL.
     /// </summary>
     /// <param name="topic">The topic object whose relationships should be persisted.</param>
+    /// <param name="version">The version that should be associated with the updated value.</param>
     /// <param name="connection">The SQL connection.</param>
     private static void PersistRelationships(Topic topic, DateTime version, SqlConnection connection) {
 
@@ -684,6 +685,7 @@ private static void PersistRelationships(Topic topic, DateTime version, SqlConne
     ///   Internal method that saves topic references to the 1:n mapping table in SQL.
     /// </summary>
     /// <param name="topic">The topic object whose references should be persisted.</param>
+    /// <param name="version">The version that should be associated with the updated value.</param>
     /// <param name="connection">The SQL connection.</param>
     private static void PersistReferences(Topic topic, DateTime version, SqlConnection connection) {