Skip to content

Commit

Permalink
Fix Sandcastle API docs warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
rstam committed Dec 7, 2015
1 parent e15a0d6 commit 556bbc4
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ public bool? Verbose
/// <summary>
/// Creates the command.
/// </summary>
/// <param name="serverVersion">The server version.</param>
/// <returns>The command.</returns>
protected internal virtual BsonDocument CreateCommand(SemanticVersion serverVersion)
{
Expand Down
1 change: 1 addition & 0 deletions src/MongoDB.Driver.Core/IAsyncCursorSource.cs
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ public static class IAsyncCursorSourceExtensions
/// <summary>
/// Determines whether the cursor returned by a cursor source contains any documents.
/// </summary>
/// <typeparam name="TDocument">The type of the document.</typeparam>
/// <param name="source">The source.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A Task whose result is true if the cursor contains any documents.</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ public static CollectionOptionsBuilder SetCapped(bool value)
/// <summary>
/// Sets the index options defaults.
/// </summary>
/// <param name="value">The value.</param>
/// <returns>The builder (so method calls can be chained).</returns>
/// <returns></returns>
public static CollectionOptionsBuilder SetIndexOptionDefaults(IndexOptionDefaults value)
{
return new CollectionOptionsBuilder().SetIndexOptionDefaults(value);
Expand Down
6 changes: 3 additions & 3 deletions src/MongoDB.Driver/AggregateFluent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ public override IAggregateFluent<TResult> Limit(int limit)
return AppendStage<TResult>(new BsonDocument("$limit", limit));
}

public override IAggregateFluent<TNewResult> Lookup<TForeignCollection, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignCollection> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignCollection, TNewResult> options)
public override IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignDocument, TNewResult> options)
{
options = options ?? new AggregateLookupOptions<TForeignCollection, TNewResult>();
options = options ?? new AggregateLookupOptions<TForeignDocument, TNewResult>();
const string operatorName = "$lookup";
var stage = new DelegatedPipelineStageDefinition<TResult, TNewResult>(
operatorName,
(localSerializer, sr) =>
{
var foreignSerializer = options.ForeignSerializer ?? (localSerializer as IBsonSerializer<TForeignCollection>) ?? sr.GetSerializer<TForeignCollection>();
var foreignSerializer = options.ForeignSerializer ?? (localSerializer as IBsonSerializer<TForeignDocument>) ?? sr.GetSerializer<TForeignDocument>();
var newResultSerializer = options.ResultSerializer ?? (localSerializer as IBsonSerializer<TNewResult>) ?? sr.GetSerializer<TNewResult>();
return new RenderedPipelineStageDefinition<TNewResult>(
operatorName, new BsonDocument(operatorName, new BsonDocument
Expand Down
2 changes: 1 addition & 1 deletion src/MongoDB.Driver/AggregateFluentBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public abstract class AggregateFluentBase<TResult> : IOrderedAggregateFluent<TRe
public abstract IAggregateFluent<TResult> Limit(int limit);

/// <inheritdoc />
public virtual IAggregateFluent<TNewResult> Lookup<TForeignCollection, TNewResult>(string otherCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignCollection> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignCollection, TNewResult> options)
public virtual IAggregateFluent<TNewResult> Lookup<TForeignDocument, TNewResult>(string foreignCollectionName, FieldDefinition<TResult> localField, FieldDefinition<TForeignDocument> foreignField, FieldDefinition<TNewResult> @as, AggregateLookupOptions<TForeignDocument, TNewResult> options)
{
throw new NotImplementedException();
}
Expand Down
1 change: 1 addition & 0 deletions src/MongoDB.Driver/AggregateUnwindOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ namespace MongoDB.Driver
/// <summary>
/// Options for the $unwind aggregation stage.
/// </summary>
/// <typeparam name="TResult">The type of the result.</typeparam>
public class AggregateUnwindOptions<TResult>
{
private FieldDefinition<TResult> _includeArrayIndex;
Expand Down
2 changes: 1 addition & 1 deletion src/MongoDB.Driver/IAggregateFluent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public interface IAggregateFluent<TResult> : IAsyncCursorSource<TResult>
/// <typeparam name="TNewResult">The type of the new result.</typeparam>
/// <param name="field">The field.</param>
/// <param name="options">The options.</param>
/// The fluent aggregate interface.
/// <returns>The fluent aggregate interface.</returns>
IAggregateFluent<TNewResult> Unwind<TNewResult>(FieldDefinition<TResult> field, AggregateUnwindOptions<TNewResult> options = null);
}

Expand Down
14 changes: 7 additions & 7 deletions src/MongoDB.Driver/IAggregateFluentExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public static IAggregateFluent<BsonDocument> Lookup<TResult>(this IAggregateFlue
/// Appends a lookup stage to the pipeline.
/// </summary>
/// <typeparam name="TResult">The type of the result.</typeparam>
/// <typeparam name="TForeignCollection">The type of the foreign collection.</typeparam>
/// <typeparam name="TForeignDocument">The type of the foreign collection.</typeparam>
/// <typeparam name="TNewResult">The type of the new result.</typeparam>
/// <param name="aggregate">The aggregate.</param>
/// <param name="foreignCollection">The foreign collection.</param>
Expand All @@ -112,20 +112,20 @@ public static IAggregateFluent<BsonDocument> Lookup<TResult>(this IAggregateFlue
/// <param name="as">The field in the result to place the foreign matches.</param>
/// <param name="options">The options.</param>
/// <returns>The fluent aggregate interface.</returns>
public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignCollection, TNewResult>(this IAggregateFluent<TResult> aggregate,
IMongoCollection<TForeignCollection> foreignCollection,
public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignDocument, TNewResult>(this IAggregateFluent<TResult> aggregate,
IMongoCollection<TForeignDocument> foreignCollection,
Expression<Func<TResult, object>> localField,
Expression<Func<TForeignCollection, object>> foreignField,
Expression<Func<TForeignDocument, object>> foreignField,
Expression<Func<TNewResult, object>> @as,
AggregateLookupOptions<TForeignCollection, TNewResult> options = null)
AggregateLookupOptions<TForeignDocument, TNewResult> options = null)
{
Ensure.IsNotNull(aggregate, nameof(aggregate));
Ensure.IsNotNull(foreignCollection, nameof(foreignCollection));
Ensure.IsNotNull(localField, nameof(localField));
Ensure.IsNotNull(foreignField, nameof(foreignField));
Ensure.IsNotNull(@as, nameof(@as));

options = options ?? new AggregateLookupOptions<TForeignCollection, TNewResult>();
options = options ?? new AggregateLookupOptions<TForeignDocument, TNewResult>();
if (options.ForeignSerializer == null)
{
options.ForeignSerializer = foreignCollection.DocumentSerializer;
Expand All @@ -134,7 +134,7 @@ public static IAggregateFluent<TNewResult> Lookup<TResult, TForeignCollection, T
return aggregate.Lookup(
foreignCollection.CollectionNamespace.CollectionName,
new ExpressionFieldDefinition<TResult>(localField),
new ExpressionFieldDefinition<TForeignCollection>(foreignField),
new ExpressionFieldDefinition<TForeignDocument>(foreignField),
new ExpressionFieldDefinition<TNewResult>(@as),
options);
}
Expand Down

0 comments on commit 556bbc4

Please sign in to comment.