Skip to content

Commit f503bf6

Browse files
committed
CSHARP-4087: Fixed API docs warnings.
1 parent cd60f58 commit f503bf6

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

src/MongoDB.Driver.Legacy/MongoCursor.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ public virtual BsonDocument Explain()
411411
/// Returns an explanation of how the query was executed (instead of the results).
412412
/// </summary>
413413
/// <param name="verbose">Whether the explanation should contain more details.</param>
414-
/// <returns>An explanation of thow the query was executed.</returns>
414+
/// <returns>An explanation of throw the query was executed.</returns>
415415
public virtual BsonDocument Explain(bool verbose)
416416
{
417417
var verbosity = verbose ? ExplainVerbosity.AllPlansExecution : ExplainVerbosity.QueryPlanner;
@@ -427,6 +427,7 @@ BsonDocument ExecuteExplainOperation(IClientSessionHandle session)
427427
/// <summary>
428428
/// Creates an explain operation for this cursor.
429429
/// </summary>
430+
/// <param name="verbosity">The requested <see cref="ExplainVerbosity"/>.</param>
430431
/// <returns>An explain operation.</returns>
431432
protected abstract ExplainOperation CreateExplainOperation(ExplainVerbosity verbosity);
432433

src/MongoDB.Driver/AggregateFluentBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ public virtual IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWin
215215
/// <inheritdoc />
216216
public virtual IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
217217
AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
218-
SortDefinition<TResult> sort,
218+
SortDefinition<TResult> sortBy,
219219
AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output)
220220
{
221221
throw new NotImplementedException();

src/MongoDB.Driver/IAggregateFluent.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ IAggregateFluent<TNewResult> Lookup<TForeignDocument, TAsElement, TAs, TNewResul
325325
/// </summary>
326326
/// <typeparam name="TWindowFields">The type of the added window fields.</typeparam>
327327
/// <param name="output">The window fields definition.</param>
328-
/// <returns></returns>
328+
/// <returns>The fluent aggregate interface.</returns>
329329
IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
330330
AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output);
331331

@@ -336,7 +336,7 @@ IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
336336
/// <typeparam name="TWindowFields">The type of the added window fields.</typeparam>
337337
/// <param name="partitionBy">The partitionBy definition.</param>
338338
/// <param name="output">The window fields definition.</param>
339-
/// <returns></returns>
339+
/// <returns>The fluent aggregate interface.</returns>
340340
IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
341341
AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
342342
AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output);
@@ -349,7 +349,7 @@ IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
349349
/// <param name="partitionBy">The partitionBy definition.</param>
350350
/// <param name="sortBy">The sortBy definition.</param>
351351
/// <param name="output">The window fields definition.</param>
352-
/// <returns></returns>
352+
/// <returns>The fluent aggregate interface.</returns>
353353
IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
354354
AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
355355
SortDefinition<TResult> sortBy,

src/MongoDB.Driver/RangeWindow.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ public sealed class RangeWindow : SetWindowFieldsWindow
4040
/// <summary>
4141
/// Creates a range window.
4242
/// </summary>
43+
/// <typeparam name="TValue">The type of the boundary conditions.</typeparam>
4344
/// <param name="lowerBoundary">The lower boundary.</param>
4445
/// <param name="upperBoundary">The upper boundary.</param>
4546
/// <returns>A range window.</returns>
@@ -51,6 +52,7 @@ public static RangeWindow Create<TValue>(TValue lowerBoundary, TValue upperBound
5152
/// <summary>
5253
/// Creates a range window.
5354
/// </summary>
55+
/// <typeparam name="TValue">The type of the lower boundary condition.</typeparam>
5456
/// <param name="lowerBoundary">The lower boundary.</param>
5557
/// <param name="upperBoundary">The upper boundary.</param>
5658
/// <returns>A range window.</returns>
@@ -62,6 +64,7 @@ public static RangeWindow Create<TValue>(TValue lowerBoundary, KeywordRangeWindo
6264
/// <summary>
6365
/// Creates a range window.
6466
/// </summary>
67+
/// <typeparam name="TValue">The type of the upper boundary condition.</typeparam>
6568
/// <param name="lowerBoundary">The lower boundary.</param>
6669
/// <param name="upperBoundary">The upper boundary.</param>
6770
/// <returns>A range window.</returns>

src/MongoDB.Driver/RangeWindowBoundary.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ internal ValueRangeWindowBoundary() { } // disallow user defined subclasses
6868
/// <summary>
6969
/// Represents a value boundary for a range window in SetWindowFields.
7070
/// </summary>
71+
/// <typeparam name="TValue">The type of the range window boundary.</typeparam>
7172
public sealed class ValueRangeWindowBoundary<TValue> : ValueRangeWindowBoundary
7273
{
7374
private readonly TValue _value;

0 commit comments

Comments
 (0)