CSHARP-938: Added some missing doc comments in MongoDB.Driver.

Author: rstam

Docs/Api/CSharpDriverDocs.shfbproj

@@ -8,7 +8,7 @@
     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
     <SchemaVersion>2.0</SchemaVersion>
     <ProjectGuid>{cf31cff3-1925-457c-8775-e08bcd39e49f}</ProjectGuid>
-    <SHFBSchemaVersion>1.9.5.0</SHFBSchemaVersion>
+    <SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
     <!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
          Studio adds them anyway -->
     <AssemblyName>Documentation</AssemblyName>
@@ -29,21 +29,22 @@
     <HelpTitle>MongoDB C# Driver API Documentation</HelpTitle>
     <NamespaceSummaries>
       <NamespaceSummaryItem name="MongoDB.Bson" isDocumented="True">The MongoDB.Bson top level namespace and its child namespaces contain the classes for managing Bson data. The top level MongoDB.Bson namespace contains the classes that represent all the basic Bson Types.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of Bson data.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of Bson data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="(global)" isDocumented="False" />
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control Bson serialization/deserialization.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of Bson data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of Bson data are represented in this namespace.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization.Options" isDocumented="True">The MongoDB.Bson.Serialization.Options namespace contains the classes that represent the serialization options for specific types such as DateTime, Document etc.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various Bson and base .Net types</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver.Internal" isDocumented="True">The MongoDB.Driver.Internal namespace contains internal classes used by the driver such as ConnectionPool.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver.Wrappers" isDocumented="True">Wrapped versions of various classes for use in serialization are present in the MongoDB.Driver.Wrappers namespace.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="MongoDB.Driver.Linq" isDocumented="True">The MongoDB.Driver.Linq namespace contains the LINQ related classes.</NamespaceSummaryItem>
-    </NamespaceSummaries>
+<NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of Bson data.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of Bson data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="(global)" isDocumented="False" />
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control Bson serialization/deserialization.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of Bson data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of Bson data are represented in this namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Options" isDocumented="True">The MongoDB.Bson.Serialization.Options namespace contains the classes that represent the serialization options for specific types such as DateTime, Document etc.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various Bson and base .Net types</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.Internal" isDocumented="True">The MongoDB.Driver.Internal namespace contains internal classes used by the driver such as ConnectionPool.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.Wrappers" isDocumented="True">Wrapped versions of various classes for use in serialization are present in the MongoDB.Driver.Wrappers namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.Linq" isDocumented="True">The MongoDB.Driver.Linq namespace contains the LINQ related classes.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.GeoJsonObjectModel" isDocumented="True">Classes used to build GeoJson objects in a type-safe manner.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="MongoDB.Driver.GeoJsonObjectModel.Serializers" isDocumented="True">GeoJson object model serializers.</NamespaceSummaryItem></NamespaceSummaries>
     <CopyrightText>Copyright &amp;#169%3b 2010-2014 MongoDB Inc.</CopyrightText>
     <FeedbackEMailAddress>[email protected]</FeedbackEMailAddress>
     <FeedbackEMailLinkText>MongoDB</FeedbackEMailLinkText>

src/MongoDB.Driver/Builders/QueryBuilder.cs

@@ -346,6 +346,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
         /// <summary>
         /// Tests that the value of the named element is near some location (see $near).
         /// </summary>
+        /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
         /// <param name="name">The name of the element to test.</param>
         /// <param name="point">The point.</param>
         /// <param name="maxDistance">The max distance.</param>
@@ -359,6 +360,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
         /// <summary>
         /// Tests that the value of the named element is near some location (see $near).
         /// </summary>
+        /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
         /// <param name="name">The name of the element to test.</param>
         /// <param name="point">The point.</param>
         /// <param name="maxDistance">The max distance.</param>

src/MongoDB.Driver/Builders/UpdateBuilder.cs

@@ -565,6 +565,7 @@ public static UpdateBuilder PushEach(string name, PushEachOptions options, param
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="T">The type of wrapped value.</typeparam>
         /// <param name="name">The name of the array element.</param>
         /// <param name="values">The values to add to the end of the array.</param>
         /// <returns>The builder (so method calls can be chained).</returns>
@@ -1529,6 +1530,7 @@ public UpdateBuilder PushEach(string name, PushEachOptions options, params BsonV
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="T">The type of wrapped value.</typeparam>
         /// <param name="name">The name of the array element.</param>
         /// <param name="values">The values to add to the end of the array.</param>
         /// <returns>The builder (so method calls can be chained).</returns>
@@ -1542,6 +1544,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, IEnumerable<T> values)
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="T">The type of wrapped value.</typeparam>
         /// <param name="name">The name of the array element.</param>
         /// <param name="values">The values to add to the end of the array.</param>
         /// <returns>The builder (so method calls can be chained).</returns>
@@ -1555,6 +1558,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, params T[] values)
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="T">The type of wrapped value.</typeparam>
         /// <param name="name">The name of the array element.</param>
         /// <param name="args">The args.</param>
         /// <param name="values">The values to add to the end of the array.</param>
@@ -1570,6 +1574,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions args, IEnum
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="T">The type of wrapped value.</typeparam>
         /// <param name="name">The name of the array element.</param>
         /// <param name="args">The args.</param>
         /// <param name="values">The values to add to the end of the array.</param>
@@ -2861,6 +2866,7 @@ public UpdateBuilder<TDocument> PushAll<TValue>(Expression<Func<TDocument, IEnum
         /// <summary>
         /// Adds a list of values to the end of the named array element (see $push and $each).
         /// </summary>
+        /// <typeparam name="TValue">The type of the value.</typeparam>
         /// <param name="memberExpression">The name of the array element.</param>
         /// <param name="values">The values to add to the end of the array.</param>
         /// <returns>The builder (so method calls can be chained).</returns>

src/MongoDB.Driver/CommandResults/CommandResultSerializer.cs

@@ -25,6 +25,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// Represents a serializer for a CommandResult.
     /// </summary>
+    /// <typeparam name="TCommandResult">The type of the command result.</typeparam>
     public class CommandResultSerializer<TCommandResult> : SerializerBase<TCommandResult> where TCommandResult : CommandResult
     {
         /// <summary>

src/MongoDB.Driver/CommandResults/DistinctCommandResult.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// Represents the result of a command (there are also subclasses for various commands).
     /// </summary>
+    /// <typeparam name="TValue">The type of the value.</typeparam>
     [Serializable]
     [BsonSerializer(typeof(DistinctCommandResultSerializer<>))]
     public class DistinctCommandResult<TValue> : CommandResult

src/MongoDB.Driver/DeleteOneModel.cs

@@ -26,15 +26,16 @@ namespace MongoDB.Driver
     /// <summary>
     /// Model for deleting a single document.
     /// </summary>
+    /// <typeparam name="TDocument">The type of the document.</typeparam>
     [Serializable]
-    public sealed class DeleteOneModel<T> : WriteModel<T>
+    public sealed class DeleteOneModel<TDocument> : WriteModel<TDocument>
     {
         // fields
         private readonly object _filter;
 
         // constructors
         /// <summary>
-        /// Initializes a new instance of the <see cref="DeleteOneModel{T}"/> class.
+        /// Initializes a new instance of the <see cref="DeleteOneModel{TDocument}"/> class.
         /// </summary>
         /// <param name="filter">The filter.</param>
         public DeleteOneModel(object filter)

src/MongoDB.Driver/FindOneAndDeleteOptions.cs

@@ -25,6 +25,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// Options for a findAndModify command to delete an object.
     /// </summary>
+    /// <typeparam name="TResult">The type of the result.</typeparam>
     public class FindOneAndDeleteOptions<TResult>
     {
         // fields

src/MongoDB.Driver/FindOneAndUpdateOptions.cs

@@ -25,6 +25,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// Options for a findAndModify command to update an object.
     /// </summary>
+    /// <typeparam name="TResult">The type of the result.</typeparam>
     public class FindOneAndUpdateOptions<TResult>
     {
         // fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonLineStringCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonLineStringCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonLineStringCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonLineStringCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonLinearRingCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonLinearRingCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonLinearRingCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonLinearRingCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonMultiLineStringCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonMultiLineStringCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonMultiLineStringCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonMultiLineStringCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonMultiPointCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonMultiPointCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonMultiPointCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonMultiPointCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonMultiPolygonCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonMultiPolygonCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonMultiPolygonCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonMultiPolygonCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/GeoJsonObjectModel/Serializers/GeoJsonPolygonCoordinatesSerializer.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver.GeoJsonObjectModel.Serializers
     /// <summary>
     /// Represents a serializer for a GeoJsonPolygonCoordinates value.
     /// </summary>
+    /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
     public class GeoJsonPolygonCoordinatesSerializer<TCoordinates> : ClassSerializerBase<GeoJsonPolygonCoordinates<TCoordinates>> where TCoordinates : GeoJsonCoordinates
     {
         // private fields

src/MongoDB.Driver/IAggregateFluent.cs

@@ -141,6 +141,7 @@ public interface IAggregateFluent<TDocument, TResult> : IAsyncCursorSource<TResu
         /// <summary>
         /// Appends an unwind stage to the pipeline.
         /// </summary>
+        /// <typeparam name="TNewResult">The type of the new result.</typeparam>
         /// <param name="fieldName">The name of the field to unwind.</param>
         /// <returns>The fluent aggregate interface.</returns>
         IAggregateFluent<TDocument, TNewResult> Unwind<TNewResult>(string fieldName);

src/MongoDB.Driver/IMongoIndexManager.cs

@@ -23,6 +23,7 @@ namespace MongoDB.Driver
     /// <summary>
     /// An interface representing methods used to create, delete and modify indexes.
     /// </summary>
+    /// <typeparam name="TDocument">The type of the document.</typeparam>
     public interface IMongoIndexManager<TDocument>
     {
         /// <summary>

src/MongoDB.Driver/Linq/LinqToMongo.cs

@@ -55,20 +55,22 @@ public static bool ContainsAny<TSource>(this IEnumerable<TSource> source, IEnume
         /// <summary>
         /// Returns an explanation of how the query was executed (instead of the results).
         /// </summary>
+        /// <typeparam name="TSource">The type of the elements of source.</typeparam>
         /// <param name="source">The LINQ query to explain.</param>
         /// <returns>An explanation of thow the query was executed.</returns>
-        public static BsonDocument Explain<T>(this IQueryable<T> source)
+        public static BsonDocument Explain<TSource>(this IQueryable<TSource> source)
         {
             return Explain(source, false);
         }
 
         /// <summary>
         /// Returns an explanation of how the query was executed (instead of the results).
         /// </summary>
+        /// <typeparam name="TSource">The type of the elements of source.</typeparam>
         /// <param name="source">The LINQ query to explain</param>
         /// <param name="verbose">Whether the explanation should contain more details.</param>
         /// <returns>An explanation of thow the query was executed.</returns>
-        public static BsonDocument Explain<T>(this IQueryable<T> source, bool verbose)
+        public static BsonDocument Explain<TSource>(this IQueryable<TSource> source, bool verbose)
         {
             var queryProvider = source.Provider as MongoQueryProvider;
             if (queryProvider == null)

src/MongoDB.Driver/MongoCollection.cs

@@ -269,6 +269,7 @@ public virtual WriteConcernResult CreateIndex(params string[] keyNames)
         /// <summary>
         /// Returns the distinct values for a given field.
         /// </summary>
+        /// <typeparam name="TValue">The type of the value.</typeparam>
         /// <param name="args">The args.</param>
         /// <returns>The distint values of the field.</returns>
         public IEnumerable<TValue> Distinct<TValue>(DistinctArgs args)