From 5a9c3311e158910b88195f290e6d4b1b2715d2b2 Mon Sep 17 00:00:00 2001
From: BorisDog <BorisDog@users.noreply.github.com>
Date: Wed, 9 Aug 2023 17:50:09 -0700
Subject: [PATCH] v2.21.0 Documentation fixes (#1158)

---
 .../Serialization/Serializers/DowncastingSerializer.cs     | 4 +++-
 src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs      | 7 ++++---
 src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs       | 1 +
 src/MongoDB.Driver/Search/SearchOptions.cs                 | 7 ++++---
 4 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/src/MongoDB.Bson/Serialization/Serializers/DowncastingSerializer.cs b/src/MongoDB.Bson/Serialization/Serializers/DowncastingSerializer.cs
index e611caaf597..acfa77ed7d7 100644
--- a/src/MongoDB.Bson/Serialization/Serializers/DowncastingSerializer.cs
+++ b/src/MongoDB.Bson/Serialization/Serializers/DowncastingSerializer.cs
@@ -83,7 +83,9 @@ public DowncastingSerializer(IBsonSerializer<TDerived> derivedSerializer)
         /// <inheritdoc/>
         public Type BaseType => typeof(TBase);
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// The serializer for the derived type.
+        /// </summary>
         public IBsonSerializer<TDerived> DerivedSerializer => _derivedSerializer;
 
         IBsonSerializer IDowncastingSerializer.DerivedSerializer => _derivedSerializer;
diff --git a/src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs b/src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs
index c4619027f22..b0741339fa7 100644
--- a/src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs
+++ b/src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs
@@ -41,7 +41,7 @@ public interface IMongoSearchIndexManager
         /// <param name="models">The models defining each of the indexes.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>
-        /// A task whose result is an <see cref="IEnumerable{String}" /> of the names of the indexes that were created.
+        /// A Task whose result is an <see cref="IEnumerable{String}" /> of the names of the indexes that were created.
         /// </returns>
         Task<IEnumerable<string>> CreateManyAsync(IEnumerable<CreateSearchIndexModel> models, CancellationToken cancellationToken = default);
 
@@ -83,7 +83,7 @@ public interface IMongoSearchIndexManager
         /// <param name="model">The model defining the index.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>
-        /// A task whose result is the name of the index that was created.
+        /// A Task whose result is the name of the index that was created.
         /// </returns>
         Task<string> CreateOneAsync(CreateSearchIndexModel model, CancellationToken cancellationToken = default);
 
@@ -99,7 +99,7 @@ public interface IMongoSearchIndexManager
         /// </summary>
         /// <param name="name">The index name.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
-        /// <returns>A task.</returns>
+        /// <returns>A Task.</returns>
         Task DropOneAsync(string name, CancellationToken cancellationToken = default);
 
         /// <summary>
@@ -138,6 +138,7 @@ public interface IMongoSearchIndexManager
         /// <param name="name">Name of the index.</param>
         /// <param name="definition">The definition.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
+        /// <returns>A Task.</returns>
         Task UpdateAsync(string name, BsonDocument definition, CancellationToken cancellationToken = default);
     }
 }
diff --git a/src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs b/src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs
index d652068ce75..01a79d13b82 100644
--- a/src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs
+++ b/src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs
@@ -77,6 +77,7 @@ public sealed class SearchDefinitionBuilder<TDocument>
         /// the specified query <paramref name="operator"/> is satisfied from a single element
         /// of an array of embedded documents specified by <paramref name="path"/>.
         /// </summary>
+        /// <typeparam name="TField">The type of the field.</typeparam>
         /// <param name="path">The indexed field to search.</param>
         /// <param name="operator">The operator.</param>
         /// <param name="score">The score modifier.</param>
diff --git a/src/MongoDB.Driver/Search/SearchOptions.cs b/src/MongoDB.Driver/Search/SearchOptions.cs
index deea0780bdd..77f625706cf 100644
--- a/src/MongoDB.Driver/Search/SearchOptions.cs
+++ b/src/MongoDB.Driver/Search/SearchOptions.cs
@@ -18,7 +18,8 @@ namespace MongoDB.Driver.Search
     /// <summary>
     /// Options for search.
     /// </summary>
-    public sealed class SearchOptions<TResult>
+    /// <typeparam name="TDocument">The type of the document.</typeparam>
+    public sealed class SearchOptions<TDocument>
     {
         /// <summary>
         /// Gets or sets the options for counting the search results.
@@ -28,7 +29,7 @@ public sealed class SearchOptions<TResult>
         /// <summary>
         /// Gets or sets the options for highlighting.
         /// </summary>
-        public SearchHighlightOptions<TResult> Highlight { get; set; }
+        public SearchHighlightOptions<TDocument> Highlight { get; set; }
 
         /// <summary>
         /// Gets or sets the index name.
@@ -50,7 +51,7 @@ public sealed class SearchOptions<TResult>
         /// <summary>
         /// Gets or sets the sort specification.
         /// </summary>
-        public SortDefinition<TResult> Sort { get; set; }
+        public SortDefinition<TDocument> Sort { get; set; }
 
         /// <summary>
         /// Gets or sets the options for tracking search terms.