Skip to content

Commit 556bbc4

Browse files
committed
Fix Sandcastle API docs warnings.
1 parent e15a0d6 commit 556bbc4

File tree

8 files changed

+16
-13
lines changed

8 files changed

+16
-13
lines changed

src/MongoDB.Driver.Core/Core/Operations/MapReduceOperationBase.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,7 @@ public bool? Verbose
210210
/// <summary>
211211
/// Creates the command.
212212
/// </summary>
213+
/// <param name="serverVersion">The server version.</param>
213214
/// <returns>The command.</returns>
214215
protected internal virtual BsonDocument CreateCommand(SemanticVersion serverVersion)
215216
{

src/MongoDB.Driver.Core/IAsyncCursorSource.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public static class IAsyncCursorSourceExtensions
6666
/// <summary>
6767
/// Determines whether the cursor returned by a cursor source contains any documents.
6868
/// </summary>
69+
/// <typeparam name="TDocument">The type of the document.</typeparam>
6970
/// <param name="source">The source.</param>
7071
/// <param name="cancellationToken">The cancellation token.</param>
7172
/// <returns>A Task whose result is true if the cursor contains any documents.</returns>

src/MongoDB.Driver.Legacy/Builders/CollectionOptionsBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ public static CollectionOptionsBuilder SetCapped(bool value)
5959
/// <summary>
6060
/// Sets the index options defaults.
6161
/// </summary>
62+
/// <param name="value">The value.</param>
6263
/// <returns>The builder (so method calls can be chained).</returns>
63-
/// <returns></returns>
6464
public static CollectionOptionsBuilder SetIndexOptionDefaults(IndexOptionDefaults value)
6565
{
6666
return new CollectionOptionsBuilder().SetIndexOptionDefaults(value);

src/MongoDB.Driver/AggregateFluent.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ public override IAggregateFluent<TResult> Limit(int limit)
8686
return AppendStage<TResult>(new BsonDocument("$limit", limit));
8787
}
8888

89-
public override IAggregateFluent<TNewResult> Lookup<TForeignCollection, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignCollection> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignCollection, TNewResult> options)
89+
public override IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignDocument, TNewResult> options)
9090
{
91-
options = options ?? new AggregateLookupOptions<TForeignCollection, TNewResult>();
91+
options = options ?? new AggregateLookupOptions<TForeignDocument, TNewResult>();
9292
const string operatorName = "$lookup";
9393
var stage = new DelegatedPipelineStageDefinition<TResult, TNewResult>(
9494
operatorName,
9595
(localSerializer, sr) =>
9696
{
97-
var foreignSerializer = options.ForeignSerializer ?? (localSerializer as IBsonSerializer<TForeignCollection>) ?? sr.GetSerializer<TForeignCollection>();
97+
var foreignSerializer = options.ForeignSerializer ?? (localSerializer as IBsonSerializer<TForeignDocument>) ?? sr.GetSerializer<TForeignDocument>();
9898
var newResultSerializer = options.ResultSerializer ?? (localSerializer as IBsonSerializer<TNewResult>) ?? sr.GetSerializer<TNewResult>();
9999
return new RenderedPipelineStageDefinition<TNewResult>(
100100
operatorName, new BsonDocument(operatorName, new BsonDocument

src/MongoDB.Driver/AggregateFluentBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public abstract class AggregateFluentBase<TResult> : IOrderedAggregateFluent<TRe
4747
public abstract IAggregateFluent<TResult> Limit(int limit);
4848

4949
/// <inheritdoc />
50-
public virtual IAggregateFluent<TNewResult> Lookup<TForeignCollection, TNewResult>(string otherCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignCollection> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignCollection, TNewResult> options)
50+
public virtual IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignDocument, TNewResult> options)
5151
{
5252
throw new NotImplementedException();
5353
}

src/MongoDB.Driver/AggregateUnwindOptions.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 the $unwind aggregation stage.
2222
/// </summary>
23+
/// <typeparam name="TResult">The type of the result.</typeparam>
2324
public class AggregateUnwindOptions<TResult>
2425
{
2526
private FieldDefinition<TResult> _includeArrayIndex;

src/MongoDB.Driver/IAggregateFluent.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>
159159
/// <typeparam name="TNewResult">The type of the new result.</typeparam>
160160
/// <param name="field">The field.</param>
161161
/// <param name="options">The options.</param>
162-
/// The fluent aggregate interface.
162+
/// <returns>The fluent aggregate interface.</returns>
163163
IAggregateFluent<TNewResult> Unwind<TNewResult>(FieldDefinition<TResult> field, AggregateUnwindOptions<TNewResult> options = null);
164164
}
165165

src/MongoDB.Driver/IAggregateFluentExtensions.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public static IAggregateFluent<BsonDocument> Lookup<TResult>(this IAggregateFlue
103103
/// Appends a lookup stage to the pipeline.
104104
/// </summary>
105105
/// <typeparam name="TResult">The type of the result.</typeparam>
106-
/// <typeparam name="TForeignCollection">The type of the foreign collection.</typeparam>
106+
/// <typeparam name="TForeignDocument">The type of the foreign collection.</typeparam>
107107
/// <typeparam name="TNewResult">The type of the new result.</typeparam>
108108
/// <param name="aggregate">The aggregate.</param>
109109
/// <param name="foreignCollection">The foreign collection.</param>
@@ -112,20 +112,20 @@ public static IAggregateFluent<BsonDocument> Lookup<TResult>(this IAggregateFlue
112112
/// <param name="as">The field in the result to place the foreign matches.</param>
113113
/// <param name="options">The options.</param>
114114
/// <returns>The fluent aggregate interface.</returns>
115-
public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignCollection, TNewResult>(this IAggregateFluent<TResult> aggregate,
116-
IMongoCollection<TForeignCollection> foreignCollection,
115+
public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignDocument, TNewResult>(this IAggregateFluent<TResult> aggregate,
116+
IMongoCollection<TForeignDocument> foreignCollection,
117117
Expression<Func<TResult, object>> localField,
118-
Expression<Func<TForeignCollection, object>> foreignField,
118+
Expression<Func<TForeignDocument, object>> foreignField,
119119
Expression<Func<TNewResult, object>> @as,
120-
AggregateLookupOptions<TForeignCollection, TNewResult> options = null)
120+
AggregateLookupOptions<TForeignDocument, TNewResult> options = null)
121121
{
122122
Ensure.IsNotNull(aggregate, nameof(aggregate));
123123
Ensure.IsNotNull(foreignCollection, nameof(foreignCollection));
124124
Ensure.IsNotNull(localField, nameof(localField));
125125
Ensure.IsNotNull(foreignField, nameof(foreignField));
126126
Ensure.IsNotNull(@as, nameof(@as));
127127

128-
options = options ?? new AggregateLookupOptions<TForeignCollection, TNewResult>();
128+
options = options ?? new AggregateLookupOptions<TForeignDocument, TNewResult>();
129129
if (options.ForeignSerializer == null)
130130
{
131131
options.ForeignSerializer = foreignCollection.DocumentSerializer;
@@ -134,7 +134,7 @@ public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignCollection, T
134134
return aggregate.Lookup(
135135
foreignCollection.CollectionNamespace.CollectionName,
136136
new ExpressionFieldDefinition<TResult>(localField),
137-
new ExpressionFieldDefinition<TForeignCollection>(foreignField),
137+
new ExpressionFieldDefinition<TForeignDocument>(foreignField),
138138
new ExpressionFieldDefinition<TNewResult>(@as),
139139
options);
140140
}

0 commit comments

Comments
 (0)