Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2.21.0 Documentation fixes #1158

Merged
merged 2 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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