CSHARP-938: Added doc comments for the MongoDB.Driver.Core Connections folder.

Author: rstam

src/MongoDB.Driver.Core/Core/Connections/BinaryConnectionFactory.cs

@@ -24,7 +24,7 @@ namespace MongoDB.Driver.Core.Connections
     /// <summary>
     /// Represents a factory of BinaryConnections.
     /// </summary>
-    public class BinaryConnectionFactory : IConnectionFactory
+    internal class BinaryConnectionFactory : IConnectionFactory
     {
         #region static
         // static fields

src/MongoDB.Driver.Core/Core/Connections/BuildInfoResult.cs

@@ -26,18 +26,31 @@
 
 namespace MongoDB.Driver.Core.Connections
 {
+    /// <summary>
+    /// Represents the result of a buildInfo command.
+    /// </summary>
     public sealed class BuildInfoResult : IEquatable<BuildInfoResult>
     {
         // fields
         private readonly BsonDocument _wrapped;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="BuildInfoResult"/> class.
+        /// </summary>
+        /// <param name="wrapped">The wrapped result document.</param>
         public BuildInfoResult(BsonDocument wrapped)
         {
             _wrapped = Ensure.IsNotNull(wrapped, "wrapped");
         }
 
         // properties
+        /// <summary>
+        /// Gets the server version.
+        /// </summary>
+        /// <value>
+        /// The server version.
+        /// </value>
         public SemanticVersion ServerVersion
         {
             get
@@ -46,6 +59,12 @@ public SemanticVersion ServerVersion
             }
         }
 
+        /// <summary>
+        /// Gets the wrapped result document.
+        /// </summary>
+        /// <value>
+        /// The wrapped result document.
+        /// </value>
         public BsonDocument Wrapped
         {
             get
@@ -55,6 +74,7 @@ public BsonDocument Wrapped
         }
 
         // methods
+        /// <inheritdoc/>
         public bool Equals(BuildInfoResult other)
         {
             if (other == null)
@@ -65,11 +85,13 @@ public bool Equals(BuildInfoResult other)
             return _wrapped.Equals(other._wrapped);
         }
 
+        /// <inheritdoc/>
         public override bool Equals(object obj)
         {
             return Equals(obj as BuildInfoResult);
         }
 
+        /// <inheritdoc/>
         public override int GetHashCode()
         {
             return _wrapped.GetHashCode();

src/MongoDB.Driver.Core/Core/Connections/ConnectionDescription.cs

@@ -19,6 +19,9 @@
 
 namespace MongoDB.Driver.Core.Connections
 {
+    /// <summary>
+    /// Represents information describing a connection.
+    /// </summary>
     public sealed class ConnectionDescription : IEquatable<ConnectionDescription>
     {
         // fields
@@ -31,6 +34,12 @@ public sealed class ConnectionDescription : IEquatable<ConnectionDescription>
         private readonly SemanticVersion _serverVersion;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConnectionDescription"/> class.
+        /// </summary>
+        /// <param name="connectionId">The connection identifier.</param>
+        /// <param name="isMasterResult">The issMaster result.</param>
+        /// <param name="buildInfoResult">The buildInfo result.</param>
         public ConnectionDescription(ConnectionId connectionId, IsMasterResult isMasterResult, BuildInfoResult buildInfoResult)
         {
             _connectionId = Ensure.IsNotNull(connectionId, "connectionId");
@@ -44,47 +53,96 @@ public ConnectionDescription(ConnectionId connectionId, IsMasterResult isMasterR
         }
 
         // properties
+        /// <summary>
+        /// Gets the buildInfo result.
+        /// </summary>
+        /// <value>
+        /// The buildInfo result.
+        /// </value>
         public BuildInfoResult BuildInfoResult
         {
             get { return _buildInfoResult; }
         }
 
+        /// <summary>
+        /// Gets the connection identifier.
+        /// </summary>
+        /// <value>
+        /// The connection identifier.
+        /// </value>
         public ConnectionId ConnectionId
         {
             get { return _connectionId; }
         }
 
+        /// <summary>
+        /// Gets the isMaster result.
+        /// </summary>
+        /// <value>
+        /// The isMaster result.
+        /// </value>
         public IsMasterResult IsMasterResult
         {
             get { return _isMasterResult; }
         }
 
+        /// <summary>
+        /// Gets the maximum batch count.
+        /// </summary>
+        /// <value>
+        /// The maximum batch count.
+        /// </value>
         public int MaxBatchCount
         {
             get { return _maxBatchCount; }
         }
 
+        /// <summary>
+        /// Gets the maximum size of a document.
+        /// </summary>
+        /// <value>
+        /// The maximum size of a document.
+        /// </value>
         public int MaxDocumentSize
         {
             get { return _maxDocumentSize; }
         }
 
+        /// <summary>
+        /// Gets the maximum size of a message.
+        /// </summary>
+        /// <value>
+        /// The maximum size of a message.
+        /// </value>
         public int MaxMessageSize
         {
             get { return _maxMessageSize; }
         }
 
+        /// <summary>
+        /// Gets the maximum size of a wire document.
+        /// </summary>
+        /// <value>
+        /// The maximum size of a wire document.
+        /// </value>
         public int MaxWireDocumentSize
         {
             get { return _maxDocumentSize + 16 * 1024; }
         }
 
+        /// <summary>
+        /// Gets the server version.
+        /// </summary>
+        /// <value>
+        /// The server version.
+        /// </value>
         public SemanticVersion ServerVersion
         {
             get { return _serverVersion; }
         }
 
         // methods
+        /// <inheritdoc/>
         public bool Equals(ConnectionDescription other)
         {
             if (other == null)
@@ -98,11 +156,13 @@ public bool Equals(ConnectionDescription other)
                 _isMasterResult.Equals(other._isMasterResult);
         }
 
+        /// <inheritdoc/>
         public override bool Equals(object obj)
         {
             return Equals(obj as ConnectionDescription);
         }
 
+        /// <inheritdoc/>
         public override int GetHashCode()
         {
             return new Hasher()
@@ -112,6 +172,11 @@ public override int GetHashCode()
                 .GetHashCode();
         }
 
+        /// <summary>
+        /// Returns a new instance of ConnectionDescription with a different connection identifier.
+        /// </summary>
+        /// <param name="value">The value.</param>
+        /// <returns>A connection description.</returns>
         public ConnectionDescription WithConnectionId(ConnectionId value)
         {
             return _connectionId.StructurallyEquals(value) ? this : new ConnectionDescription(value, _isMasterResult, _buildInfoResult);

src/MongoDB.Driver.Core/Core/Connections/ConnectionExtensionMethods.cs renamed to src/MongoDB.Driver.Core/Core/Connections/ConnectionExtensions.cs

@@ -29,7 +29,7 @@ namespace MongoDB.Driver.Core.Connections
     /// <summary>
     /// Represents internal IConnection extension methods (used to easily access the IConnectionInternal methods).
     /// </summary>
-    internal static class ConnectionExtensionMethods
+    internal static class ConnectionExtensions
     {
         // static methods
         public static Task SendMessageAsync(this IConnection connection, RequestMessage message, MessageEncoderSettings messageEncoderSettings, CancellationToken cancellationToken)

src/MongoDB.Driver.Core/Core/Connections/ConnectionId.cs

@@ -30,6 +30,9 @@
 
 namespace MongoDB.Driver.Core.Connections
 {
+    /// <summary>
+    /// Represents a connection identifier.
+    /// </summary>
     [Serializable]
     public sealed class ConnectionId : IEquatable<ConnectionId>
     {
@@ -40,11 +43,20 @@ public sealed class ConnectionId : IEquatable<ConnectionId>
         private readonly int _hashCode;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConnectionId"/> class.
+        /// </summary>
+        /// <param name="serverId">The server identifier.</param>
         public ConnectionId(ServerId serverId)
             : this(serverId, IdGenerator<ConnectionId>.GetNextId())
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConnectionId"/> class.
+        /// </summary>
+        /// <param name="serverId">The server identifier.</param>
+        /// <param name="localValue">The local value.</param>
         public ConnectionId(ServerId serverId, int localValue)
         {
             _serverId = Ensure.IsNotNull(serverId, "serverId");
@@ -62,22 +74,41 @@ private ConnectionId(ServerId serverId, int localValue, int serverValue)
         }
 
         // properties
+        /// <summary>
+        /// Gets the server identifier.
+        /// </summary>
+        /// <value>
+        /// The server identifier.
+        /// </value>
         public ServerId ServerId
         {
             get { return _serverId; }
         }
 
+        /// <summary>
+        /// Gets the local value.
+        /// </summary>
+        /// <value>
+        /// The local value.
+        /// </value>
         public int LocalValue
         {
             get { return _localValue; }
         }
 
+        /// <summary>
+        /// Gets the server value.
+        /// </summary>
+        /// <value>
+        /// The server value.
+        /// </value>
         public int? ServerValue
         {
             get { return _serverValue; }
         }
 
         // methods
+        /// <inheritdoc/>
         public bool Equals(ConnectionId other)
         {
             if (other == null)
@@ -90,16 +121,23 @@ public bool Equals(ConnectionId other)
                 _localValue == other._localValue;
         }
 
+        /// <inheritdoc/>
         public override bool Equals(object obj)
         {
             return Equals(obj as ConnectionId);
         }
 
+        /// <inheritdoc/>
         public override int GetHashCode()
         {
             return _hashCode;
         }
 
+        /// <summary>
+        /// Compares all fields of two ConnectionId instances (Equals ignores the ServerValue).
+        /// </summary>
+        /// <param name="other">The other ConnectionId.</param>
+        /// <returns>True if both instances are equal.</returns>
         public bool StructurallyEquals(ConnectionId other)
         {
             if (other == null)
@@ -113,6 +151,7 @@ public bool StructurallyEquals(ConnectionId other)
                 _serverValue == other._serverValue;
         }
 
+        /// <inheritdoc/>
         public override string ToString()
         {
             if (_serverValue == null)
@@ -125,6 +164,11 @@ public override string ToString()
             }
         }
 
+        /// <summary>
+        /// Returns a new instance of ConnectionId with a new server value.
+        /// </summary>
+        /// <param name="serverValue">The server value.</param>
+        /// <returns>A ConnectionId.</returns>
         public ConnectionId WithServerValue(int serverValue)
         {
             return new ConnectionId(_serverId, _localValue, serverValue);