[Nhibernate-commit] nhibernate/src/NHibernate IQuery.cs,1.10,1.11 ISession.cs,1.11,1.12

[Michael D. <mik...@us...>]

Update of /cvsroot/nhibernate/nhibernate/src/NHibernate
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24621/NHibernate

Modified Files:
	IQuery.cs ISession.cs 
Log Message:
Added more comments around Enumerable implementation.

Index: IQuery.cs
===================================================================
RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/IQuery.cs,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** IQuery.cs	4 Nov 2004 04:46:13 -0000	1.10
--- IQuery.cs	29 Nov 2004 18:43:16 -0000	1.11
***************
*** 61,77 ****
  
  		/// <summary>
! 		/// Return the query results as an <c>ICollection</c>. If the query contains multiple results
  		/// per row, the results are returned in an instance of <c>object[]</c>.
  		/// </summary>
  		/// <remarks>
  		/// Entities returned as results are initialized on demand. The first SQL query returns
! 		/// identifiers only.
  		/// </remarks>
  		IEnumerable Enumerable();
  
  		/// <summary>
! 		/// Return the query results as a <c>IList</c>. If the query contains multiple results per row,
  		/// the results are returned in an instance of <c>object[]</c>.
  		/// </summary>
  		IList List();
  
--- 61,87 ----
  
  		/// <summary>
! 		/// Return the query results as an <see cref="IEnumerable"/>. If the query contains multiple results
  		/// per row, the results are returned in an instance of <c>object[]</c>.
  		/// </summary>
  		/// <remarks>
+ 		/// <p>
  		/// Entities returned as results are initialized on demand. The first SQL query returns
! 		/// identifiers only.  
! 		/// </p>
! 		/// <p>
! 		/// This is a good strategy to use if you expect a high number of the objects
! 		/// returned to be already loaded in the <see cref="ISession"/> or in the 2nd level cache.
! 		/// </p>
  		/// </remarks>
  		IEnumerable Enumerable();
  
  		/// <summary>
! 		/// Return the query results as an <see cref="IList"/>. If the query contains multiple results per row,
  		/// the results are returned in an instance of <c>object[]</c>.
  		/// </summary>
+ 		/// <remarks>
+ 		/// This is a good strategy to use if you expect few of the objects being returned are already loaded
+ 		/// or if you want to fill the 2nd level cache.
+ 		/// </remarks>
  		IList List();
  

Index: ISession.cs
===================================================================
RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/ISession.cs,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** ISession.cs	14 Oct 2004 04:33:13 -0000	1.11
--- ISession.cs	29 Nov 2004 18:43:17 -0000	1.12
***************
*** 258,261 ****
--- 258,262 ----
  		/// <param name="query">A query expressed in Hibernate's query language</param>
  		/// <returns>A distinct list of instances</returns>
+ 		/// <remarks>See <see cref="IQuery.List"/> for implications of <c>cache</c> usage.</remarks>
  		IList Find(string query);
  
***************
*** 267,270 ****
--- 268,272 ----
  		/// <param name="type">The Hibernate type of the value</param>
  		/// <returns>A distinct list of instances</returns>
+ 		/// <remarks>See <see cref="IQuery.List"/> for implications of <c>cache</c> usage.</remarks>
  		IList Find(string query, object value, IType type);
  
***************
*** 276,279 ****
--- 278,282 ----
  		/// <param name="types">An array of Hibernate types of the values</param>
  		/// <returns>A distinct list of instances</returns>
+ 		/// <remarks>See <see cref="IQuery.List"/> for implications of <c>cache</c> usage.</remarks>
  		IList Find(string query, object[] values, IType[] types);