nhibernate-commit

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

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

Modified Files:
	PersistentClass.cs 
Log Message:
Added more xml comments.

Index: PersistentClass.cs
===================================================================
RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/Mapping/PersistentClass.cs,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** PersistentClass.cs	16 Aug 2004 05:27:07 -0000	1.13
--- PersistentClass.cs	13 Sep 2004 07:32:50 -0000	1.14
***************
*** 8,13 ****
  namespace NHibernate.Mapping 
  {
! 	//TODO: H2.0.3 - there are some "set" declared on properties that I am not sure about - need 
! 	// to double check those.
  	public abstract class PersistentClass 
  	{
--- 8,15 ----
  namespace NHibernate.Mapping 
  {
! 	/// <summary>
! 	/// Base class for the <see cref="RootClass" /> mapped by &lt;class&gt; and a 
! 	/// <see cref="Subclass"/> that is mapped by &lt;subclass&gt; or &lt;joined-subclass&gt;
! 	/// </summary>
  	public abstract class PersistentClass 
  	{
***************
*** 25,28 ****
--- 27,37 ----
  		private bool dynamicUpdate;
  		
+ 		/// <summary>
+ 		/// Gets or Sets if the Insert Sql is built dynamically.
+ 		/// </summary>
+ 		/// <value><c>true</c> if the Sql is built at runtime.</value>
+ 		/// <remarks>
+ 		/// The value of this is set by the <c>dynamic-insert</c> attribute. 
+ 		/// </remarks>
  		public virtual bool DynamicInsert 
  		{
***************
*** 31,34 ****
--- 40,50 ----
  		}
  
+ 		/// <summary>
+ 		/// Gets or Sets if the Update Sql is built dynamically.
+ 		/// </summary>
+ 		/// <value><c>true</c> if the Sql is built at runtime.</value>
+ 		/// <remarks>
+ 		/// The value of this is set by the <c>dynamic-update</c> attribute. 
+ 		/// </remarks>
  		public virtual bool DynamicUpdate 
  		{
***************
*** 37,40 ****
--- 53,67 ----
  		}
  
+ 		/// <summary>
+ 		/// Gets or Sets the value to use as the discriminator for the Class.
+ 		/// </summary>
+ 		/// <value>
+ 		/// A value that distinguishes this subclass in the database.
+ 		/// </value>
+ 		/// <remarks>
+ 		/// The value of this is set by the <c>discriminator-value</c> attribute.  Each &lt;subclass&gt;
+ 		/// in a heirarchy must define a unique <c>discriminator-value</c>.  The default value 
+ 		/// is the class name if no value is supplied.
+ 		/// </remarks>
  		public virtual string DiscriminatorValue 
  		{
***************
*** 67,74 ****
  
  		/// <summary>
! 		/// Gets the Collection of Subclasses for this PersistentClass.  It will
! 		/// recursively go through Subclasses so that if a Subclass has Subclasses
! 		/// it will pick those up also.
  		/// </summary>
  		public virtual ICollection SubclassCollection 
  		{
--- 94,103 ----
  
  		/// <summary>
! 		/// Gets the Collection of Subclasses for this PersistentClass.  
  		/// </summary>
+ 		/// <remarks>
+ 		/// It will recursively go through Subclasses so that if a Subclass has Subclasses
+ 		/// it will pick those up also.
+ 		/// </remarks>
  		public virtual ICollection SubclassCollection 
  		{
***************
*** 102,105 ****
--- 131,141 ----
  		}
  
+ 		/// <summary>
+ 		/// Gets or Sets the <see cref="Table"/> that this class is stored in.
+ 		/// </summary>
+ 		/// <value>The <see cref="Table"/> this class is stored in.</value>
+ 		/// <remarks>
+ 		/// The value of this is set by the <c>table</c> attribute. 
+ 		/// </remarks>
  		public virtual Table Table 
  		{