Skip to content

Commit 91ee6b2

Browse files
committed
Fix doc comment warnings.
1 parent 6577d6c commit 91ee6b2

File tree

12 files changed

+21
-7
lines changed

12 files changed

+21
-7
lines changed

src/MongoDB.Bson/ObjectModel/Decimal128.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -627,9 +627,9 @@ public static ulong GetSignificandLowBits(Decimal128 d)
627627
/// <summary>
628628
/// Gets a value indicating whether this instance is zero.
629629
/// </summary>
630-
/// <value>
630+
/// <returns>
631631
/// <c>true</c> if this instance is zero; otherwise, <c>false</c>.
632-
/// </value>
632+
/// </returns>
633633
public static bool IsZero(Decimal128 d)
634634
{
635635
if (Flags.IsFirstForm(d._highBits) && GetSignificand(d).Equals(UInt128.Zero))

src/MongoDB.Driver.Core/Collation.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ public override string ToString()
461461
/// <param name="maxVariable">The new maximum variable.</param>
462462
/// <param name="normalization">The new normalization.</param>
463463
/// <param name="backwards">The new backwards.</param>
464-
/// <returns></returns>
464+
/// <returns>A new Collation instance.</returns>
465465
public Collation With(
466466
Optional<string> locale = default(Optional<string>),
467467
Optional<bool?> caseLevel = default(Optional<bool?>),

src/MongoDB.Driver.Core/Core/Misc/CommandsThatWriteAcceptWriteConcernFeature.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ public CommandsThatWriteAcceptWriteConcernFeature(string name, SemanticVersion f
3636
/// </summary>
3737
/// <param name="serverVersion">The server version.</param>
3838
/// <param name="value">The write concern value.</param>
39+
/// <returns>Whether the write concern should be sent to the server.</returns>
3940
public bool ShouldSendWriteConcern(SemanticVersion serverVersion, WriteConcern value)
4041
{
4142
return value != null && !value.IsServerDefault && base.IsSupported(serverVersion);

src/MongoDB.Driver.Core/ReadPreference.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ public ReadPreference With(IEnumerable<TagSet> tagSets)
240240
/// <summary>
241241
/// Returns a new instance of ReadPreference with some values changed.
242242
/// </summary>
243+
/// <param name="maxStaleness">The maximum staleness.</param>
243244
/// <returns>A new instance of ReadPreference.</returns>
244245
public ReadPreference With(TimeSpan? maxStaleness)
245246
{

src/MongoDB.Driver.Legacy/MongoDatabase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ public virtual CommandResult CreateCollection(string collectionName, IMongoColle
296296
/// <param name="viewOn">The name of the collection that the view is on.</param>
297297
/// <param name="pipeline">The pipeline.</param>
298298
/// <param name="options">The options.</param>
299-
/// <returns></returns>
299+
/// <returns>A CommandResult.</returns>
300300
public virtual CommandResult CreateView(string viewName, string viewOn, IEnumerable<BsonDocument> pipeline, IMongoCreateViewOptions options)
301301
{
302302
if (viewName == null)

src/MongoDB.Driver/AggregateBucketOptions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ namespace MongoDB.Driver
1818
/// <summary>
1919
/// Represents options for the Bucket method.
2020
/// </summary>
21+
/// <typeparam name="TValue">The type of the value.</typeparam>
2122
public class AggregateBucketOptions<TValue>
2223
{
2324
/// <summary>

src/MongoDB.Driver/AggregateFacetResult.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ internal AggregateFacetResult(string name)
4141
/// <summary>
4242
/// Gets the output of the facet.
4343
/// </summary>
44+
/// <typeparam name="TOutput">The type of the output documents.</typeparam>
45+
/// <returns>The output of the facet.</returns>
4446
public IReadOnlyList<TOutput> Output<TOutput>()
4547
{
4648
return ((AggregateFacetResult<TOutput>)this).Output;

src/MongoDB.Driver/AggregateSortByCountResult.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ namespace MongoDB.Driver
2020
/// <summary>
2121
/// Result type for the aggregate $sortByCount stage.
2222
/// </summary>
23+
/// <typeparam name="TId">The type of the identifier.</typeparam>
2324
public sealed class AggregateSortByCountResult<TId>
2425
{
2526
private long _count;

src/MongoDB.Driver/CreateViewOptions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ namespace MongoDB.Driver
2020
/// <summary>
2121
/// Options for creating a view.
2222
/// </summary>
23+
/// <typeparam name="TDocument">The type of the documents.</typeparam>
2324
public class CreateViewOptions<TDocument>
2425
{
2526
// fields

src/MongoDB.Driver/IAggregateFluent.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ public interface IOrderedAggregateFluent<TResult> : IAggregateFluent<TResult>
299299
/// Combines the current sort definition with an additional sort definition.
300300
/// </summary>
301301
/// <param name="newSort">The new sort.</param>
302-
/// The fluent aggregate interface.
302+
/// <returns>The fluent aggregate interface.</returns>
303303
IOrderedAggregateFluent<TResult> ThenBy(SortDefinition<TResult> newSort);
304304
}
305305
}

0 commit comments

Comments
 (0)