[Nhibernate-commit] SF.net SVN: nhibernate:[4362] trunk/nhibernate/src/NHibernate/Impl/ SessionImpl.cs

[<aye...@us...>]

Revision: 4362
          http://nhibernate.svn.sourceforge.net/nhibernate/?rev=4362&view=rev
Author:   ayenderahien
Date:     2009-05-22 22:31:51 +0000 (Fri, 22 May 2009)

Log Message:
-----------
NH-1744 - Fixing the documentations so Dispose vs. Close roles are clearer.

Modified Paths:
--------------
    trunk/nhibernate/src/NHibernate/Impl/SessionImpl.cs

Modified: trunk/nhibernate/src/NHibernate/Impl/SessionImpl.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Impl/SessionImpl.cs	2009-05-22 22:17:15 UTC (rev 4361)
+++ trunk/nhibernate/src/NHibernate/Impl/SessionImpl.cs	2009-05-22 22:31:51 UTC (rev 4362)
@@ -323,7 +323,13 @@
 			get { return IsAutoCloseSessionEnabled && !IsClosed; }
 		}
 
-		/// <summary></summary>
+		/// <summary>
+		/// Close the session and release all resources
+		/// <remarks>
+		/// Do not call this method inside a transaction scope, use <c>Dispose</c> instead, since
+		/// Close() is not aware of distributed transactions
+		/// </remarks>
+		/// </summary>
 		public IDbConnection Close()
 		{
 			using (new SessionIdLoggingContext(SessionId))
@@ -1653,7 +1659,7 @@
 		}
 
 		/// <summary>
-		/// Just in case the user forgot to Commit() or Close()
+		/// Perform a soft (distributed transaction aware) close of the session
 		/// </summary>
 		public void Dispose()
 		{


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.