fixup! Implement universal query batch

Document API meant to be public facing

Author: fredericDelaporte

src/NHibernate/ISession.cs

@@ -29,9 +29,14 @@ public static ISharedStatelessSessionBuilder StatelessSessionWithOptions(this IS
 			return impl.StatelessSessionWithOptions();
 		}
 
-		public static IQueryBatch CreateQueryBatch(this ISession implementor)
+		/// <summary>
+		/// Creates a <see cref="IQueryBatch"/> for the session.
+		/// </summary>
+		/// <param name="session">The session</param>
+		/// <returns>A query batch.</returns>
+		public static IQueryBatch CreateQueryBatch(this ISession session)
 		{
-			return ReflectHelper.CastOrThrow<AbstractSessionImpl>(implementor, "query batch").CreateQueryBatch();
+			return ReflectHelper.CastOrThrow<AbstractSessionImpl>(session, "query batch").CreateQueryBatch();
 		}
 	}
 

src/NHibernate/IStatelessSession.cs

@@ -13,9 +13,14 @@ namespace NHibernate
 	// 6.0 TODO: Convert to interface methods
 	public static class StatelessSessionExtensions
 	{
-		public static IQueryBatch CreateQueryBatch(this IStatelessSession implementor)
+		/// <summary>
+		/// Creates a <see cref="IQueryBatch"/> for the session.
+		/// </summary>
+		/// <param name="session">The session</param>
+		/// <returns>A query batch.</returns>
+		public static IQueryBatch CreateQueryBatch(this IStatelessSession session)
 		{
-			return ReflectHelper.CastOrThrow<AbstractSessionImpl>(implementor, "query batch").CreateQueryBatch();
+			return ReflectHelper.CastOrThrow<AbstractSessionImpl>(session, "query batch").CreateQueryBatch();
 		}
 	}
 

src/NHibernate/Multi/QueryBatchExtensions.cs

@@ -18,6 +18,7 @@ public static partial class QueryBatchExtensions
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -32,6 +33,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, IQueryOver query,
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -49,6 +51,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, IQuer
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -63,6 +66,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, IQueryOver<TResul
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -78,6 +82,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, IQuer
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -92,6 +97,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, ICriteria query,
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -107,6 +113,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, ICrit
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -121,6 +128,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, DetachedCriteria
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -136,6 +144,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, Detac
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -150,6 +159,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, IQuery query, Act
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -165,6 +175,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, IQuer
 		/// <param name="batch">The batch.</param>
 		/// <param name="query">The query.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -179,6 +190,7 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, IQueryable<TResul
 		/// <param name="batch">The batch.</param>
 		/// <param name="key">A key for retrieval of the query result.</param>
 		/// <param name="query">The query.</param>
+		/// <typeparam name="TResult">The type of the query result elements.</typeparam>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -195,6 +207,8 @@ public static IQueryBatch Add<TResult>(this IQueryBatch batch, string key, IQuer
 		/// <param name="query">The query.</param>
 		/// <param name="selector">An aggregation function to apply to <paramref name="query"/>.</param>
 		/// <param name="afterLoad">Callback to execute when query is loaded. Loaded results are provided as action parameter.</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>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>
@@ -210,6 +224,8 @@ public static IQueryBatch Add<TSource, TResult>(this IQueryBatch batch, IQueryab
 		/// <param name="key">A key for retrieval of the query result.</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>
 		/// <exception cref="InvalidOperationException">Thrown if the batch has already been executed.</exception>
 		/// <exception cref="ArgumentNullException">Thrown if <paramref name="query"/> is <see langword="null"/>.</exception>
 		/// <returns>The batch instance for method chain.</returns>