Skip to content

Commit

Permalink
v2.21.0 Documentation fixes (#1158)
Browse files Browse the repository at this point in the history
  • Loading branch information
BorisDog authored Aug 10, 2023
1 parent 46e32bb commit 5a9c331
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
7 changes: 4 additions & 3 deletions src/MongoDB.Driver/Search/IMongoSearchIndexManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down Expand Up @@ -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);

Expand All @@ -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>
Expand Down Expand Up @@ -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);
}
}
1 change: 1 addition & 0 deletions src/MongoDB.Driver/Search/SearchDefinitionBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ public CompoundSearchDefinitionBuilder<TDocument> Compound(SearchScoreDefinition
/// 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>
Expand Down
7 changes: 4 additions & 3 deletions src/MongoDB.Driver/Search/SearchOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit 5a9c331

Please sign in to comment.