CSHARP-4087: Fixed API docs warnings.

mongodb · Mar 9, 2022 · f503bf6 · f503bf6
1 parent cd60f58
commit f503bf6
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/src/MongoDB.Driver.Legacy/MongoCursor.cs b/src/MongoDB.Driver.Legacy/MongoCursor.cs
@@ -411,7 +411,7 @@ public virtual BsonDocument Explain()
         /// Returns an explanation of how the query was executed (instead of the results).
         /// </summary>
         /// <param name="verbose">Whether the explanation should contain more details.</param>
-        /// <returns>An explanation of thow the query was executed.</returns>
+        /// <returns>An explanation of throw the query was executed.</returns>
         public virtual BsonDocument Explain(bool verbose)
         {
             var verbosity = verbose ? ExplainVerbosity.AllPlansExecution : ExplainVerbosity.QueryPlanner;
@@ -427,6 +427,7 @@ BsonDocument ExecuteExplainOperation(IClientSessionHandle session)
         /// <summary>
         /// Creates an explain operation for this cursor.
         /// </summary>
+        /// <param name="verbosity">The requested <see cref="ExplainVerbosity"/>.</param>
         /// <returns>An explain operation.</returns>
         protected abstract ExplainOperation CreateExplainOperation(ExplainVerbosity verbosity);
 

diff --git a/src/MongoDB.Driver/AggregateFluentBase.cs b/src/MongoDB.Driver/AggregateFluentBase.cs
@@ -215,7 +215,7 @@ public virtual IAggregateFluent<TNewResult> ReplaceWith<TNewResult>(AggregateExp
         /// <inheritdoc />
         public virtual IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
             AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
-            SortDefinition<TResult> sort,
+            SortDefinition<TResult> sortBy,
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output)
         {
             throw new NotImplementedException();

diff --git a/src/MongoDB.Driver/IAggregateFluent.cs b/src/MongoDB.Driver/IAggregateFluent.cs
@@ -325,7 +325,7 @@ public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>
         /// </summary>
         /// <typeparam name="TWindowFields">The type of the added window fields.</typeparam>
         /// <param name="output">The window fields definition.</param>
-        /// <returns></returns>
+        /// <returns>The fluent aggregate interface.</returns>
         IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output);
 
@@ -336,7 +336,7 @@ public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>
         /// <typeparam name="TWindowFields">The type of the added window fields.</typeparam>
         /// <param name="partitionBy">The partitionBy definition.</param>
         /// <param name="output">The window fields definition.</param>
-        /// <returns></returns>
+        /// <returns>The fluent aggregate interface.</returns>
         IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
             AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output);
@@ -349,7 +349,7 @@ public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>
         /// <param name="partitionBy">The partitionBy definition.</param>
         /// <param name="sortBy">The sortBy definition.</param>
         /// <param name="output">The window fields definition.</param>
-        /// <returns></returns>
+        /// <returns>The fluent aggregate interface.</returns>
         IAggregateFluent<BsonDocument> SetWindowFields<TPartitionBy, TWindowFields>(
             AggregateExpressionDefinition<TResult, TPartitionBy> partitionBy,
             SortDefinition<TResult> sortBy,

diff --git a/src/MongoDB.Driver/RangeWindow.cs b/src/MongoDB.Driver/RangeWindow.cs
@@ -40,6 +40,7 @@ public sealed class RangeWindow : SetWindowFieldsWindow
         /// <summary>
         /// Creates a range window.
         /// </summary>
+        /// <typeparam name="TValue">The type of the boundary conditions.</typeparam>
         /// <param name="lowerBoundary">The lower boundary.</param>
         /// <param name="upperBoundary">The upper boundary.</param>
         /// <returns>A range window.</returns>
@@ -51,6 +52,7 @@ public static RangeWindow Create<TValue>(TValue lowerBoundary, TValue upperBound
         /// <summary>
         /// Creates a range window.
         /// </summary>
+        /// <typeparam name="TValue">The type of the lower boundary condition.</typeparam>
         /// <param name="lowerBoundary">The lower boundary.</param>
         /// <param name="upperBoundary">The upper boundary.</param>
         /// <returns>A range window.</returns>
@@ -62,6 +64,7 @@ public static RangeWindow Create<TValue>(TValue lowerBoundary, KeywordRangeWindo
         /// <summary>
         /// Creates a range window.
         /// </summary>
+        /// <typeparam name="TValue">The type of the upper boundary condition.</typeparam>
         /// <param name="lowerBoundary">The lower boundary.</param>
         /// <param name="upperBoundary">The upper boundary.</param>
         /// <returns>A range window.</returns>

diff --git a/src/MongoDB.Driver/RangeWindowBoundary.cs b/src/MongoDB.Driver/RangeWindowBoundary.cs
@@ -68,6 +68,7 @@ public abstract class ValueRangeWindowBoundary : RangeWindowBoundary
     /// <summary>
     /// Represents a value boundary for a range window in SetWindowFields.
     /// </summary>
+    /// <typeparam name="TValue">The type of the range window boundary.</typeparam>
     public sealed class ValueRangeWindowBoundary<TValue> : ValueRangeWindowBoundary
     {
         private readonly TValue _value;