Skip to content

Commit 35b72f8

Browse files
craiggwilsoncraiggwilson
committed
cleaning up doc comments.
1 parent 48326fb commit 35b72f8

File tree

2 files changed

+29
-17
lines changed

2 files changed

+29
-17
lines changed

‎MongoDB.Driver/Builders/QueryBuilder.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -347,8 +347,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
347347
/// Tests that the value of the named element is near some location (see $near).
348348
/// </summary>
349349
/// <param name="name">The name of the element to test.</param>
350-
/// <param name="x">The x value of the origin.</param>
351-
/// <param name="y">The y value of the origin.</param>
350+
/// <param name="point">The point.</param>
352351
/// <param name="maxDistance">The max distance.</param>
353352
/// <returns>An IMongoQuery.</returns>
354353
public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordinates> point, double maxDistance)
@@ -361,8 +360,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
361360
/// Tests that the value of the named element is near some location (see $near).
362361
/// </summary>
363362
/// <param name="name">The name of the element to test.</param>
364-
/// <param name="x">The x value of the origin.</param>
365-
/// <param name="y">The y value of the origin.</param>
363+
/// <param name="point">The point.</param>
366364
/// <param name="maxDistance">The max distance.</param>
367365
/// <param name="spherical">if set to <c>true</c> then the query will be translated to $nearSphere.</param>
368366
/// <returns>An IMongoQuery.</returns>

‎MongoDB.Driver/Builders/UpdateBuilder.cs‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -431,33 +431,36 @@ public static UpdateBuilder PushEach(string name, params BsonValue[] values)
431431
/// Adds a list of values to the end of the named array element (see $push and $each).
432432
/// </summary>
433433
/// <param name="name">The name of the array element.</param>
434+
/// <param name="options">The options.</param>
434435
/// <param name="values">The values to add to the end of the array.</param>
435436
/// <returns>The builder (so method calls can be chained).</returns>
436-
public static UpdateBuilder PushEach(string name, PushEachOptions args, BsonArray values)
437+
public static UpdateBuilder PushEach(string name, PushEachOptions options, BsonArray values)
437438
{
438-
return new UpdateBuilder().PushEach(name, args, values);
439+
return new UpdateBuilder().PushEach(name, options, values);
439440
}
440441

441442
/// <summary>
442443
/// Adds a list of values to the end of the named array element (see $push and $each).
443444
/// </summary>
444445
/// <param name="name">The name of the array element.</param>
446+
/// <param name="options">The options.</param>
445447
/// <param name="values">The values to add to the end of the array.</param>
446448
/// <returns>The builder (so method calls can be chained).</returns>
447-
public static UpdateBuilder PushEach(string name, PushEachOptions args, IEnumerable<BsonValue> values)
449+
public static UpdateBuilder PushEach(string name, PushEachOptions options, IEnumerable<BsonValue> values)
448450
{
449-
return new UpdateBuilder().PushEach(name, args, values);
451+
return new UpdateBuilder().PushEach(name, options, values);
450452
}
451453

452454
/// <summary>
453455
/// Adds a list of values to the end of the named array element (see $push and $each).
454456
/// </summary>
455457
/// <param name="name">The name of the array element.</param>
458+
/// <param name="options">The options.</param>
456459
/// <param name="values">The values to add to the end of the array.</param>
457460
/// <returns>The builder (so method calls can be chained).</returns>
458-
public static UpdateBuilder PushEach(string name, PushEachOptions args, params BsonValue[] values)
461+
public static UpdateBuilder PushEach(string name, PushEachOptions options, params BsonValue[] values)
459462
{
460-
return new UpdateBuilder().PushEach(name, args, values);
463+
return new UpdateBuilder().PushEach(name, options, values);
461464
}
462465

463466
/// <summary>
@@ -474,6 +477,7 @@ public static UpdateBuilder PushEachWrapped<T>(string name, IEnumerable<T> value
474477
/// <summary>
475478
/// Adds a list of values to the end of the named array element (see $push and $each).
476479
/// </summary>
480+
/// <typeparam name="T">The type of wrapped value.</typeparam>
477481
/// <param name="name">The name of the array element.</param>
478482
/// <param name="values">The values to add to the end of the array.</param>
479483
/// <returns>The builder (so method calls can be chained).</returns>
@@ -485,23 +489,27 @@ public static UpdateBuilder PushEachWrapped<T>(string name, params T[] values)
485489
/// <summary>
486490
/// Adds a list of values to the end of the named array element (see $push and $each).
487491
/// </summary>
492+
/// <typeparam name="T">The type of wrapped value.</typeparam>
488493
/// <param name="name">The name of the array element.</param>
494+
/// <param name="options">The options.</param>
489495
/// <param name="values">The values to add to the end of the array.</param>
490496
/// <returns>The builder (so method calls can be chained).</returns>
491-
public static UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions args, IEnumerable<T> values)
497+
public static UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions options, IEnumerable<T> values)
492498
{
493-
return new UpdateBuilder().PushEachWrapped<T>(name, args, values);
499+
return new UpdateBuilder().PushEachWrapped<T>(name, options, values);
494500
}
495501

496502
/// <summary>
497503
/// Adds a list of values to the end of the named array element (see $push and $each).
498504
/// </summary>
505+
/// <typeparam name="T">The type of wrapped value.</typeparam>
499506
/// <param name="name">The name of the array element.</param>
507+
/// <param name="options">The options.</param>
500508
/// <param name="values">The values to add to the end of the array.</param>
501509
/// <returns>The builder (so method calls can be chained).</returns>
502-
public static UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions args, params T[] values)
510+
public static UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions options, params T[] values)
503511
{
504-
return new UpdateBuilder().PushEachWrapped<T>(name, args, values);
512+
return new UpdateBuilder().PushEachWrapped<T>(name, options, values);
505513
}
506514

507515
/// <summary>
@@ -2247,7 +2255,7 @@ public UpdateBuilder<TDocument> PushAll<TValue>(Expression<Func<TDocument, IEnum
22472255
/// <summary>
22482256
/// Adds a list of values to the end of the named array element (see $push and $each).
22492257
/// </summary>
2250-
/// <param name="name">The name of the array element.</param>
2258+
/// <param name="memberExpression">The name of the array element.</param>
22512259
/// <param name="values">The values to add to the end of the array.</param>
22522260
/// <returns>The builder (so method calls can be chained).</returns>
22532261
public UpdateBuilder<TDocument> PushEach<TValue>(Expression<Func<TDocument, IEnumerable<TValue>>> memberExpression, IEnumerable<TValue> values)
@@ -2258,9 +2266,12 @@ public UpdateBuilder<TDocument> PushEach<TValue>(Expression<Func<TDocument, IEnu
22582266
/// <summary>
22592267
/// Adds a list of values to the end of the named array element (see $push and $each).
22602268
/// </summary>
2261-
/// <param name="name">The name of the array element.</param>
2269+
/// <typeparam name="TValue">The type of the value.</typeparam>
2270+
/// <param name="memberExpression">The name of the array element.</param>
2271+
/// <param name="options">The options.</param>
22622272
/// <param name="values">The values to add to the end of the array.</param>
22632273
/// <returns>The builder (so method calls can be chained).</returns>
2274+
/// <exception cref="System.ArgumentNullException">memberExpression</exception>
22642275
public UpdateBuilder<TDocument> PushEach<TValue>(Expression<Func<TDocument, IEnumerable<TValue>>> memberExpression, PushEachOptions options, IEnumerable<TValue> values)
22652276
{
22662277
if (memberExpression == null)
@@ -2282,9 +2293,12 @@ public UpdateBuilder<TDocument> PushEach<TValue>(Expression<Func<TDocument, IEnu
22822293
/// <summary>
22832294
/// Adds a list of values to the end of the named array element (see $push and $each).
22842295
/// </summary>
2285-
/// <param name="name">The name of the array element.</param>
2296+
/// <typeparam name="TValue">The type of the value.</typeparam>
2297+
/// <param name="memberExpression">The name of the array element.</param>
2298+
/// <param name="options">The options.</param>
22862299
/// <param name="values">The values to add to the end of the array.</param>
22872300
/// <returns>The builder (so method calls can be chained).</returns>
2301+
/// <exception cref="System.ArgumentNullException">memberExpression</exception>
22882302
public UpdateBuilder<TDocument> PushEach<TValue>(Expression<Func<TDocument, IEnumerable<TValue>>> memberExpression, Action<PushEachOptionsBuilder<TValue>> options, IEnumerable<TValue> values)
22892303
{
22902304
if (memberExpression == null)

0 commit comments

Comments
 (0)