Fix property ordering. Inherit doc comments.

Author: mdaigle

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/ChannelDbConnectionPool.cs

@@ -19,70 +19,100 @@ namespace Microsoft.Data.SqlClient.ConnectionPool
     /// </summary>
     internal sealed class ChannelDbConnectionPool : IDbConnectionPool
     {
-        public int Id => throw new NotImplementedException();
+        #region Properties
+        /// <inheritdoc />
+        public ConcurrentDictionary<DbConnectionPoolAuthenticationContextKey, DbConnectionPoolAuthenticationContext> AuthenticationContexts => throw new NotImplementedException();
 
-        public DbConnectionPoolState State { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+        /// <inheritdoc />
+        public DbConnectionFactory ConnectionFactory => throw new NotImplementedException();
 
+        /// <inheritdoc />
         public int Count => throw new NotImplementedException();
 
-        public DbConnectionFactory ConnectionFactory => throw new NotImplementedException();
-
+        /// <inheritdoc />
         public bool ErrorOccurred => throw new NotImplementedException();
 
-        public TimeSpan LoadBalanceTimeout => throw new NotImplementedException();
+        /// <inheritdoc />
+        public int Id => throw new NotImplementedException();
 
+        /// <inheritdoc />
         public DbConnectionPoolIdentity Identity => throw new NotImplementedException();
 
+        /// <inheritdoc />
         public bool IsRunning => throw new NotImplementedException();
 
+        /// <inheritdoc />
+        public TimeSpan LoadBalanceTimeout => throw new NotImplementedException();
+
+        /// <inheritdoc />
         public DbConnectionPoolGroup PoolGroup => throw new NotImplementedException();
 
+        /// <inheritdoc />
         public DbConnectionPoolGroupOptions PoolGroupOptions => throw new NotImplementedException();
 
+        /// <inheritdoc />
         public DbConnectionPoolProviderInfo ProviderInfo => throw new NotImplementedException();
 
-        public ConcurrentDictionary<DbConnectionPoolAuthenticationContextKey, DbConnectionPoolAuthenticationContext> AuthenticationContexts => throw new NotImplementedException();
+        /// <inheritdoc />
+        public DbConnectionPoolState State { 
+            get => throw new NotImplementedException(); 
+            set => throw new NotImplementedException(); 
+        }
 
+        /// <inheritdoc />
         public bool UseLoadBalancing => throw new NotImplementedException();
+        #endregion
+
+
 
+        #region Methods
+        /// <inheritdoc />
         public void Clear()
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public void PutObjectFromTransactedPool(DbConnectionInternal obj)
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public DbConnectionInternal ReplaceConnection(DbConnection owningObject, DbConnectionOptions userOptions, DbConnectionInternal oldConnection)
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public void ReturnInternalConnection(DbConnectionInternal obj, object owningObject)
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public void Shutdown()
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public void Startup()
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public void TransactionEnded(Transaction transaction, DbConnectionInternal transactedObject)
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
         public bool TryGetConnection(DbConnection owningObject, TaskCompletionSource<DbConnectionInternal> taskCompletionSource, DbConnectionOptions userOptions, out DbConnectionInternal connection)
         {
             throw new NotImplementedException();
         }
+        #endregion
     }
 }

src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/IDbConnectionPool.cs

@@ -21,37 +21,31 @@ internal interface IDbConnectionPool
     {
         #region Properties
         /// <summary>
-        /// An id that uniqely identifies this connection pool.
+        /// Gets the authentication contexts cached by the pool.
         /// </summary>
-        int Id { get; }
+        ConcurrentDictionary<DbConnectionPoolAuthenticationContextKey, DbConnectionPoolAuthenticationContext> AuthenticationContexts { get; }
 
         /// <summary>
-        /// The current state of the connection pool.
+        /// Gets the factory used to create database connections.
         /// </summary>
-        DbConnectionPoolState State { get; set; }
+        DbConnectionFactory ConnectionFactory { get; }
 
         /// <summary>
         /// The number of connections currently managed by the pool.
         /// May be larger than the number of connections currently sitting idle in the pool.
         /// </summary>
         int Count { get; }
 
-        /// <summary>
-        /// Gets the factory used to create database connections.
-        /// </summary>
-        DbConnectionFactory ConnectionFactory { get; }
-
         /// <summary>
         /// Indicates whether an error has occurred in the pool.
         /// Primarily used to support the pool blocking period feature.
         /// </summary>
         bool ErrorOccurred { get; }
 
         /// <summary>
-        /// Gets the duration of time to wait before reassigning a connection to a different server in a load-balanced
-        /// environment.
+        /// An id that uniqely identifies this connection pool.
         /// </summary>
-        TimeSpan LoadBalanceTimeout { get; }
+        int Id { get; }
 
         /// <summary>
         /// Gets the identity used by the connection pool when establishing connections.
@@ -63,6 +57,12 @@ internal interface IDbConnectionPool
         /// </summary>
         bool IsRunning { get; }
 
+        /// <summary>
+        /// Gets the duration of time to wait before reassigning a connection to a different server in a load-balanced
+        /// environment.
+        /// </summary>
+        TimeSpan LoadBalanceTimeout { get; }
+
         /// <summary>
         /// Gets a reference to the connection pool group that this pool belongs to.
         /// </summary>
@@ -79,9 +79,9 @@ internal interface IDbConnectionPool
         DbConnectionPoolProviderInfo ProviderInfo { get; }
 
         /// <summary>
-        /// Gets the authentication contexts cached by the pool.
+        /// The current state of the connection pool.
         /// </summary>
-        ConcurrentDictionary<DbConnectionPoolAuthenticationContextKey, DbConnectionPoolAuthenticationContext> AuthenticationContexts { get; }
+        DbConnectionPoolState State { get; set; }
 
         /// <summary>
         /// Indicates whether the connection pool is using load balancing.
@@ -103,7 +103,7 @@ internal interface IDbConnectionPool
         /// The internal connection will be set on completion source rather than passed out via the out parameter.</param>
         /// <param name="userOptions">The user options to use if a new connection must be opened.</param>
         /// <param name="connection">The retrieved connection will be passed out via this parameter.</param>
-        /// <returns>Returns true if a connection was set in the out parameter, otherwise returns false.</returns>
+        /// <returns>True if a connection was set in the out parameter, otherwise returns false.</returns>
         bool TryGetConnection(DbConnection owningObject, TaskCompletionSource<DbConnectionInternal> taskCompletionSource, DbConnectionOptions userOptions, out DbConnectionInternal connection);
 
         /// <summary>
@@ -112,7 +112,7 @@ internal interface IDbConnectionPool
         /// <param name="owningObject">The connection whos internal connection should be replaced.</param>
         /// <param name="userOptions">The user options to use if a new connection must be opened.</param>
         /// <param name="oldConnection">The internal connection currently associated with the owning object.</param>
-        /// <returns></returns>
+        /// <returns>A reference to the new DbConnectionInternal.</returns>
         DbConnectionInternal ReplaceConnection(DbConnection owningObject, DbConnectionOptions userOptions, DbConnectionInternal oldConnection);
 
         /// <summary>