fixup! Integrate universal query batch in Future

Document API meant to be public facing
It seems some renaming of these methods have been squashed in
"Integrate universal query batch in Future" while they should have been
squashed in the previous commit. So now documenting these method can
only be done in the commit having renamed them.

Author: fredericDelaporte

src/NHibernate/Multi/QueryBatchExtensions.cs

@@ -259,77 +259,184 @@ public static IQueryBatch SetFlushMode(this IQueryBatch batch, FlushMode mode)
 			return batch;
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, IQueryOver query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, IQueryOver<TResult> query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, ICriteria query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, DetachedCriteria query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, IQuery query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, IQueryable<TResult> query)
 		{
 			return AddAsFuture(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureEnumerable{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureEnumerable<TResult> AddAsFuture<TResult>(this IQueryBatch batch, IQueryBatchItem<TResult> query)
 		{
 			batch.Add(query);
 			return new FutureEnumerable<TResult>(batch, query);
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <param name="selector">An aggregation function to apply to <paramref name="query"/>.</param>
+		/// <typeparam name="TSource">The type of the query elements before aggregation.</typeparam>
+		/// <typeparam name="TResult">The type resulting of the query result aggregation.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TSource, TResult>(this IQueryBatch batch, IQueryable<TSource> query, Expression<Func<IQueryable<TSource>, TResult>> selector)
 		{
 			return AddAsFutureValue(batch, For(query, selector));
 		}
 
-		public static IFutureValue<TSource> AddAsFutureValue<TSource>(this IQueryBatch batch, IQueryable<TSource> query)
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
+		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, IQueryable<TResult> query)
 		{
 			return AddAsFutureValue(batch, For(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, ICriteria query)
 		{
 			return AddAsFutureValue(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, DetachedCriteria query)
 		{
 			return AddAsFutureValue(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, IQueryOver query)
 		{
 			return AddAsFutureValue(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, IQueryOver<TResult> query)
 		{
 			return AddAsFutureValue(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, IQuery query)
 		{
 			return AddAsFutureValue(batch, For<TResult>(query));
 		}
 
+		/// <summary>
+		/// Adds a query to the batch, returning it as an <see cref="IFutureValue{T}"/>.
+		/// </summary>
+		/// <param name="batch">The batch.</param>
+		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
+		/// <returns>A future query which execution will be handled by the batch.</returns>
 		public static IFutureValue<TResult> AddAsFutureValue<TResult>(this IQueryBatch batch, IQueryBatchItem<TResult> query)
 		{
 			batch.Add(query);