xmldocs on IConnectionConfigurationValues

Author: Mpdreamz

src/Elasticsearch.Net/Connection/Configuration/IConnectionConfigurationValues.cs

@@ -8,26 +8,94 @@ namespace Elasticsearch.Net.Connection
 {
 	public interface IConnectionConfigurationValues
 	{
+		/// <summary>
+		/// The connection pool to use when talking with elasticsearch
+		/// </summary>
 		IConnectionPool ConnectionPool { get; }
 
+		/// <summary>
+		/// When set to a value > 0, this will signal the IConnection what the maximum 
+		/// concurrent connections is, NEST favors IOCP ports over threads but in multi tenant 
+		/// situations this may still proof a valuable throttle
+		/// </summary>
 		int MaximumAsyncConnections { get; }
+		
+		/// <summary>
+		/// The time out for calls to elasticsearch
+		/// </summary>
 		int Timeout { get; }
+
+		/// <summary>
+		/// The timeout to use for ping calls that are issues to check whether a node is up or not.
+		/// </summary>
 		int? PingTimeout { get; }
+		
+		/// <summary>
+		/// The time to put dead nodes out of rotation (this will be multiplied by the number of times they've been dead)
+		/// </summary>
 		int? DeadTimeout { get; }
+		
+		/// <summary>
+		/// The maximum ammount of time a node is allowed to marked dead
+		/// </summary>
 		int? MaxDeadTimeout { get; }
+		
+		/// <summary>
+		/// When a retryable exception occurs or status code is returned this controls the maximum
+		/// amount of times we should retry the call to elasticsearch
+		/// </summary>
 		int? MaxRetries { get; }
+
+		/// <summary>
+		/// This signals that we do not want to send initial pings to unknown/previously dead nodes
+		/// and just send the call straightaway
+		/// </summary>
 		bool DisablePings { get; }
+
+		/// <summary>
+		/// When set signals elasticsearch to respond with compressed responses
+		/// </summary>
 		bool EnableCompressedResponses { get; }
 
+		/// <summary>
+		/// When set will force all connections through this proxy
+		/// </summary>
 		string ProxyAddress { get; }
 		string ProxyUsername { get; }
 		string ProxyPassword { get; }
-
+		
+		/// <summary>
+		/// When set connection information is written on the trace output 
+		/// </summary>
 		bool TraceEnabled { get; }
+
+		/// <summary>
+		/// When enabled, the client will gather as many interesting metrics as it can.
+		/// </summary>
 		bool MetricsEnabled { get; }
+
+		/// <summary>
+		/// Forces elasticsearch to send pretty json responses over the wire
+		/// </summary>
 		bool UsesPrettyResponses { get; }
+
+		/// <summary>
+		/// Instructs the client to always keep a raw copy of the returned bytes on the response
+		/// , useful for debugging purposses.
+		/// </summary>
 		bool KeepRawResponse { get; }
+
+		/// <summary>
+		/// Disabled proxy detection on the webrequest, in some cases this may speed up the first connection
+		/// your appdomain makes, in other cases it will actually increase the time for the first connection.
+		/// No silver bullet! use with care!
+		/// </summary>
 		bool DisableAutomaticProxyDetection { get; }
+
+		/// <summary>
+		/// By default the client disabled http pipelining as elasticsearch did not support it until 1.4
+		/// If you are using a version of elasticsearch >= 1.4 you can enable this and expect some performance gains
+		/// </summary>
 		bool HttpPipeliningEnabled { get; }
 
 		/// <summary>

src/Elasticsearch.Net/Connection/IConnection.cs

@@ -28,6 +28,7 @@ public interface IConnection
 
 		Task<ElasticsearchResponse<Stream>> Delete(Uri uri, byte[] data, IRequestConfiguration requestConfiguration = null);
 		ElasticsearchResponse<Stream> DeleteSync(Uri uri, byte[] data, IRequestConfiguration requestConfiguration = null);
-
+		
+		
 	}
 }