Document timeout value unit.

 - Fixes #769 ( NH-3922 )

Author: fredericDelaporte

src/NHibernate/Async/Driver/IResultSetsCommand.cs

@@ -17,6 +17,12 @@ namespace NHibernate.Driver
 	using System.Threading;
 	public partial interface IResultSetsCommand
 	{
+		/// <summary>
+		/// Get a data reader for this multiple result sets command.
+		/// </summary>
+		/// <param name="commandTimeout">The timeout in seconds for the underlying ADO.NET query.</param>
+		/// <param name="cancellationToken">A cancellation token that can be used to cancel the work</param>
+		/// <returns>A data reader.</returns>
 		Task<DbDataReader> GetReaderAsync(int? commandTimeout, CancellationToken cancellationToken);
 	}
-}
+}

src/NHibernate/Cfg/Environment.cs

@@ -193,6 +193,9 @@ public static string Version
 
 		// NHibernate-specific properties
 		public const string PrepareSql = "prepare_sql";
+		/// <summary>
+		/// Set the default timeout in seconds for ADO.NET queries.
+		/// </summary>
 		public const string CommandTimeout = "command_timeout";
 
 		public const string PropertyBytecodeProvider = "bytecode.provider";

src/NHibernate/Cfg/Loquacious/IDbIntegrationConfigurationProperties.cs

@@ -29,6 +29,9 @@ public interface IDbIntegrationConfigurationProperties
 		void TransactionFactory<TFactory>() where TFactory : ITransactionFactory;
 
 		bool PrepareCommands { set; }
+		/// <summary>
+		/// Set the default timeout in seconds for ADO.NET queries.
+		/// </summary>
 		byte Timeout { set; }
 		void ExceptionConverter<TExceptionConverter>() where TExceptionConverter : ISQLExceptionConverter;
 		bool AutoCommentSql { set; }
@@ -39,4 +42,4 @@ public interface IDbIntegrationConfigurationProperties
 
 		void QueryModelRewriterFactory<TFactory>() where TFactory : IQueryModelRewriterFactory;
 	}
-}
+}

src/NHibernate/Cfg/Loquacious/INamedQueryDefinitionBuilder.cs

@@ -8,6 +8,9 @@ public interface INamedQueryDefinitionBuilder
 		bool IsCacheable { get; set; }
 		string CacheRegion { get; set; }
 		int FetchSize { get; set; }
+		/// <summary>
+		/// The timeout in seconds for the underlying ADO.NET query.
+		/// </summary>
 		int Timeout { get; set; }
 		FlushMode FlushMode { get; set; }
 		string Query { get; set; }
@@ -76,4 +79,4 @@ public NamedQueryDefinition Build()
 			return new NamedQueryDefinition(Query, IsCacheable, CacheRegion, Timeout, FetchSize, FlushMode, CacheMode ,IsReadOnly, Comment, new Dictionary<string, string>(1));
 		}
 	}
-}
+}

src/NHibernate/Driver/IResultSetsCommand.cs

@@ -8,6 +8,11 @@ public partial interface IResultSetsCommand
 		void Append(ISqlCommand command);
 		bool HasQueries { get; }
 		SqlString Sql { get; }
+		/// <summary>
+		/// Get a data reader for this multiple result sets command.
+		/// </summary>
+		/// <param name="commandTimeout">The timeout in seconds for the underlying ADO.NET query.</param>
+		/// <returns>A data reader.</returns>
 		DbDataReader GetReader(int? commandTimeout);
 	}
-}
+}

src/NHibernate/Engine/RowSelection.cs

@@ -42,10 +42,10 @@ public int MaxRows
 		}
 
 		/// <summary>
-		/// Gets or Sets the Timeout of the Query
+		/// The timeout in seconds for the underlying ADO.NET query.
 		/// </summary>
-		/// <value>The Query Timeout</value>
-		/// <remarks>Defaults to NoValue unless specifically set.</remarks>
+		/// <value>The query timeout in seconds.</value>
+		/// <remarks>Defaults to <see cref="NoValue" /> unless specifically set.</remarks>
 		public int Timeout
 		{
 			get { return timeout; }
@@ -63,4 +63,4 @@ public bool DefinesLimits
 			get { return maxRows != NoValue || firstRow > 0; }
 		}
 	}
-}
+}

src/NHibernate/ICriteria.cs

@@ -246,10 +246,10 @@ public partial interface ICriteria : ICloneable
 		ICriteria SetFetchSize(int fetchSize);
 
 		/// <summary>
-		/// Set a timeout for the underlying ADO.NET query
+		/// Set a timeout for the underlying ADO.NET query.
 		/// </summary>
-		/// <param name="timeout"></param>
-		/// <returns></returns>
+		/// <param name="timeout">The timeout in seconds.</param>
+		/// <returns><see langword="this" /> (for method chaining).</returns>
 		ICriteria SetTimeout(int timeout);
 
 		/// <summary>

src/NHibernate/IDetachedQuery.cs

@@ -48,9 +48,10 @@ public interface IDetachedQuery
 		IDetachedQuery SetReadOnly(bool readOnly);
 
 		/// <summary>
-		/// The timeout for the underlying ADO query
+		/// Set a timeout for the underlying ADO.NET query.
 		/// </summary>
-		/// <param name="timeout"></param>
+		/// <param name="timeout">The timeout in seconds.</param>
+		/// <returns><see langword="this" /> (for method chaining).</returns>
 		IDetachedQuery SetTimeout(int timeout);
 
 		/// <summary> Set a fetch size for the underlying ADO query.</summary>

src/NHibernate/IMultiCriteria.cs

@@ -161,8 +161,11 @@ public static class MultiCriteriaExtensions
 	{
 		//6.0 TODO: Convert to interface method
 		/// <summary>
-		/// Set a timeout for the underlying ADO.NET query
+		/// Set a timeout for the underlying ADO.NET query.
 		/// </summary>
+		/// <param name="timeout">The timeout in seconds.</param>
+		/// <param name="multiCriteria">The <see cref="IMultiCriteria" /> on which to set the timeout.</param>
+		/// <returns><paramref name="multiCriteria" /> (for method chaining).</returns>
 		public static IMultiCriteria SetTimeout(this IMultiCriteria multiCriteria, int timeout)
 		{
 			if (multiCriteria == null)

src/NHibernate/IMultiQuery.cs

@@ -144,9 +144,9 @@ public partial interface IMultiQuery
 		IMultiQuery SetForceCacheRefresh(bool forceCacheRefresh);
 
 		/// <summary>
-		/// The timeout for the underlying ADO query
+		/// Set a timeout for the underlying ADO.NET query.
 		/// </summary>
-		/// <param name="timeout"></param>
+		/// <param name="timeout">The timeout in seconds.</param>
 		/// <returns>The instance for method chain.</returns>
 		IMultiQuery SetTimeout(int timeout);